Search skmtc…
⌘K
Docs
Sign in
APIs
Generators
Stacks
Projects
Docs
History
Schema
Generate
Filter operations
platform-api
35
get
/v1/catalog
Public retail model catalog and curated voices; no organisation or account cost data
get
/v1/models
The video and image models, their limits, billing unit and prices, and which ones this organization may use
get
/v1/models/{id}
One model: kind, durations or canvases, reference limits and per-resolution prices
post
/v1/videos/estimate
Price a video before creating it: model tokens (or seconds), USD and the balance hold; writes nothing
get
/v1/videos
This organization's videos, newest first, optionally by status; paged with next_cursor
post
/v1/videos
Create a video job (Idempotency-Key required): holds its estimate from the balance and queues it; 202 with the video
get
/v1/videos/{id}
One video: status, final bill, a fresh one-hour download link once it succeeded, or the failure reason
post
/v1/videos/{id}/cancel
Cancel a queued video and release its hold; a video already rendering cannot be canceled
get
/v1/videos/{id}/download
A succeeded video with the Cuddler.ai watermark (watermark=true): a one-hour link to the marked file, made on the first call (up to about a minute); free, 20 new files per 10 minutes per organization
post
/v1/images/estimate
Price an image before creating it: USD per image and the balance hold; writes nothing
get
/v1/images
This organization's images, newest first, optionally by status; paged with next_cursor
post
/v1/images
Create an image job (Idempotency-Key required): text or reference images to one image, billed per image; 202 with the image
get
/v1/images/{id}
One image: status, final bill, a fresh one-hour download link once it succeeded, or the failure reason
get
/v1/speech
This organization's speech jobs, newest first
post
/v1/speech
Generate speech with a frozen price and one provider submission; Idempotency-Key required
get
/v1/music
This organization's music jobs, newest first
post
/v1/music
Generate music with a frozen price and one provider submission; Idempotency-Key required
post
/v1/speech/estimate
Exact text meter, voice surcharge and price before creating speech
post
/v1/music/estimate
Quote one music generation before creating it
get
/v1/speech/{id}
One speech job and a fresh private download link
get
/v1/music/{id}
One music job and a fresh private download link
post
/v1/speech/{id}/cancel
Cancel queued speech and release its hold
post
/v1/music/{id}/cancel
Cancel queued music and release its hold
get
/v1/voices
Curated voices supported by the requested speech model
post
/v1/uploads
Start a reference upload (Idempotency-Key required): returns a signed PUT URL and the headers to send
get
/v1/uploads/{id}
One upload and its state: pending, ready, rejected (with the reason) or expired
post
/v1/uploads/{id}/complete
Finish an upload after the PUT: checks, strips image metadata and moderates it; ready uploads are kept 30 days
post
/v1/portraits
Start the official portrait authorization for an owned reference; the person must complete it
get
/v1/portraits/{id}
Verify portrait authorization with the official service
post
/v1/portraits/{id}/revoke
Revoke portrait authorization and schedule removal of its remote copies
get
/v1/videos/{id}/references
Reference preparation and authorization actions for this video
get
/v1/balance
The prepaid USD balance: total, held for running jobs, available (the spending limit), and today's spend with the daily limit if one is set ("0.000000" = none)
get
/v1/usage
Spend, tokens, seconds and video counts between two UTC dates, by day, by model and resolution, and by key
get
/v1/openapi.json
This API as OpenAPI 3.1
get
/v1/llms.txt
Agent-readable index of the endpoints, models, prices and limits
platform-api
Copy
Copy Markdown
Copy Markdown
Copying…
Copied
Copy failed
Generate code
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
Music job
object
required
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
usage
object
nullable
required
output
object
nullable
required
error
object
nullable
required
price_version
string
required
api_key_id
string
required
metadata
object
required
Changes