v171

latestOpenAPI 3.1.0raw.githubusercontent.com2026-08-0726249111.7 MB
Responses

Retrieve response

Retrieves a previously created response by its ID.

get/v3/router/responses/{response_id}

Path parameters

response_idstring required

The ID of the response to retrieve

The ID of the response to retrieve

Response

Response retrieved successfully.

backgroundboolean required
completed_atinteger nullable required
created_atinteger required
frequency_penaltynumber double required
idstring required
instructionsstring nullable required
max_output_tokensinteger nullable required
max_tool_callsinteger nullable required
metadataobject required

Developer-defined key-value pairs attached to the response (OpenAI spec: Map<string, string>).

modelstring required
objectstring required

Always "response"

parallel_tool_callsboolean required
presence_penaltynumber double required
previous_response_idstring nullable required
prompt_cache_keystring nullable required
prompt_cache_retentionstring nullable required
safety_identifierstring nullable required
service_tier'auto' | 'default' | 'flex' | 'fast' | 'scale' | 'priority' required
status'queued' | 'in_progress' | 'completed' | 'failed' | 'incomplete' required
storeboolean required
temperaturenumber double required
{"stackTrail":"paths:/v3/router/responses/{response_id}:get:responses:200:content:application/json:schema:properties:text","oasType":"schema","type":"unknown","description":"Text output configuration including format and verbosity"}
{"stackTrail":"paths:/v3/router/responses/{response_id}:get:responses:200:content:application/json:schema:properties:tool_choice","oasType":"schema","type":"unknown","description":"Tool choice setting: \"auto\", \"none\", \"required\", or a specific function"}
top_kinteger

Only sample from the top K options for each subsequent token. Present only when set on the request.

top_logprobsinteger required
top_pnumber double required
truncation'disabled' | 'auto' required
userstring nullable required
variablesobject