API Reference

Chat Completions

Generate chat completions based on a conversation history.

Authentication

AuthorizationBearer

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

Request

This endpoint expects an object.
modelstringRequired
The chat model to use for generating completions.
messagesstring or list of objectsRequired
frequency_penaltydoubleOptional

A value between -2.0 and 2.0, with positive values increasingly penalizing new tokens based on their frequency so far in order to decrease further occurrences.

logit_biasobjectOptional
Modifies the likelihood of specified tokens appearing in a response.
max_completion_tokensintegerOptional
The maximum number of tokens in the generated completion.
parallel_tool_callsbooleanOptional
Whether to enable parallel function calling during tool use.
presence_penaltydoubleOptional

A value between -2.0 and 2.0, with positive values causing a flat reduction of new tokens based on their existing presence so far in order to decrease further occurrences.

reasoning_effortstringOptional

Constrains effort on reasoning for reasoning models. Currently supported values are low, medium, and high. Reducing reasoning effort can result in faster responses and fewer tokens used on reasoning in a response. Only supported by reasoning models.

stopstring or list of stringsOptional
streambooleanOptional
Whether to stream back the model response.
temperaturedoubleOptional
The temperature parameter for controlling randomness in completions.
tool_choicestring or map from strings to anyOptional
toolslist of objectsOptional
The content of the tool call.
top_pdoubleOptional
The diversity of the generated text based on nucleus sampling.
top_kintegerOptional

The diversity of the generated text based on top-k sampling.

outputobjectOptional
Options to affect the output of the response.
inputobjectOptional
Options to affect the input of the request.
max_tokensintegerOptional

Deprecated. Please use max_completion_tokens.

Response

Successful response.
idstring or null
Unique ID for the chat completion.
objectstring or null

Type of object (chat completion).

createdinteger or null
Timestamp of when the chat completion was created.
modelstring or null
The chat model used for generating completions.
choiceslist of objects or null
The set of result choices.

Errors