Create Responses

Generate a unified response block from various input configurations.

x-api-keystring

Request body

modelstring nullable

previous_response_idstring nullable

includeIncludeEnum[] nullable

temperaturenumber nullable

top_pnumber nullable

presence_penaltynumber nullable

frequency_penaltynumber nullable

parallel_tool_callsboolean nullable

streamboolean nullable

Whether to stream response events as server-sent events.

backgroundboolean nullable

Whether to run the request in the background and return immediately.

max_output_tokensinteger nullable

max_tool_callsinteger nullable

prompt_cache_keystring nullable

truncation'auto' | 'disabled'

instructionsstring nullable

storeboolean nullable

Whether to store the response so it can be retrieved later.

service_tier'auto' | 'default' | 'flex' | 'priority'

top_logprobsinteger nullable

Response

Successful Response

idstring required

The unique ID of the response that was created.

object'response' required

created_atinteger required

The Unix timestamp (in seconds) for when the response was created.

completed_atinteger nullable required

statusstring required

The status that was set for the response.

modelstring required

The model that generated this response.

previous_response_idstring nullable required

instructionsstring nullable required

truncation'auto' | 'disabled' required

parallel_tool_callsboolean required

Whether the model was allowed to call multiple tools in parallel.

top_pnumber required

The nucleus sampling parameter that was used for this response.

presence_penaltynumber required

The presence penalty that was used to penalize new tokens based on whether they appear in the text so far.

frequency_penaltynumber required

The frequency penalty that was used to penalize new tokens based on their frequency in the text so far.

top_logprobsinteger required

The number of most likely tokens that were returned at each position, along with their log probabilities.

temperaturenumber required

The sampling temperature that was used for this response.

max_output_tokensinteger nullable required

max_tool_callsinteger nullable required

storeboolean required

Whether this response was stored so it can be retrieved later.

backgroundboolean required

Whether this request was run in the background.

service_tierstring required

The service tier that was used for this response.

prompt_cache_keystring nullable required

v1

Create Responses

Headers

Request body

Response