Authentication
authorization string required
All APIs require authentication via Bearer Token.
Get API Key:
Visit API Key Management Page to get your API Key
Usage:
Add to request header:
Authorization: Bearer YOUR_API_KEYParameters
model string required
Model ID to use for the request
Value: viduq1_reference2video
subjects array required
Subject information from reference images, supports 1 - 7 subjects, total 1 - 7 images
id
stringrequiredSubject ID, can be referenced later using
@subject_idformat
images
arrayrequiredImage URLs for this subject, each subject supports up to
3imagesFormat Requirements:
Supports Base64 encoding or image URL (must be accessible)
Supported formats: png, jpeg, jpg, webp
Image pixels must not be smaller than128x128, and aspect ratio must be less than1:4or4:1, and size must not exceed50MB
HTTP request POST body must not exceed20MB, and encoding must include appropriate content type string. Example:data:image/png;base64,{base64_encode}
voice_id
stringVoice ID to determine the voice timbre in the video, when empty, the system will automatically recommend, refer to the available voice list for options
prompt string required
Text description for video generation, maximum 2000 characters
When using subjects parameter, you can use @subject_id to represent subject content, for example: “@1 and @2 eating hotpot together, with voiceover saying everyone loves hotpot.”
audio boolean
Whether to use audio-video direct output capability
When true, uses audio-video direct output capability; when false, does not use audio-video direct output capability
Options: true, false
Default: false
duration integer
Video duration in seconds
Options: 5
Default: 5
seed integer
Random seed, when not provided or set to 0, uses a random number instead, manual setting uses the specified seed
aspect_ratio string
Aspect ratio
Options: 16:9, 9:16, 1:1
Default: 16:9
resolution string
Resolution parameter
Options: 1080p
Default: 1080p
movement_amplitude string
Movement amplitude
Options: auto, small, medium, large
Default: auto
payload string
Pass-through parameter, no processing required, only data transmission, maximum 1048576 characters
off_peak boolean
Note: Temporarily unavailable
Off-peak mode, off-peak mode consumes fewer points. Tasks submitted in off-peak mode will be generated within 48 hours. Tasks that cannot be completed will be automatically canceled and points will be refunded
When true, generates video during off-peak hours; when false, generates video immediately
Options: true, false
Default: false
watermark boolean
Whether to add a watermark. When true, a watermark is added; when false, no watermark is added
Currently watermark content is fixed and AI-generated, by default no watermark is added
Options: true, false
Default: false
wm_position integer
Watermark position, indicating where the watermark appears on the image
Options: 1 (Top-left), 2 (Top-right), 3 (Bottom-right), 4 (Bottom-left)
Default: 3
wm_url string
Watermark content, provided as an image URL, when not provided, the default AI-generated watermark content is used
callback_url string
Callback URL
Polling
Since video generation takes time, you need to poll the task status after creation
The initial response returns the task ID and initial status. The actual generation results must be obtained through polling the task status endpoint
Response Format
error object
Error information. Only present when status is failed.
code
integerError code
error_message
stringDetailed error message
output array
Generation results. Only present when status is completed.
content
arrayList of generated content
type
stringResource type
Value:
videourl
stringGenerated content URL
usage object
Usage statistics. Only present when status is completed.
cost
stringTotal cost in USD
discount
numberDiscount amount
metadata object
Metadata information.
Error Codes
| Error Code | Description |
|---|---|
| 008009098 | Generation failed |
| 008009099 | Service unavailable |