Sign in
responses

Cancel a response

Cancels an in-progress background response. Returns the response object.

post/responses/{response_id}/cancel

Path parameters

response_idstring required

Headers

Authorizationstring required

Bearer authentication

Response

The cancelled 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.