---
title: "Cancel Response"
method: DELETE
path: "/v1/omni-ai/responses/{response_id}"
tags: ["Omni AI"]
---

# Cancel Response

`DELETE /v1/omni-ai/responses/{response_id}`

## Request

- Base URL: `https://api.clearstreet.com`
- URL: `https://api.clearstreet.com/v1/omni-ai/responses/{response_id}`
- Auth: HTTP bearer

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.

## Path parameters

- `response_id` string, uuid, required

## Query parameters

- `account_id` integer

## Response `200`

Cancellation accepted (idempotent)

- object
  - `error` ApiError: A direct mapping of tonic::Status, for use in HTTP responses.
    - `code` integer, required: The error code is used to identify the nature of the error. It corresponds to an HTTP status code.
    - `details` object[]
    - `message` string, required: A human-readable message providing more details about the error.
  - `metadata` ResponseMetadata, required: Metadata for the response. This will always contain a request ID which can be used to identify the request to Clear Street for tracing, and optionally may include pagination data.
    - `next_page_token` string, byte, nullable: Base64URL-encoded pagination token
    - `page_number` integer, nullable: Pagination. Included if this was a GET (list) response
    - `previous_page_token` string, byte, nullable: Base64URL-encoded pagination token
    - `request_id` string, required: A unique ID for this request, generated upon ingestion of the request.
    - `total_items` integer, nullable: Total number of items available (not just in this page).
    - `total_pages` integer, nullable: Total number of pages available.
  - `data` CancelResponsePayload, required
    - `canceled` boolean, required

## Other responses

- `400`: Invalid request or supplied account ID
- `401`: Authentication required
- `403`: Caller lacks linked-account access
- `404`: Resource not found or not owned by caller
- `409`: Thread scope changed or conflicting retry; refresh before retrying
- `500`: Internal server error

## Changes

- **2026-10-16** `1bd9eddeffc8`: 8 breaking, 5 warning, 11 info
  - removed the required property `code` from the response with the `400` status
  - removed the required property `code` from the response with the `403` status
  - removed the required property `code` from the response with the `404` status
  - removed the required property `code` from the response with the `500` status
  - …20 more

[Operation history](https://skmtc.dev/clear-street/apis/clear-street-trading-api/changes/v1/omni-ai/responses/:response_id/delete.md)

---

[API](https://skmtc.dev/clear-street/apis/clear-street-trading-api.md) - [All operations](https://skmtc.dev/clear-street/apis/clear-street-trading-api/llms.txt) - [OpenAPI document](https://skmtc.dev/clear-street/apis/clear-street-trading-api/revisions/52e77ea7d731?raw)
