---
title: "Cancel queued music and release its hold"
method: POST
path: "/v1/music/{id}/cancel"
tags: ["platform-api"]
---

# Cancel queued music and release its hold

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

## Request

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

## Path parameters

- `id` string, required

## Response `200`

Music job

- object
  - `object` 'music', required
  - `id` string, required
  - `model` 'lyria-3-pro' | 'lyria-3' | 'lyria-2' | 'eleven-music-2.5', required
  - `status` 'queued' | 'running' | 'succeeded' | 'failed' | 'canceled', required
  - `created_at` string, required
  - `started_at` string, nullable, required
  - `completed_at` string, nullable, required
  - `queue_position` integer, nullable, required
  - `estimate` object, required
    - `meter` 'generation', required
    - `units` 1, required
    - `usd` string, required
    - `hold_usd` string, required
  - `usage` object, nullable, required
    - `meter` 'generation', required
    - `units` 1, 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
    - `content_type` 'audio/mpeg', required
    - `duration` number, required
    - `sample_rate` integer, required
    - `channels` integer, required
    - `peaks` number[], required
  - `error` object, nullable, required
    - `code` 'content_policy' | 'reference_rejected' | 'invalid_parameters' | 'upstream_error' | 'timeout' | 'internal_error', required
    - `message` string, required
  - `price_version` string, required
  - `api_key_id` string, required
  - `metadata` object, 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
- `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)