⋙ List Videos

List generated videos.

msg.payload Properties

after string

Pagination cursor for items after this id.

limit integer

Maximum number of videos to return.

order string

Sort order by creation time. Use asc or desc.

⋙ Create Video

Create a new video generation job.

msg.payload Properties

prompt string

Prompt describing the video output.

input_reference file | object

Optional reference asset upload or reference object. Use a file upload, or an object with file_id or image_url.

model string

Video model id.

seconds string

Clip length in seconds.

size string

Video resolution. Supported sizes include 720x1280, 1280x720, 1024x1792, and 1792x1024.

⋙ Retrieve Video

Retrieve one video job by id.

msg.payload Properties

video_id string

The video id.

⋙ Delete Video

Delete one video job by id.

msg.payload Properties

video_id string

The video id.

⋙ Create Video Character

Create a reusable API character from an uploaded video.

msg.payload Properties

name string

Display name for the character.

video file

Uploaded video file used to create the character.

⋙ Download Video Content

Download rendered video content or related assets.

msg.payload Properties

video_id string

The video id.

variant string

Asset variant: video, thumbnail, or spritesheet.

⋙ Edit Video

Create a new video generation job by editing a source video or completed generated video.

msg.payload Properties

prompt string

Text prompt describing how to edit the source video.

video file | object

Source video upload or a reference object with id for a completed video.

⋙ Extend Video

Create an extension of a completed video.

msg.payload Properties

prompt string

Updated prompt that directs the extension generation.

seconds string

Length of the new extension segment in seconds. Supported values are 4, 8, 12, 16, and 20.

video file | object

Source video upload or a reference object with id for a completed video.

⋙ Retrieve Video Character

Fetch one API character by id.

msg.payload Properties

character_id string

The character id.

⋙ Remix Video

Create a remix from an existing video id.

msg.payload Properties

video_id string

The source video id.

prompt string

Prompt describing remix changes.