Create a Chat Completion
POST/v1/chat/completions
POST
/v1/chat/completions
Authorizations
Section titled “Authorizations”Request Bodyrequired
Section titled “Request Bodyrequired”object
frequency_penalty
number | null format: float
logit_bias
object | null
logprobs
boolean | null
max_completion_tokens
integer | null format: int32
n
integer | null format: int32
presence_penalty
number | null format: float
response_format
One of:
null
One of:
object
type
required
string
object
type
required
string
object
json_schema
required
object
description
string | null
name
required
string
schema
required
This is a JSON schema object.
For more information, see: https://json-schema.org
object
strict
boolean | null
type
required
string
stop
array | null
temperature
number | null format: float
top_logprobs
integer | null format: int32
top_p
number | null format: float
messages
required
Array
One of:
object
content
string | null
name
string | null
refusal
string | null
role
required
string
object
content
required
string
name
string | null
role
required
string
object
content
required
string
name
string | null
role
required
string
object
content
required
string
name
string | null
role
required
string
object
content
required
string
name
string | null
role
required
string
tool_call_id
required
string
model
required
string
parallel_tool_calls
boolean | null
reasoning_effort
string | null
stream
boolean | null
tools
array | null
object
function
required
object
description
string | null
name
required
string
parameters
This is a JSON schema object.
For more information, see: https://json-schema.org
object
strict
boolean | null
type
required
string
user
string | null
Responses
Section titled “Responses”A successful response.
object
choices
required
Array<object>
object
finish_reason
required
string
index
required
integer format: int32
message
required
One of:
object
content
string | null
name
string | null
refusal
string | null
role
required
string
object
content
required
string
name
string | null
role
required
string
object
content
required
string
name
string | null
role
required
string
object
content
required
string
name
string | null
role
required
string
object
content
required
string
name
string | null
role
required
string
tool_call_id
required
string
created
required
integer format: int64
id
required
string
model
required
string
object
required
string
usage
required
object
completion_tokens
required
integer format: int32
decode_rate
number | null format: double
decode_tokens
integer | null format: int32
prefill_rate
number | null format: double
prefill_tokens
integer | null format: int32
prompt_tokens
required
integer format: int32
total_time
number | null format: float
total_tokens
required
integer format: int32
object
choices
required
Array<object>
object
delta
required
finish_reason
string | null
index
required
integer format: int32
created
required
integer format: int64
id
required
string
model
required
string
object
required
string
usage
One of:
null
object
completion_tokens
required
integer format: int32
decode_rate
number | null format: double
decode_tokens
integer | null format: int32
prefill_rate
number | null format: double
prefill_tokens
integer | null format: int32
prompt_tokens
required
integer format: int32
total_time
number | null format: float
total_tokens
required
integer format: int32