Skip to main content
POST

Authorizations

Authorization
string
header
required

API Key authentication. Format: Bearer YOUR_API_KEY.

Body

application/json

Generate, edit, or extend a video using video references, with optional image and audio references. At most 20 reference assets in total.

video_urls
string<uri>[]
required

Reference videos, each 2-30 seconds; editing sources must be 4-30 seconds. At most 30 seconds of video in total. Use publicly accessible HTTPS URLs or asset:// IDs.

Required array length: 1 - 5 elements

HTTPS URL or asset://<asset_id>.

Example:
prompt
string

Editing, extension, or generation instruction. Refer to inputs with @Image1, @Video1, or @Audio1.

Required string length: 1 - 10000
Example:

"Replace the lamp in @Video1 with the lamp from @Image1 while preserving the camera movement and original audio."

reference_images
string<uri>[]

Reference images. Use publicly accessible HTTPS URLs or asset:// IDs.

Required array length: 1 - 10 elements
Example:
audio_urls
string<uri>[]

Reference audio in WAV or MP3 format, each 2-30 seconds and at most 30 seconds in total.

Required array length: 1 - 5 elements
Example:
ratio
enum<string>
default:adaptive

Only an explicit omni_reference_task_type=reference uses your chosen aspect ratio. For auto, edit, extend, or an omitted task type, the platform replaces any supplied ratio with adaptive and bills using adaptive.

Available options:
16:9,
4:3,
1:1,
3:4,
9:16,
21:9,
adaptive
Example:

"adaptive"

resolution
enum<string>
default:720p

Output resolution.

Available options:
480p,
720p
Example:

"720p"

duration
enum<integer>

Output duration in seconds. For editing, omit this field or set -1 to preserve the source duration. For reference generation and extension, set 4-30 or use -1 for automatic duration.

Available options:
4,
5,
6,
7,
8,
9,
10,
11,
12,
13,
14,
15,
16,
17,
18,
19,
20,
21,
22,
23,
24,
25,
26,
27,
28,
29,
30,
-1
Example:

5

generate_audio
boolean
default:true

Whether to generate an audio track with the video

Example:

true

output_format
enum<string>
default:mp4

Output video container format.

Available options:
mp4,
mov
Example:

"mp4"

execution_expires_after
integer
default:172800

Maximum time in seconds before the task expires.

Required range: 3600 <= x <= 259200
Example:

172800

return_last_frame
boolean
default:false

Whether to return the last frame of the generated video

Example:

false

omni_reference_task_type
enum<string>
default:auto

reference generates a new video from references; edit modifies the source video; extend continues it. auto infers the task from the prompt and inputs.

Available options:
auto,
reference,
edit,
extend
Example:

"edit"

Response

200 - application/json

Task submitted successfully

code
integer
required

Response code, 0 indicates success

Example:

0

message
string
required

Response message

Example:

"success"

data
object
required

Detailed data about the submitted asynchronous task.