---
title: "Cancel a background response"
method: POST
path: "/responses/{response_id}/cancel"
tags: ["Responses"]
---

# Cancel a background response

`POST /responses/{response_id}/cancel`

## Request

- Base URL: `https://api.openscale.so/v1`
- URL: `https://api.openscale.so/v1/responses/{response_id}/cancel`
- Auth: HTTP bearer

Stop a queued or running background response; it ends with status `cancelled` and is not billed for unfinished work. Cancelling again, or cancelling a finished response, returns it unchanged.

## Response `200`

The response.

- Response
  - `id` string, required
  - `object` 'response', required
  - `created_at` integer, required
  - `status` 'completed' | 'incomplete' | 'failed' | 'in_progress' | 'queued' | 'cancelled', required
  - `model` 'deepseek/deepseek-v4.1-flash' | 'z-ai/glm-5.3-flash' | 'deepseek/deepseek-v4.1-flash-1017' | 'deepseek/deepseek-v4.1-flash-0910' | 'z-ai/glm-5.3-flash-0828' | 'deepseek/deepseek-v4.1-flash:fast' | 'deepseek/deepseek-v4.1-flash-1017:fast' | 'deepseek/deepseek-v4.1-flash-0910:fast', required
  - `output` object[], required
    - `type` 'message'
    - `id` string
    - `role` 'assistant'
    - `status` 'completed'
    - `content` object[]
      - `type` 'output_text'
      - `text` string
      - `annotations` unknown[]
        - unknown
    - `phase` 'commentary' | 'final_answer': `commentary`: text written before a tool call in the same response. `final_answer`: the reply. Assistant messages sent back in `input` may keep it.
  - `usage` object, required
    - `input_tokens` integer
    - `input_tokens_details` object
      - `cached_tokens` integer: Input tokens billed at the cached rate.
    - `output_tokens` integer
    - `output_tokens_details` object
      - `reasoning_tokens` integer: Reasoning tokens, billed as output tokens.
    - `total_tokens` integer
  - `service_tier` 'default' | 'priority': The tier that served the response: `priority` in fast mode.

## Other responses

- `400`: The response was not created in the background.
- `404`: No stored response with this id.

---

[API](https://skmtc.dev/openscale/apis/openscale-api.md) - [All operations](https://skmtc.dev/openscale/apis/openscale-api/llms.txt) - [OpenAPI document](https://skmtc.dev/openscale/apis/openscale-api/revisions/587e72b44932?raw)