Skip to main content
POST
Create Chat Completion

Authorizations

Authorization
string
header
required

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

Body

application/json
model
string
required

Model ID

Example:

"gpt-4"

messages
object[]
required

List of conversation messages

temperature
number
default:1

Sampling temperature

Required range: 0 <= x <= 2
top_p
number
default:1

Nucleus sampling parameter

Required range: 0 <= x <= 1
n
integer
default:1

Number of generations

Required range: x >= 1
stream
boolean
default:false

Whether to stream the response

stream_options
object
stop

Stop sequence

max_tokens
integer

Maximum number of generated tokens

max_completion_tokens
integer

Maximum number of completion tokens

presence_penalty
number
default:0
Required range: -2 <= x <= 2
frequency_penalty
number
default:0
Required range: -2 <= x <= 2
logit_bias
object
user
string
tools
object[]
tool_choice
Available options:
none,
auto,
required
response_format
object
seed
integer
reasoning_effort
enum<string>

Reasoning effort (for models that support reasoning)

Available options:
low,
medium,
high
modalities
enum<string>[]
Available options:
text,
audio
audio
object

Response

Response created successfully

id
string
object
string
Example:

"chat.completion"

created
integer
model
string
choices
object[]
usage
object
system_fingerprint
string
error
object

Error profile (non-streaming only)