Chat Completions

curl --request POST \
  --url https://api.pulze.ai/v1/chat/completions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "messages": [
    {
      "content": "<string>",
      "tool_calls": [
        {
          "function": {
            "arguments": "<string>",
            "name": "<string>"
          },
          "id": "<string>",
          "type": "function"
        }
      ]
    }
  ],
  "model": "pulze",
  "max_tokens": 123,
  "temperature": 1,
  "top_p": 1,
  "tools": [
    {
      "function": {
        "name": "<string>",
        "parameters": {
          "properties": {},
          "required": [
            "<string>"
          ],
          "type": "object"
        },
        "description": "<string>"
      },
      "type": "function"
    }
  ],
  "tool_choice": "none",
  "n": 2,
  "stream": false,
  "logprobs": 2,
  "stop": "",
  "presence_penalty": 0,
  "frequency_penalty": 0,
  "best_of": 2,
  "logit_bias": {},
  "response_format": {},
  "plugins": [
    "<string>"
  ]
}
'

import requests

url = "https://api.pulze.ai/v1/chat/completions"

payload = {
    "messages": [
        {
            "content": "<string>",
            "tool_calls": [
                {
                    "function": {
                        "arguments": "<string>",
                        "name": "<string>"
                    },
                    "id": "<string>",
                    "type": "function"
                }
            ]
        }
    ],
    "model": "pulze",
    "max_tokens": 123,
    "temperature": 1,
    "top_p": 1,
    "tools": [
        {
            "function": {
                "name": "<string>",
                "parameters": {
                    "properties": {},
                    "required": ["<string>"],
                    "type": "object"
                },
                "description": "<string>"
            },
            "type": "function"
        }
    ],
    "tool_choice": "none",
    "n": 2,
    "stream": False,
    "logprobs": 2,
    "stop": "",
    "presence_penalty": 0,
    "frequency_penalty": 0,
    "best_of": 2,
    "logit_bias": {},
    "response_format": {},
    "plugins": ["<string>"]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    messages: [
      {
        content: '<string>',
        tool_calls: [
          {
            function: {arguments: '<string>', name: '<string>'},
            id: '<string>',
            type: 'function'
          }
        ]
      }
    ],
    model: 'pulze',
    max_tokens: 123,
    temperature: 1,
    top_p: 1,
    tools: [
      {
        function: {
          name: '<string>',
          parameters: {properties: {}, required: ['<string>'], type: 'object'},
          description: '<string>'
        },
        type: 'function'
      }
    ],
    tool_choice: 'none',
    n: 2,
    stream: false,
    logprobs: 2,
    stop: '',
    presence_penalty: 0,
    frequency_penalty: 0,
    best_of: 2,
    logit_bias: {},
    response_format: {},
    plugins: ['<string>']
  })
};

fetch('https://api.pulze.ai/v1/chat/completions', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.pulze.ai/v1/chat/completions",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'messages' => [
        [
                'content' => '<string>',
                'tool_calls' => [
                                [
                                                                'function' => [
                                                                                                                                'arguments' => '<string>',
                                                                                                                                'name' => '<string>'
                                                                ],
                                                                'id' => '<string>',
                                                                'type' => 'function'
                                ]
                ]
        ]
    ],
    'model' => 'pulze',
    'max_tokens' => 123,
    'temperature' => 1,
    'top_p' => 1,
    'tools' => [
        [
                'function' => [
                                'name' => '<string>',
                                'parameters' => [
                                                                'properties' => [
                                                                                                                                
                                                                ],
                                                                'required' => [
                                                                                                                                '<string>'
                                                                ],
                                                                'type' => 'object'
                                ],
                                'description' => '<string>'
                ],
                'type' => 'function'
        ]
    ],
    'tool_choice' => 'none',
    'n' => 2,
    'stream' => false,
    'logprobs' => 2,
    'stop' => '',
    'presence_penalty' => 0,
    'frequency_penalty' => 0,
    'best_of' => 2,
    'logit_bias' => [
        
    ],
    'response_format' => [
        
    ],
    'plugins' => [
        '<string>'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.pulze.ai/v1/chat/completions"

	payload := strings.NewReader("{\n  \"messages\": [\n    {\n      \"content\": \"<string>\",\n      \"tool_calls\": [\n        {\n          \"function\": {\n            \"arguments\": \"<string>\",\n            \"name\": \"<string>\"\n          },\n          \"id\": \"<string>\",\n          \"type\": \"function\"\n        }\n      ]\n    }\n  ],\n  \"model\": \"pulze\",\n  \"max_tokens\": 123,\n  \"temperature\": 1,\n  \"top_p\": 1,\n  \"tools\": [\n    {\n      \"function\": {\n        \"name\": \"<string>\",\n        \"parameters\": {\n          \"properties\": {},\n          \"required\": [\n            \"<string>\"\n          ],\n          \"type\": \"object\"\n        },\n        \"description\": \"<string>\"\n      },\n      \"type\": \"function\"\n    }\n  ],\n  \"tool_choice\": \"none\",\n  \"n\": 2,\n  \"stream\": false,\n  \"logprobs\": 2,\n  \"stop\": \"\",\n  \"presence_penalty\": 0,\n  \"frequency_penalty\": 0,\n  \"best_of\": 2,\n  \"logit_bias\": {},\n  \"response_format\": {},\n  \"plugins\": [\n    \"<string>\"\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.pulze.ai/v1/chat/completions")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"messages\": [\n    {\n      \"content\": \"<string>\",\n      \"tool_calls\": [\n        {\n          \"function\": {\n            \"arguments\": \"<string>\",\n            \"name\": \"<string>\"\n          },\n          \"id\": \"<string>\",\n          \"type\": \"function\"\n        }\n      ]\n    }\n  ],\n  \"model\": \"pulze\",\n  \"max_tokens\": 123,\n  \"temperature\": 1,\n  \"top_p\": 1,\n  \"tools\": [\n    {\n      \"function\": {\n        \"name\": \"<string>\",\n        \"parameters\": {\n          \"properties\": {},\n          \"required\": [\n            \"<string>\"\n          ],\n          \"type\": \"object\"\n        },\n        \"description\": \"<string>\"\n      },\n      \"type\": \"function\"\n    }\n  ],\n  \"tool_choice\": \"none\",\n  \"n\": 2,\n  \"stream\": false,\n  \"logprobs\": 2,\n  \"stop\": \"\",\n  \"presence_penalty\": 0,\n  \"frequency_penalty\": 0,\n  \"best_of\": 2,\n  \"logit_bias\": {},\n  \"response_format\": {},\n  \"plugins\": [\n    \"<string>\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.pulze.ai/v1/chat/completions")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"messages\": [\n    {\n      \"content\": \"<string>\",\n      \"tool_calls\": [\n        {\n          \"function\": {\n            \"arguments\": \"<string>\",\n            \"name\": \"<string>\"\n          },\n          \"id\": \"<string>\",\n          \"type\": \"function\"\n        }\n      ]\n    }\n  ],\n  \"model\": \"pulze\",\n  \"max_tokens\": 123,\n  \"temperature\": 1,\n  \"top_p\": 1,\n  \"tools\": [\n    {\n      \"function\": {\n        \"name\": \"<string>\",\n        \"parameters\": {\n          \"properties\": {},\n          \"required\": [\n            \"<string>\"\n          ],\n          \"type\": \"object\"\n        },\n        \"description\": \"<string>\"\n      },\n      \"type\": \"function\"\n    }\n  ],\n  \"tool_choice\": \"none\",\n  \"n\": 2,\n  \"stream\": false,\n  \"logprobs\": 2,\n  \"stop\": \"\",\n  \"presence_penalty\": 0,\n  \"frequency_penalty\": 0,\n  \"best_of\": 2,\n  \"logit_bias\": {},\n  \"response_format\": {},\n  \"plugins\": [\n    \"<string>\"\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "choices": [
    {
      "index": 123,
      "message": {
        "role": "user",
        "content": "<string>",
        "tool_calls": [
          {
            "function": {
              "arguments": "<string>",
              "name": "<string>"
            },
            "id": "<string>",
            "type": "function"
          }
        ]
      },
      "finish_reason": "stop"
    }
  ],
  "model": "<string>",
  "object": "text_completion",
  "created": 0,
  "metadata": {
    "app_id": "<string>",
    "model": {
      "model": "<string>",
      "namespace": "<string>",
      "provider": "<string>",
      "owner": "<string>",
      "at": "<string>"
    },
    "costs": {
      "total_tokens": 0,
      "prompt_tokens": 0,
      "completion_tokens": 0
    },
    "cost_savings": {
      "total_tokens": 0,
      "prompt_tokens": 0,
      "completion_tokens": 0
    },
    "generated_artifacts": {
      "items": [
        {}
      ]
    },
    "search_results": {
      "items": [
        {}
      ]
    },
    "latency": 123,
    "labels": {},
    "error": "<string>",
    "scores": {
      "best_models": [],
      "candidates": [
        {}
      ]
    },
    "score": 0,
    "temperature": 123,
    "max_tokens": 0,
    "status_code": 123,
    "retries": 0,
    "extra": {},
    "warning": "<string>"
  },
  "id": "<string>",
  "usage": {
    "total_tokens": 0,
    "prompt_tokens": 0,
    "completion_tokens": 0
  }
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

POST

chat

completions

Chat Completions

curl --request POST \
  --url https://api.pulze.ai/v1/chat/completions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "messages": [
    {
      "content": "<string>",
      "tool_calls": [
        {
          "function": {
            "arguments": "<string>",
            "name": "<string>"
          },
          "id": "<string>",
          "type": "function"
        }
      ]
    }
  ],
  "model": "pulze",
  "max_tokens": 123,
  "temperature": 1,
  "top_p": 1,
  "tools": [
    {
      "function": {
        "name": "<string>",
        "parameters": {
          "properties": {},
          "required": [
            "<string>"
          ],
          "type": "object"
        },
        "description": "<string>"
      },
      "type": "function"
    }
  ],
  "tool_choice": "none",
  "n": 2,
  "stream": false,
  "logprobs": 2,
  "stop": "",
  "presence_penalty": 0,
  "frequency_penalty": 0,
  "best_of": 2,
  "logit_bias": {},
  "response_format": {},
  "plugins": [
    "<string>"
  ]
}
'

import requests

url = "https://api.pulze.ai/v1/chat/completions"

payload = {
    "messages": [
        {
            "content": "<string>",
            "tool_calls": [
                {
                    "function": {
                        "arguments": "<string>",
                        "name": "<string>"
                    },
                    "id": "<string>",
                    "type": "function"
                }
            ]
        }
    ],
    "model": "pulze",
    "max_tokens": 123,
    "temperature": 1,
    "top_p": 1,
    "tools": [
        {
            "function": {
                "name": "<string>",
                "parameters": {
                    "properties": {},
                    "required": ["<string>"],
                    "type": "object"
                },
                "description": "<string>"
            },
            "type": "function"
        }
    ],
    "tool_choice": "none",
    "n": 2,
    "stream": False,
    "logprobs": 2,
    "stop": "",
    "presence_penalty": 0,
    "frequency_penalty": 0,
    "best_of": 2,
    "logit_bias": {},
    "response_format": {},
    "plugins": ["<string>"]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    messages: [
      {
        content: '<string>',
        tool_calls: [
          {
            function: {arguments: '<string>', name: '<string>'},
            id: '<string>',
            type: 'function'
          }
        ]
      }
    ],
    model: 'pulze',
    max_tokens: 123,
    temperature: 1,
    top_p: 1,
    tools: [
      {
        function: {
          name: '<string>',
          parameters: {properties: {}, required: ['<string>'], type: 'object'},
          description: '<string>'
        },
        type: 'function'
      }
    ],
    tool_choice: 'none',
    n: 2,
    stream: false,
    logprobs: 2,
    stop: '',
    presence_penalty: 0,
    frequency_penalty: 0,
    best_of: 2,
    logit_bias: {},
    response_format: {},
    plugins: ['<string>']
  })
};

fetch('https://api.pulze.ai/v1/chat/completions', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.pulze.ai/v1/chat/completions",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'messages' => [
        [
                'content' => '<string>',
                'tool_calls' => [
                                [
                                                                'function' => [
                                                                                                                                'arguments' => '<string>',
                                                                                                                                'name' => '<string>'
                                                                ],
                                                                'id' => '<string>',
                                                                'type' => 'function'
                                ]
                ]
        ]
    ],
    'model' => 'pulze',
    'max_tokens' => 123,
    'temperature' => 1,
    'top_p' => 1,
    'tools' => [
        [
                'function' => [
                                'name' => '<string>',
                                'parameters' => [
                                                                'properties' => [
                                                                                                                                
                                                                ],
                                                                'required' => [
                                                                                                                                '<string>'
                                                                ],
                                                                'type' => 'object'
                                ],
                                'description' => '<string>'
                ],
                'type' => 'function'
        ]
    ],
    'tool_choice' => 'none',
    'n' => 2,
    'stream' => false,
    'logprobs' => 2,
    'stop' => '',
    'presence_penalty' => 0,
    'frequency_penalty' => 0,
    'best_of' => 2,
    'logit_bias' => [
        
    ],
    'response_format' => [
        
    ],
    'plugins' => [
        '<string>'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.pulze.ai/v1/chat/completions"

	payload := strings.NewReader("{\n  \"messages\": [\n    {\n      \"content\": \"<string>\",\n      \"tool_calls\": [\n        {\n          \"function\": {\n            \"arguments\": \"<string>\",\n            \"name\": \"<string>\"\n          },\n          \"id\": \"<string>\",\n          \"type\": \"function\"\n        }\n      ]\n    }\n  ],\n  \"model\": \"pulze\",\n  \"max_tokens\": 123,\n  \"temperature\": 1,\n  \"top_p\": 1,\n  \"tools\": [\n    {\n      \"function\": {\n        \"name\": \"<string>\",\n        \"parameters\": {\n          \"properties\": {},\n          \"required\": [\n            \"<string>\"\n          ],\n          \"type\": \"object\"\n        },\n        \"description\": \"<string>\"\n      },\n      \"type\": \"function\"\n    }\n  ],\n  \"tool_choice\": \"none\",\n  \"n\": 2,\n  \"stream\": false,\n  \"logprobs\": 2,\n  \"stop\": \"\",\n  \"presence_penalty\": 0,\n  \"frequency_penalty\": 0,\n  \"best_of\": 2,\n  \"logit_bias\": {},\n  \"response_format\": {},\n  \"plugins\": [\n    \"<string>\"\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.pulze.ai/v1/chat/completions")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"messages\": [\n    {\n      \"content\": \"<string>\",\n      \"tool_calls\": [\n        {\n          \"function\": {\n            \"arguments\": \"<string>\",\n            \"name\": \"<string>\"\n          },\n          \"id\": \"<string>\",\n          \"type\": \"function\"\n        }\n      ]\n    }\n  ],\n  \"model\": \"pulze\",\n  \"max_tokens\": 123,\n  \"temperature\": 1,\n  \"top_p\": 1,\n  \"tools\": [\n    {\n      \"function\": {\n        \"name\": \"<string>\",\n        \"parameters\": {\n          \"properties\": {},\n          \"required\": [\n            \"<string>\"\n          ],\n          \"type\": \"object\"\n        },\n        \"description\": \"<string>\"\n      },\n      \"type\": \"function\"\n    }\n  ],\n  \"tool_choice\": \"none\",\n  \"n\": 2,\n  \"stream\": false,\n  \"logprobs\": 2,\n  \"stop\": \"\",\n  \"presence_penalty\": 0,\n  \"frequency_penalty\": 0,\n  \"best_of\": 2,\n  \"logit_bias\": {},\n  \"response_format\": {},\n  \"plugins\": [\n    \"<string>\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.pulze.ai/v1/chat/completions")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"messages\": [\n    {\n      \"content\": \"<string>\",\n      \"tool_calls\": [\n        {\n          \"function\": {\n            \"arguments\": \"<string>\",\n            \"name\": \"<string>\"\n          },\n          \"id\": \"<string>\",\n          \"type\": \"function\"\n        }\n      ]\n    }\n  ],\n  \"model\": \"pulze\",\n  \"max_tokens\": 123,\n  \"temperature\": 1,\n  \"top_p\": 1,\n  \"tools\": [\n    {\n      \"function\": {\n        \"name\": \"<string>\",\n        \"parameters\": {\n          \"properties\": {},\n          \"required\": [\n            \"<string>\"\n          ],\n          \"type\": \"object\"\n        },\n        \"description\": \"<string>\"\n      },\n      \"type\": \"function\"\n    }\n  ],\n  \"tool_choice\": \"none\",\n  \"n\": 2,\n  \"stream\": false,\n  \"logprobs\": 2,\n  \"stop\": \"\",\n  \"presence_penalty\": 0,\n  \"frequency_penalty\": 0,\n  \"best_of\": 2,\n  \"logit_bias\": {},\n  \"response_format\": {},\n  \"plugins\": [\n    \"<string>\"\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "choices": [
    {
      "index": 123,
      "message": {
        "role": "user",
        "content": "<string>",
        "tool_calls": [
          {
            "function": {
              "arguments": "<string>",
              "name": "<string>"
            },
            "id": "<string>",
            "type": "function"
          }
        ]
      },
      "finish_reason": "stop"
    }
  ],
  "model": "<string>",
  "object": "text_completion",
  "created": 0,
  "metadata": {
    "app_id": "<string>",
    "model": {
      "model": "<string>",
      "namespace": "<string>",
      "provider": "<string>",
      "owner": "<string>",
      "at": "<string>"
    },
    "costs": {
      "total_tokens": 0,
      "prompt_tokens": 0,
      "completion_tokens": 0
    },
    "cost_savings": {
      "total_tokens": 0,
      "prompt_tokens": 0,
      "completion_tokens": 0
    },
    "generated_artifacts": {
      "items": [
        {}
      ]
    },
    "search_results": {
      "items": [
        {}
      ]
    },
    "latency": 123,
    "labels": {},
    "error": "<string>",
    "scores": {
      "best_models": [],
      "candidates": [
        {}
      ]
    },
    "score": 0,
    "temperature": 123,
    "max_tokens": 0,
    "status_code": 123,
    "retries": 0,
    "extra": {},
    "warning": "<string>"
  },
  "id": "<string>",
  "usage": {
    "total_tokens": 0,
    "prompt_tokens": 0,
    "completion_tokens": 0
  }
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

messages

RoleContentChatChoice · object[]

required

The conversation sent (with or without history) (for a /chat/completions request)

Minimum array length: 1

Show child attributes

model

string | null

default:pulze

https://docs.pulze.ai/overview/models Specify the model you'd like Pulze to use. (optional). Can be the full model name, or a subset for multi-matching.

Defaults to our dynamic routing, i.e. best model for this request.

max_tokens

integer | null

The maximum number of tokens that the response can contain.

temperature

number | null

default:1

Optionally specify the temperature for this request only. Leave empty to allow Pulze to guess it for you.

Required range: 0 <= x <= 1

top_p

number | null

default:1

https://octo.ai/docs/text-gen-solution/rest-api#input-parameters A value between 0.0 and 1.0 that controls the probability of the model generating a particular token.

tools

ToolFunction · object[] | null

Show child attributes

tool_choice

default:none

Available options:

none,

auto

integer | null

How many completions to generate for each prompt. @default 1

Required range: x >= 1

stream

boolean | null

default:false

Specify if you want the response to be streamed or to be returned as a standard HTTP request. Currently we only support streaming for OpenAI-compatible models.

logprobs

integer | null

COMING SOON https://platform.openai.com/docs/api-reference/completions/create#completions/create-logprobs Include the log probabilities on the logprobs most likely tokens, as well the chosen tokens.

Required range: 0 <= x <= 5

stop

default:""

Stop responding when this sequence of characters is generated. Leave empty to allow the model to decide.

presence_penalty

number | null

https://platform.openai.com/docs/api-reference/completions/create#completions/create-presence_penalty Increase the model's likelihood to talk about new topics

Required range: -2 <= x <= 2

frequency_penalty

number | null

https://platform.openai.com/docs/api-reference/completions/create#completions/create-frequency_penalty Increase the model's likelihood to not repeat tokens/words

Required range: -2 <= x <= 2

best_of

integer | null

The number of responses to generate. Out of those, it will return the best n.

Required range: x >= 1

logit_bias

Logit Bias · object | null

COMING SOON https://platform.openai.com/docs/api-reference/completions/create#completions/create-logit_bias Modify the likelihood of specified tokens appearing in the completion.

See here for a detailed explanation on how to use: https://help.openai.com/en/articles/5247780-using-logit-bias-to-define-token-probability

response_format

RequestResponseFormat · object | null

https://platform.openai.com/docs/api-reference/chat/create#chat-create-response_format An object specifying the format that the model must output. Must be one of "text" or "json_object". Important: when using JSON mode, you must also instruct the model to produce JSON yourself via a system or user message. To help ensure you don't forget, the API will throw an error if the string "JSON" does not appear somewhere in the context.

Show child attributes

plugins

string[]

The list of plugins to enable for the request

Response

Successful Response

The response returned to the user by the Chat Completions endpoint

choices

ResponseCompletionChatChoice · object[]

required

Show child attributes

model

string

required

The fully qualified model name used by PulzeEngine

object

enum<string>

required

The type of response object

Available options:

text_completion,

chat.completion

created

integer

default:0

Creation timestamp -- in milliseconds (!)

metadata

PulzeEngineResponseMetadata · object

Metadata of the response

Show child attributes

string

This ID gets generated by the database when we save the request

usage

PulzeEngineTokens · object

Tokens used

Show child attributes

Getting Started

Models

AI Agents

Pulze Guide

Tools Guide

Vibe Coding

Developer Guide

API REFERENCE

COMMUNITY

PULZE ACADEMY

Chat Completions

Authorizations

Body

Response