platform-api

Create a video job (Idempotency-Key required): holds its estimate from the balance and queues it; 202 with the video

post/v1/videos

Request

  • Base URL: https://api.cuddler.ai
  • URL: https://api.cuddler.ai/v1/videos
  • Auth: HTTP bearer

Headers

Idempotency-Keystring required

Required. One key per logical request (e.g. ep03-shot042-take1), never reusable: the same key and body answer with the original object and Idempotent-Replayed: true; the same key with a different body is 409 (and so is any reuse once the job's request trace was removed, 180 days after it finished).

Request body

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
mode'text' | 'image' | 'reference' | 'edit' | 'extend' | 'motion-control' | 'image-reference' | 'video-reference' | 'first-last-frame'
variant'default' | 'fast' | 'pro' | 'standard' | 'turbo' | '4k' | 'base' | 'utility' | 'utility-pro'
max_usdstring

Maximum USD this job may charge; creation refuses a larger hold and settlement never exceeds this ceiling

promptstring required
durationinteger required
resolution'360p' | '480p' | '540p' | '720p' | '768p' | '1080p' | '1440p' | '0.5K' | '1K' | '2K' | '4K'
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'
generate_audioboolean
seedinteger
camera_fixedboolean
character_orientation'image' | 'video'
fpsinteger
return_last_frameboolean
first_framestring

An upload id (upl_…), or a public https:// URL the API fetches once when the job is created

last_framestring

An upload id (upl_…), or a public https:// URL the API fetches once when the job is created

reference_imagesstring[]
reference_videosstring[]
reference_audiosstring[]
task_type'auto' | 'edit' | 'extend'
webhook_urlstring uri
metadataobject

Response

Replay: this Idempotency-Key already created this video

object'video' required
idstring required
status'queued' | 'running' | 'succeeded' | 'failed' | 'canceled' required
stage'preparing_references'
poll_after_secondsinteger
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
promptstring required
durationinteger 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_audioboolean required
created_atstring required
started_atstring nullable required
completed_atstring nullable required
queue_positioninteger nullable required
metadataobject required
price_versionstring required
api_key_idstring required

Changes

No recorded changes to this operation across all 1 revision of this API.