Skip to main content
POST
cURL

Authorizations

X-API-ID
string
header
required

API ID, from your settings page.

X-API-KEY
string
header
required

API Key, from your settings page.

Body

prompt
string
required

Describe the video: subject, action, camera, and any dialogue or sound it should contain.

image_url
string<uri> | null

Optional start frame. The video follows the image's own aspect ratio unless aspect_ratio names one, which centre-crops the image to it.

Maximum string length: 2000
audio_url
string<uri> | null

Optional audio track ('mp3' or 'wav') that drives the video. When set, the video is as long as the audio, within the same per-resolution limit, and duration is ignored.

Maximum string length: 2000
resolution
enum<string>
default:720p

Delivery tier. 2k is 2016 px on the long edge for 16:9 and 9:16, and the 1440p row for 1:1, 4:3 and 3:4. Each started 10 seconds of video costs 1 credit at 720p, 3 credits at 1080p and 12 credits at 2k.

  • 720p - 720p
  • 1080p - 1080p
  • 2k - 2k
Available options:
720p,
1080p,
2k
aspect_ratio
enum<string>
default:auto

Frame ratio. auto follows the start image's own ratio, and is 16:9 without an image. A named ratio renders that ratio; with an image it centre-crops the image to it.

  • auto - auto
  • 16:9 - 16:9
  • 9:16 - 9:16
  • 1:1 - 1:1
  • 4:3 - 4:3
  • 3:4 - 3:4
Available options:
auto,
16:9,
9:16,
1:1,
4:3,
3:4
duration
number<double>
default:10

Video length in seconds, greater than 0 and at most 60 at 720p, 30 at 1080p and 15 at 2k.

negative_prompt
string | null

What the video should avoid.

webhook_url
string<uri> | null
Maximum string length: 200

Response

201 - application/json
id
string<uuid>
required
read-only
created_at
string<date-time>
required
read-only
updated_at
string<date-time>
required
read-only
prompt
string
required

Describe the video: subject, action, camera, and any dialogue or sound it should contain.

status
enum<string>
required
  • pending - Pending
  • in_queue - In Queue
  • running - Running
  • failed - Failed
  • done - Done
  • rejected - Rejected
Available options:
pending,
in_queue,
running,
failed,
done,
rejected
failed_reason
string
required
read-only

Failed reason

video_output
string | null
required
read-only

Video output URL

credits_used
number
required
read-only

Credits used in this API call

progress
number<double>
required
read-only

Progress of the job

image_url
string<uri> | null

Optional start frame. The video follows the image's own aspect ratio unless aspect_ratio names one, which centre-crops the image to it.

Maximum string length: 2000
audio_url
string<uri> | null

Optional audio track ('mp3' or 'wav') that drives the video. When set, the video is as long as the audio, within the same per-resolution limit, and duration is ignored.

Maximum string length: 2000
resolution
enum<string>
default:720p

Delivery tier. 2k is 2016 px on the long edge for 16:9 and 9:16, and the 1440p row for 1:1, 4:3 and 3:4. Each started 10 seconds of video costs 1 credit at 720p, 3 credits at 1080p and 12 credits at 2k.

  • 720p - 720p
  • 1080p - 1080p
  • 2k - 2k
Available options:
720p,
1080p,
2k
aspect_ratio
enum<string>
default:auto

Frame ratio. auto follows the start image's own ratio, and is 16:9 without an image. A named ratio renders that ratio; with an image it centre-crops the image to it.

  • auto - auto
  • 16:9 - 16:9
  • 9:16 - 9:16
  • 1:1 - 1:1
  • 4:3 - 4:3
  • 3:4 - 3:4
Available options:
auto,
16:9,
9:16,
1:1,
4:3,
3:4
duration
number<double>
default:10

Video length in seconds, greater than 0 and at most 60 at 720p, 30 at 1080p and 15 at 2k.

negative_prompt
string | null

What the video should avoid.

webhook_url
string<uri> | null
Maximum string length: 200