Responses

Request body

modelstring

Use this field according to the endpoint schema.

instructionsstring

Use this field according to the endpoint schema.

streamboolean

Use this field according to the endpoint schema.

backgroundboolean

Use this field according to the endpoint schema.

previous_response_idstring

Use this field according to the endpoint schema.

{"stackTrail":"paths:/v1/responses:post:requestBody:content:application/json:schema:properties:conversation","oasType":"schema","type":"unknown","description":"Use this field according to the endpoint schema."}

temperaturenumber

Use this field according to the endpoint schema.

max_output_tokensinteger

Use this field according to the endpoint schema.

top_pnumber

Use this field according to the endpoint schema.

{"stackTrail":"paths:/v1/responses:post:requestBody:content:application/json:schema:properties:tool_choice","oasType":"schema","type":"unknown","description":"Use this field according to the endpoint schema."}

parallel_tool_callsboolean

Use this field according to the endpoint schema.

includestring[]

Use this field according to the endpoint schema.

metadataobject

Use this field according to the endpoint schema.

truncation'auto' | 'disabled'

Use this field according to the endpoint schema.

storeboolean

Use this field according to the endpoint schema.

prompt_cache_keystring

Use this field according to the endpoint schema.

prompt_cache_retention'in-memory' | '24h'

Use this field according to the endpoint schema.

max_tool_callsinteger

Use this field according to the endpoint schema.

top_logprobsinteger

Use this field according to the endpoint schema.

safety_identifierstring

Use this field according to the endpoint schema.

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

Use this field according to the endpoint schema.

userstring

Use this field according to the endpoint schema.

Response

Use this field according to the endpoint schema.

idstring required

Use this field according to the endpoint schema.

objectstring required

Use this field according to the endpoint schema.

created_atinteger required

statusstring required

backgroundboolean required

{"stackTrail":"paths:/v1/responses:post:responses:200:content:application/json:schema:properties:content_filters","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/v1/responses:post:responses:200:content:application/json:schema:properties:error","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/v1/responses:post:responses:200:content:application/json:schema:properties:incomplete_details","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/v1/responses:post:responses:200:content:application/json:schema:properties:instructions","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/v1/responses:post:responses:200:content:application/json:schema:properties:max_output_tokens","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/v1/responses:post:responses:200:content:application/json:schema:properties:max_tool_calls","oasType":"schema","type":"unknown"}

modelstring required

Use this field according to the endpoint schema.

output_textstring nullable

Use this field according to the endpoint schema.

parallel_tool_callsboolean required

{"stackTrail":"paths:/v1/responses:post:responses:200:content:application/json:schema:properties:previous_response_id","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/v1/responses:post:responses:200:content:application/json:schema:properties:prompt_cache_key","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/v1/responses:post:responses:200:content:application/json:schema:properties:safety_identifier","oasType":"schema","type":"unknown"}

service_tierstring required

storeboolean required

temperatureinteger required

tool_choicestring required

toolsstring[] required

top_logprobsinteger required

top_pinteger required

truncationstring required

{"stackTrail":"paths:/v1/responses:post:responses:200:content:application/json:schema:properties:user","oasType":"schema","type":"unknown","description":"Use this field according to the endpoint schema."}

metadataobject required