v1

latestOpenAPI 3.1.02026-07-2620042.3 KB

Responses

Generate a response

Create a response using the specified model and instructions.

post/v1/responses

Request body

modelstring nullable

previous_response_idstring nullable

includestring[]

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

metadataobject nullable

temperaturenumber nullable

top_pnumber nullable

presence_penaltynumber nullable

frequency_penaltynumber nullable

parallel_tool_callsboolean nullable

streamboolean

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

backgroundboolean

max_output_tokensinteger nullable

max_tool_callsinteger nullable

userstring nullable

safety_identifierstring nullable

prompt_cache_keystring nullable

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

truncation'auto' | 'disabled'

instructionsstring nullable

storeboolean

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

top_logprobsinteger nullable

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

Response

Successful response

idstring required

object'response' required

created_atnumber required

status'queued' | 'in_progress' | 'completed' | 'failed' required

modelstring required

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