Skip to main content
Cancels an in-progress response. The server responds with response.done and a cancelled response status. If there is no response to cancel, the server responds with an error. response.cancel targets the current active response. Omit response_id for the active response, or supply its matching ID. Successful cancellation also clears pending work. No active response or a mismatched ID produces an error; it cannot remove only a pending response.

Event fields

string
Client-generated id for this event.
string
required
Event type. Must be response.cancel.
string
When provided, this must match the active response ID. Omit it to cancel the active response. Use the ID from response.created.response.id.