Responses

Retrieve a response

Retrieve a response by its ID. Use this to poll the status of background tasks.

get/v1/responses/{response_id}

Path parameters

response_idstring required

ID of the response to retrieve (e.g., resp_...).

Response

The response object

created_atinteger required
idstring required
modelstring required
object'response' required

Object type in API responses

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

Status of a response or output item

backgroundboolean

Whether the response was created in background mode.

Changes