Cancel a response

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

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

response_idstringRequired

Response

The cancelled response object.
idstring
objectstring
statusenum

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

modelstring
outputlist of objects
usageobject
Token usage for the response.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
429
Too Many Requests Error
500
Internal Server Error
502
Bad Gateway Error