Messages
UI completions are returned by the API when stream=false
is set in the request.
Request Headers
The API key to use for the request.
The content type of the request. Should be application/json
.
Request Body
An array of messages of the conversation so far.
The model to use for the UI completion. Should be one of the models listed in the Models page.
The temperature to use for the UI completion. Should be between 0 and 1.
The top-p value to use for the UI completion. Should be between 0 and 1.
The maximum number of tokens to use for the UI completion.
The number of completions to generate.
Should be unset or set to 1.
Whether to stream the response. Should be unset or false
.
All other request parameters are ignored.
Response
A unique identifier for the UI completion
An array of completions. Will always contain exactly one object.
The timestamp when the UI completion was created
The model used to generate the UI completion
The object type, which is always chat.completion
An object containing the usage statistics for the UI completion