Omni AI

Cancel Response

Changed on Oct 16, 2026

Cancel a queued or running response. Canceling a running response (Stop) also cancels every queued response in the thread that answers a user message. Canceling a queued response (withdraw) cancels only that response; the running response and other queued responses continue. Cancellation is idempotent after the response becomes terminal. Each canceled response still produces a finalized assistant message with outcome canceled in the thread history. Canceling a response that ended steered or merged stops the response that continues its work, with the same effect as Stop.

Authorization uses the linked account before any cancellation.

delete/v1/omni-ai/responses/{response_id}

Request

Base URL
https://api.clearstreet.com
Auth
HTTP bearer

Path parameters

response_idstring uuid required

Query parameters

account_idinteger

Lists only conversations for this account, or unlinked conversations when omitted. Other reads authorize the resource's linked account. Omit when no account is selected; empty values and the string null are invalid.

Response

Cancellation accepted (idempotent)

Example response

{
  "error": {
    "code": 400,
    "message": "Order quantity must be greater than zero"
  },
  "metadata": {
    "page_number": 1,
    "total_items": 42,
    "total_pages": 5
  }
}

Changes

Oct 16, 20261bd9eddeffc8 Revision changes
- breaking
  removed the required property from the response with the status
- breaking
  removed the required property from the response with the status
- breaking
  removed the required property from the response with the status
- breaking
  removed the required property from the response with the status
- breaking
  removed the required property from the response with the status
- breaking
  removed the required property from the response with the status
- breaking
  removed the required property from the response with the status
- breaking
  removed the required property from the response with the status
- warning
  for the query request parameter account_id, the min was set to 1.00
- warning
  removed the optional property from the response with the status
- warning
  removed the optional property from the response with the status
- warning
  removed the optional property from the response with the status
- warning
  removed the optional property from the response with the status
- info
  the query request parameter account_id became optional
- info
  added the non-success response with the status
- info
  added the non-success response with the status
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status

Operation history