Sign in
responses

Get Response

Get a response by its ID. This will return the response and its status. If the response is still in progress, the status will be in_progress. If the response is completed, the status will be completed. If the response is failed, the status will be failed.

get/responses/{response_id}

Path parameters

response_idstring uuid required

Response

Successful Response

idstring required
object'response'
created_atinteger required
status'completed' | 'failed' | 'in_progress' | 'cancelled' required
errorstring nullable
{"stackTrail":"components:schemas:Response:properties:incomplete_details","oasType":"schema","type":"unknown","title":"Incomplete Details"}
instructionsstring nullable
{"stackTrail":"components:schemas:Response:properties:max_output_tokens","oasType":"schema","type":"unknown","title":"Max Output Tokens"}
model'deep-search'
parallel_tool_callsboolean
storeboolean
temperaturenumber
previous_response_idstring nullable
tool_choice'auto'
top_pnumber
truncation'disabled'
{"stackTrail":"components:schemas:Response:properties:user","oasType":"schema","type":"unknown","title":"User"}
metadataobject

Changes