Sign in

v3

OpenAPI 3.1.0MIT2026-07-31192456807.8 KB
Video

Create video

Create a video

post/videos

Request body

modelstring required

The model to be used for the video creation request.

promptstring

Text prompt that describes the video to generate.

heightinteger
widthinteger
resolutionstring

Video resolution.

ratiostring

Aspect ratio of the video.

secondsstring

Clip duration in seconds.

fpsinteger

Frames per second. Defaults to 24.

stepsinteger

The number of denoising steps the model performs during video generation. More steps typically result in higher quality output but require longer processing time.

seedinteger

Seed to use in initializing the video generation. Using the same seed allows deterministic video generation. If not provided a random seed is generated for each request.

guidance_scaleinteger

Controls how closely the video generation follows your prompt. Higher values make the model adhere more strictly to your text description, while lower values allow more creative freedom. guidence_scale affects both visual content and temporal consistency.Recommended range is 6.0-10.0 for most video models. Values above 12 may cause over-guidance artifacts or unnatural motion patterns.

output_format'MP4' | 'WEBM'
output_qualityinteger

Compression quality. Defaults to 20.

negative_promptstring

Similar to prompt, but specifies what to avoid instead of what to include

generate_audioboolean

Whether to generate audio for the video.

reference_imagesstring[]

Deprecated: use media.reference_images instead. Unlike frame_images which constrain specific timeline positions, reference images guide the general appearance that should appear consistently across the video.

Example request

{
  "frame_images": [
    [
      {
        "input_image": "aac49721-1964-481a-ae78-8a4e29b91402",
        "frame": 0
      },
      {
        "input_image": "c00abf5f-6cdb-4642-a01d-1bfff7bc3cf7",
        "frame": 48
      },
      {
        "input_image": "3ad204c3-a9de-4963-8a1a-c3911e3afafe",
        "frame": "last"
      }
    ]
  ]
}

Response

Success

idstring required

Unique identifier for the video job.

object'video'

The object type, which is always video.

modelstring required

The video generation model that produced the job.

status'in_progress' | 'completed' | 'failed' required

Current lifecycle status of the video job.

created_atnumber required

Unix timestamp (seconds) for when the job was created.

completed_atnumber

Unix timestamp (seconds) for when the job completed, if finished.

sizestring required

The resolution of the generated video.

secondsstring required

Duration of the generated clip in seconds.