Skip to main content
POST

Authorizations

Authorization
string
header
required

API Key authentication. Format: Bearer YOUR_API_KEY.

Body

application/json

PixVerse reference-to-video (fusion) request. Fuses 1-7 reference images into a video; each reference image is an OBJECT carrying a url plus optional role (type) and a name (ref_name) referenceable in the prompt via @ref_name. NOTE: unlike xai/vidu (flat URL string arrays), PixVerse reference_images items are objects. Used by both v6 and c1 (the path determines the model version).

reference_images
object[]
required

Reference images (1-7) fused into the generated video. Each item is an object: a publicly accessible image URL, plus optional role (type: subject/background) and a name (ref_name) you can reference in the prompt via @ref_name for precise multi-subject control.

Required array length: 1 - 7 elements
Example:
prompt
string
required

Text prompt; may reference named images via @ref_name (e.g. "@hero in @forest").

Required string length: 1 - 5000
Example:

"@hero runs across @forest under the northern lights"

duration
integer
required

Video duration in seconds (required).

Required range: 1 <= x <= 15
Example:

5

quality
enum<string>
required

Output resolution (required).

Available options:
360p,
540p,
720p,
1080p
Example:

"720p"

aspect_ratio
enum<string>
required

Video aspect ratio (required).

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

"16:9"

seed
integer

Random seed (omit for random).

Required range: 0 <= x <= 2147483647
Example:

0

generate_audio_switch
boolean
default:false

Whether to generate audio.

Example:

false

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.