Skip to main content
POST

Authorizations

Authorization
string
header
required

API Key authentication. Format: Bearer YOUR_API_KEY.

Body

application/json

Generate a video using reference images, reference videos, or both.

prompt
string
required

Describe the scene, motion, or edit to produce.

Minimum string length: 1
referenceImages
string<uri>[]
required

Optional reference images. Supply referenceImages, referenceVideos, or both.

Required array length: 1 - 10 elements

Publicly reachable HTTP(S) URL of a reference image.

Minimum string length: 1
Pattern: ^https?://
resolution
enum<string>
default:720p

Output resolution.

Available options:
360p,
720p,
1080p,
4k
seed
integer

Optional generation seed. Omit it to leave seed selection to the model.

aspectRatio
enum<string>
default:16:9

Output aspect ratio.

Available options:
16:9,
9:16
duration
string
default:8

Generated video length from 3 to 15 whole seconds. Send the decimal value as a string.

Pattern: ^([3-9]|1[0-5])$
referenceVideos
string<uri>[]

Reference video URLs. At most 1 video may be supplied when duration is 11 to 15 seconds.

Required array length: 1 - 3 elements

Publicly reachable HTTP(S) URL of a short reference video.

Minimum string length: 1
Pattern: ^https?://

Response

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.