Sign in
responses

Retrieve a response

Returns a previously created response by id. With stream=true the response is delivered as server-sent events instead of a single JSON body, replaying the run from the beginning and continuing live if it is still going. Streaming a retrieve requires a response created with background: true; on any other response it returns a 400.

get/responses/{response_id}

Path parameters

response_idstring required

Query parameters

streamboolean

If true, replay the response as server-sent events. Requires a response created with background: true.

Headers

Authorizationstring required

Bearer authentication

Response

The response object.

idstring
objectstring
status'queued' | 'in_progress' | 'completed' | 'failed' | 'cancelled' | 'incomplete'

Lifecycle status. queued and in_progress mean the run is still going; completed, failed, cancelled and incomplete are terminal.

modelstring
outputResponseObjectOutputItems[]

Changes

No recorded changes to this endpoint across all 1 revision of this API.