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_KEY
Parameters
model string required
Model ID to use for the request
Value: viduq2_pro_start_end2video
images array required
Start and end frame images, supports input of two images, the first uploaded image is considered the start frame, the second image is considered the end frame, the model will generate video using the images passed in this parameter
Format Requirements:
The two input images for start and end frames need similar resolutions, the ratio of start frame resolution / end frame resolution should be between 0.8 ~ 1.25, and the image aspect ratio must be less than 1:4 or 4:1
Supports Base64 encoding or image URL (must be accessible)
Supported formats: png, jpeg, jpg, webp
Image size must not exceed 50MB
HTTP request POST body must not exceed 20MB, and encoding must include appropriate content type string. Example: data:image/png;base64,{base64_encode}
prompt string
Text description for video generation, maximum 2000 characters
If using is_rec recommended prompt parameter, the model will not consider the prompt entered in this parameter
is_rec boolean
Whether to use recommended prompt
When true, the system automatically recommends a prompt and uses the prompt content to generate the video, the number of recommended prompts = 1; when false, generates video based on the input prompt
Note: Enabling recommended prompts consumes additional points per task
Options: true, false
Default: false
duration integer
Video duration in seconds
Options: 1, 2, 3, 4, 5, 6, 7, 8
Default: 5
seed integer
Random seed, when not provided or set to 0, uses a random number instead, manual setting uses the specified seed
resolution string
Resolution parameter
Options: 540p, 720p, 1080p
Default: 720p
movement_amplitude string
Movement amplitude
Options: auto, small, medium, large
Default: auto
bgm boolean
Whether to add background music to the generated video
When true, the system will automatically select and add appropriate music from the preset BGM library; when false, no BGM is added
BGM has no time limit, the system automatically adapts to video duration
Options: true, false
Default: false
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
meta_data string
Metadata identifier, JSON format string, pass-through field
You can customize the format or use the example format. Example:
{
"Label": "your_label",
"ContentProducer": "yourcontentproducer",
"ContentPropagator": "your_content_propagator",
"ProduceID": "yourproductid",
"PropagateID": "your_propagate_id",
"ReservedCode1": "yourreservedcode1",
"ReservedCode2": "your_reserved_code2"
}
When this parameter is empty, the default metadata identifier generated by vidu 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
stringError code
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 |
|---|---|
| 002014001 | Image is missing |