---
title: "Cancel a queued video and release its hold; a video already rendering cannot be canceled"
method: POST
path: "/v1/videos/{id}/cancel"
tags: ["platform-api"]
---

# Cancel a queued video and release its hold; a video already rendering cannot be canceled

`POST /v1/videos/{id}/cancel`

## Request

- Base URL: `https://api.cuddler.ai`
- URL: `https://api.cuddler.ai/v1/videos/{id}/cancel`
- Auth: HTTP bearer

## Path parameters

- `id` string, required

## Response `200`

Canceled, hold released

- object
  - `object` 'video', required
  - `id` string, required
  - `status` 'queued' | 'running' | 'succeeded' | 'failed' | 'canceled', required
  - `stage` 'preparing_references'
  - `poll_after_seconds` integer
  - `model` 'seedance-2.5' | 'seedance-2.0' | 'seedance-2.0-mini' | 'minimax-h3' | 'wan-3.0' | 'wan-3.0-prime' | 'happyhorse-1.0' | 'happyhorse-1.1' | 'wan-2.6' | 'wan-2.7' | 'ltx-2.5' | 'minimax-hailuo-2.3' | 'pixverse-6' | 'grok-video-1.5' | 'kling-3.0' | 'kling-2.6' | 'kling-2.5-turbo' | 'kling-o1' | 'kling-o3' | 'vidu-q4-preview' | 'runway-gen4.5' | 'runway-gen4-turbo' | 'veo-3.1' | 'veo-3.1-fast' | 'veo-3.1-lite' | 'veo-3' | 'veo-3-fast' | 'veo-2' | 'gemini-omni-flash', required
  - `prompt` string, required
  - `duration` integer, required
  - `resolution` '360p' | '480p' | '540p' | '720p' | '768p' | '1080p' | '1440p' | '0.5K' | '1K' | '2K' | '4K', required
  - `aspect_ratio` '16:9' | '9:16' | '4:3' | '3:4' | '1:1' | '21:9' | 'adaptive' | '9:21' | '4:5' | '5:4' | '2:3' | '3:2' | '5:2', required
  - `generate_audio` boolean, required
  - `created_at` string, required
  - `started_at` string, nullable, required
  - `completed_at` string, nullable, required
  - `queue_position` integer, nullable, required
  - `estimate` object, required
    - `tokens` integer, required
    - `usd` string, required
    - `hold_usd` string, required
  - `usage` object, nullable, required
    - `tokens` integer, required
    - `usd` string, required
    - `usd_micros` integer, required
  - `output` object, nullable, required
    - `url` string, uri, required
    - `url_expires_at` string, required
    - `retained_until` string, required
    - `width` integer, nullable, required
    - `height` integer, nullable, required
    - `duration` number, nullable, required
    - `has_audio` boolean, required
    - `last_frame_url` string, uri, nullable, required
  - `error` object, nullable, required
    - `code` 'content_policy' | 'reference_rejected' | 'invalid_parameters' | 'upstream_error' | 'timeout' | 'internal_error', required
    - `message` string, required
  - `metadata` object, required
  - `price_version` string, required
  - `api_key_id` string, required

## Other responses

- `401`: unauthorized — no key, or an unknown or revoked one (WWW-Authenticate: Bearer)
- `403`: organization_suspended — the organization is not active; forbidden — a test key on a live-only route
- `404`: not_found — the Platform API is switched off, or the object does not exist
- `409`: not_cancelable — the video is already rendering or finished
- `429`: rate_limited — over this key's requests per minute (Retry-After)
- `500`: internal_error — quote request_id when contacting support

---

[API](https://skmtc.dev/cuddler/apis/cuddler-platform-api.md) · [All operations](https://skmtc.dev/cuddler/apis/cuddler-platform-api/llms.txt) · [OpenAPI document](https://skmtc.dev/cuddler/apis/cuddler-platform-api/revisions/f03943ceadff?raw)