---
title: "Cancel response"
method: POST
path: "/v1/responses/{response_id}/cancel"
tags: ["relay"]
---

# Cancel response

`POST /v1/responses/{response_id}/cancel`

Cancel a response by ID

## Path parameters

- `response_id` string, required

## Headers

- `Aiproxy-Channel` string

## Response `200`

OK

- ModelResponse
  - `background` boolean
  - `created_at` integer
  - `error` ModelResponseError
    - `code` string
    - `message` string
  - `id` string
  - `incomplete_details` ModelIncompleteDetails
    - `reason` string
  - `instructions` string
  - `max_output_tokens` integer
  - `metadata` object
  - `model` string
  - `object` string
  - `output` ModelOutputItem[]
    - `arguments` string — For function_call type
    - `call_id` string — For function_call type
    - `content` ModelOutputContent[]
      - `annotations` unknown[]
        - unknown
      - `text` string
      - `type` string
    - `id` string
    - `name` string — For function_call type
    - `role` string
    - `status` 'in_progress' | 'queued' | 'completed' | 'failed' | 'incomplete' | 'cancelled'
    - `summary` unknown
    - `type` string
  - `parallel_tool_calls` boolean
  - `previous_response_id` string
  - `prompt_cache_retention` string
  - `reasoning` ModelResponseReasoning
    - `effort` string
    - `summary` unknown
  - `service_tier` string
  - `status` 'in_progress' | 'queued' | 'completed' | 'failed' | 'incomplete' | 'cancelled'
  - `store` boolean
  - `temperature` number
  - `text` ModelResponseText
    - `format` ModelResponseTextFormat
      - `type` string
  - `tool_choice` unknown
  - `tool_usage` ModelResponseToolUsage
    - `image_gen` ModelResponseToolUsageImageGen
      - `input_tokens` integer
      - `input_tokens_details` ModelResponseToolUsageTokensDetails
        - `image_tokens` integer
        - `text_tokens` integer
      - `output_tokens` integer
      - `output_tokens_details` ModelResponseToolUsageTokensDetails
        - `image_tokens` integer
        - `text_tokens` integer
      - `total_tokens` integer
    - `web_search` ModelResponseToolUsageWebSearch
      - `num_requests` integer
  - `tools` ModelResponseTool[]
    - `description` string
    - `name` string
    - `parameters` unknown
    - `type` string
  - `top_p` number
  - `truncation` string
  - `usage` ModelResponseUsage
    - `input_tokens` integer
    - `input_tokens_details` ModelResponseUsageDetails
      - `audio_tokens` integer
      - `cached_tokens` integer
      - `image_tokens` integer
      - `reasoning_tokens` integer
      - `video_tokens` integer
    - `output_tokens` integer
    - `output_tokens_details` ModelResponseUsageDetails
      - `audio_tokens` integer
      - `cached_tokens` integer
      - `image_tokens` integer
      - `reasoning_tokens` integer
      - `video_tokens` integer
    - `total_tokens` integer
  - `user` string

---

[API](https://skmtc.net/labring/apis/ai-proxy-swagger-api.md) · [All operations](https://skmtc.net/labring/apis/ai-proxy-swagger-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/labring/ai-proxy-swagger-api/versions/e471487f2a2f/schema)