Vidu Q Video Models
Authorizationstring*Replace {} with your API key
Token {your api key}modelstring*Model name
Accepted values: viduq3-turbo
imagesarray*Authorizationstring*Replace {} with your API key
Token {your api key}idstring*idstring*Task ID, returned by the create task API on success
Authorizationstring*Replace {} with your API key
Token {your api key}modelstring*Model name
Accepted values: viduq3-pro-fast
imagesarrayAuthorizationstring*Replace {} with your API key
Token {your api key}idstring*idstring*Task ID, returned by the create task API on success
Authorizationstring*Replace {} with your API key
Token {your api key}modelstring*Model name
Accepted values: viduq3-pro
imagesarray*Authorizationstring*Replace {} with your API key
Token {your api key}idstring*idstring*Task ID, returned by the create task API on success
Image parameters
Two images are supported. The first uploaded image is treated as the start frame and the second as the end frame, and the model generates the video based on the images passed in this parameter.
Note 1: The resolutions of the two input images must be close. The resolution of the start frame divided by the resolution of the end frame must be between 0.8 and 1.25, and the image aspect ratio must be less than 1:4 or 4:1;
Note 2: Image Base64 encoding or image URL (make sure it is accessible) is supported;
Note 3: Supported image formats: png, jpeg, jpg, webp;
Note 4: Image size must not exceed 50M;
Note 5: Please note that the byte length after base64 decode must be less than 10M, and the encoding must contain an appropriate content type string, for base64,{base64_encode}normal
data:image/pngpromptstringText prompt
Text description for video generation.
Note: The character length must not exceed 20000 characters
durationintegerVideo duration. Default values vary by model:
seedintegerRandom seed
resolutionstringResolution (based on model & duration):
audiobooleanWhether to use direct audio-video generation capability. Default: true. Enumerated values:
payloadstringtransparent transmission parameters
No processing, only data transmission, with a maximum length of 1048576 characters
off_peakbooleanoff peak mode, Defaults to false, enum:
true: off peak generate mode;false: normal generate mode;callback_urlstringCallback
When creating a task, you need to actively set the callback_url with a POST request. When the video generation task changes its status, Vidu will send a callback request to this URL, containing the latest status of the task. The structure of the callback request content will be the same as the return body of the GET Generation API.
The "status" in the callback response includes the following states:
processing: Task is being processed.success: Task is completed (if sending fails, it will retry the callback three times).failed: Task failed (if sending fails, it will retry the callback three times).Image parameters
Two images are supported. The first uploaded image is treated as the start frame and the second as the end frame, and the model generates the video based on the images passed in this parameter.
Note 1: The resolutions of the two input images must be close. The resolution of the start frame divided by the resolution of the end frame must be between 0.8 and 1.25, and the image aspect ratio must be less than 1:4 or 4:1;
Note 2: Image Base64 encoding or image URL (make sure it is accessible) is supported;
Note 3: Supported image formats: png, jpeg, jpg, webp;
Note 4: Image size must not exceed 50M;
Note 5: Please note that the byte length after base64 decode must be less than 10M, and the encoding must contain an appropriate content type string, for base64,{base64_encode}normal
data:image/pngpromptstringText prompt
Text description for video generation.
Note: The character length must not exceed 20000 characters
durationintegerVideo duration. Default values vary by model:
seedintegerRandom seed
resolutionstringResolution (based on model & duration):
audiobooleanWhether to use direct audio-video generation capability. Default: true. Enumerated values:
payloadstringtransparent transmission parameters
No processing, only data transmission, with a maximum length of 1048576 characters
off_peakbooleanoff peak mode, Defaults to false, enum:
true: off peak generate mode;false: normal generate mode;callback_urlstringCallback
When creating a task, you need to actively set the callback_url with a POST request. When the video generation task changes its status, Vidu will send a callback request to this URL, containing the latest status of the task. The structure of the callback request content will be the same as the return body of the GET Generation API.
The "status" in the callback response includes the following states:
processing: Task is being processed.success: Task is completed (if sending fails, it will retry the callback three times).failed: Task failed (if sending fails, it will retry the callback three times).Image parameters
Two images are supported. The first uploaded image is treated as the start frame and the second as the end frame, and the model generates the video based on the images passed in this parameter.
Note 1: The resolutions of the two input images must be close. The resolution of the start frame divided by the resolution of the end frame must be between 0.8 and 1.25, and the image aspect ratio must be less than 1:4 or 4:1;
Note 2: Image Base64 encoding or image URL (make sure it is accessible) is supported;
Note 3: Supported image formats: png, jpeg, jpg, webp;
Note 4: Image size must not exceed 50M;
Note 5: Please note that the byte length after base64 decode must be less than 10M, and the encoding must contain an appropriate content type string, for base64,{base64_encode}normal
data:image/pngpromptstringText prompt
Text description for video generation.
Note: The character length must not exceed 20000 characters
durationintegerVideo duration. Default values vary by model:
seedintegerRandom seed
resolutionstringResolution (based on model & duration):
audiobooleanWhether to use direct audio-video generation capability. Default: true. Enumerated values:
payloadstringtransparent transmission parameters
No processing, only data transmission, with a maximum length of 1048576 characters
off_peakbooleanoff peak mode, Defaults to false, enum:
true: off peak generate mode;false: normal generate mode;callback_urlstringCallback
When creating a task, you need to actively set the callback_url with a POST request. When the video generation task changes its status, Vidu will send a callback request to this URL, containing the latest status of the task. The structure of the callback request content will be the same as the return body of the GET Generation API.
The "status" in the callback response includes the following states:
processing: Task is being processed.success: Task is completed (if sending fails, it will retry the callback three times).failed: Task failed (if sending fails, it will retry the callback three times).application/jsonResponse fields
task_idstringTask ID
statestringIt will be returned to a specific processing state:
created created task successfullyqueueing task in queueprocessing processingapplication/jsonResponse fields
idstringTask ID
statestringIt will be returned to a specific processing state:
created created task successfullyqueueing task in queueprocessing processingapplication/jsonResponse fields
task_idstringTask ID
statestringIt will be returned to a specific processing state:
created created task successfullyqueueing task in queueprocessing processingapplication/jsonResponse fields
idstringTask ID
statestringIt will be returned to a specific processing state:
created created task successfullyqueueing task in queueprocessing processingapplication/jsonResponse fields
task_idstringTask ID
statestringIt will be returned to a specific processing state:
created created task successfullyqueueing task in queueprocessing processingapplication/jsonResponse fields
idstringTask ID
statestringIt will be returned to a specific processing state:
created created task successfullyqueueing task in queueprocessing processingsuccessfailed task failedmodelstringThe parameter of the model used for this call
promptstringThe text prompt used for this call
imagesarrayThe image used for this call
durationintegerThe video duration parameter used for this call
seedintegerThe random seed parameter used for this call
resolutionstringThe resolution parameter used for this call
audiobooleanWhether audio-video co-generation is used for this call
payloadstringThe payload parameter used for this call
off_peakbooleanThe off_peak parameter used for this call
creditsintegerThe credits used for this call
created_atstringTask creation time
successfailed task failederr_codestringError code, see the error code table for details
creditsintegerThe number of credits consumed by this task (unit: credits)
payloadstringThe payload parameter passed in when this task was called
off_peakbooleanWhether off peak mode is used in this task call
creationsarrayGeneration results
idstringCreation ID, used to identify different creations
urlstringURL of the generated result, valid for 24 hours
cover_urlstringCover of the generated result, valid for 24 hours
watermarked_urlstringsuccessfailed task failedmodelstringThe parameter of the model used for this call
promptstringThe text prompt used for this call
imagesarrayThe image used for this call
durationintegerThe video duration parameter used for this call
seedintegerThe random seed parameter used for this call
resolutionstringThe resolution parameter used for this call
audiobooleanWhether audio-video co-generation is used for this call
payloadstringThe payload parameter used for this call
off_peakbooleanThe off_peak parameter used for this call
creditsintegerThe credits used for this call
created_atstringTask creation time
successfailed task failederr_codestringError code, see the error code table for details
creditsintegerThe number of credits consumed by this task (unit: credits)
payloadstringThe payload parameter passed in when this task was called
off_peakbooleanWhether off peak mode is used in this task call
creationsarrayGeneration results
idstringCreation ID, used to identify different creations
urlstringURL of the generated result, valid for 24 hours
cover_urlstringCover of the generated result, valid for 24 hours
watermarked_urlstringsuccessfailed task failedmodelstringThe parameter of the model used for this call
promptstringThe text prompt used for this call
imagesarrayThe image used for this call
durationintegerThe video duration parameter used for this call
seedintegerThe random seed parameter used for this call
resolutionstringThe resolution parameter used for this call
audiobooleanWhether audio-video co-generation is used for this call
payloadstringThe payload parameter used for this call
off_peakbooleanThe off_peak parameter used for this call
creditsintegerThe credits used for this call
created_atstringTask creation time
successfailed task failederr_codestringError code, see the error code table for details
creditsintegerThe number of credits consumed by this task (unit: credits)
payloadstringThe payload parameter passed in when this task was called
off_peakbooleanWhether off peak mode is used in this task call
creationsarrayGeneration results
idstringCreation ID, used to identify different creations
urlstringURL of the generated result, valid for 24 hours
cover_urlstringCover of the generated result, valid for 24 hours
watermarked_urlstringcurl --request POST \
--url 'https://api.vidu.com/ent/v2/start-end2video' \
--header 'Authorization: Token {your api key}' \
--header 'Content-Type: application/json' \
--data '{
"model": "viduq3-turbo",
"images": "data:image/png",
"prompt": "The camera zooms in on the bird, which then flies to the right. With its flight being smooth and natural, the bird soars in the sky. with a red light effect following and surrounding it from behind.",
"duration": 5,
"seed": 0,
"resolution": "1080p",
"audio": true,
"payload": "string",
"off_peak": true,
"callback_url": "string"
}'{
"task_id": "your_task_id_here",
"state": "created",
"model": "viduq3-turbo",
"images": ["https://prod-ss-images.s3.cn-northwest-1.amazonaws.com.cn/vidu-maas/template/startend2video-1.jpeg","https://prod-ss-images.s3.cn-northwest-1.amazonaws.com.cn/vidu-maas/template/startend2video-2.jpeg"],
"prompt": "The camera zooms in on the bird, which then flies to the right. The bird's flight is smooth and natural, with a red light effect following and surrounding it from behind.",
"duration": 5,
"seed": random_number,
"resolution": "1080p",
"movement_amplitude": "auto",
"payload": "",
"off_peak": false,
"credits": credits_number,
"created_at": "2025-01-01T15:41:31.968916Z"
}curl --request GET \
--url 'https://api.vidu.com/ent/v2/tasks/{your_id}/creations' \
--header 'Authorization: Token {your api key}' \
--header 'Content-Type: application/json'{
"id": "your_task_id",
"state": "success",
"err_code": "",
"credits": 4,
"payload": "",
"creations": [
{
"id": "your_creations_id",
"url": "your_generated_results_url",
"cover_url": "your_generated_results_cover_url",
"watermarked_url": "your_generated_results_watermarked_url"
}
]
}curl --request POST \
--url 'https://api.vidu.com/ent/v2/start-end2video' \
--header 'Authorization: Token {your api key}' \
--header 'Content-Type: application/json' \
--data '{
"model": "viduq3-pro-fast",
"images": "data:image/png",
"prompt": "The camera zooms in on the bird, which then flies to the right. With its flight being smooth and natural, the bird soars in the sky. with a red light effect following and surrounding it from behind.",
"duration": 5,
"seed": 0,
"resolution": "1080p",
"audio": true,
"payload": "string",
"off_peak": true,
"callback_url": "string"
}'{
"task_id": "your_task_id_here",
"state": "created",
"model": "viduq3-pro-fast",
"images": ["https://prod-ss-images.s3.cn-northwest-1.amazonaws.com.cn/vidu-maas/template/startend2video-1.jpeg","https://prod-ss-images.s3.cn-northwest-1.amazonaws.com.cn/vidu-maas/template/startend2video-2.jpeg"],
"prompt": "The camera zooms in on the bird, which then flies to the right. The bird's flight is smooth and natural, with a red light effect following and surrounding it from behind.",
"duration": 5,
"seed": random_number,
"resolution": "1080p",
"movement_amplitude": "auto",
"payload": "",
"off_peak": false,
"credits": credits_number,
"created_at": "2025-01-01T15:41:31.968916Z"
}curl --request GET \
--url 'https://api.vidu.com/ent/v2/tasks/{your_id}/creations' \
--header 'Authorization: Token {your api key}' \
--header 'Content-Type: application/json'{
"id": "your_task_id",
"state": "success",
"err_code": "",
"credits": 4,
"payload": "",
"creations": [
{
"id": "your_creations_id",
"url": "your_generated_results_url",
"cover_url": "your_generated_results_cover_url",
"watermarked_url": "your_generated_results_watermarked_url"
}
]
}curl --request POST \
--url 'https://api.vidu.com/ent/v2/start-end2video' \
--header 'Authorization: Token {your api key}' \
--header 'Content-Type: application/json' \
--data '{
"model": "viduq3-pro",
"images": "data:image/png",
"prompt": "The camera zooms in on the bird, which then flies to the right. With its flight being smooth and natural, the bird soars in the sky. with a red light effect following and surrounding it from behind.",
"duration": 5,
"seed": 0,
"resolution": "1080p",
"audio": true,
"payload": "string",
"off_peak": true,
"callback_url": "string"
}'{
"task_id": "your_task_id_here",
"state": "created",
"model": "viduq3-pro",
"images": ["https://prod-ss-images.s3.cn-northwest-1.amazonaws.com.cn/vidu-maas/template/startend2video-1.jpeg","https://prod-ss-images.s3.cn-northwest-1.amazonaws.com.cn/vidu-maas/template/startend2video-2.jpeg"],
"prompt": "The camera zooms in on the bird, which then flies to the right. The bird's flight is smooth and natural, with a red light effect following and surrounding it from behind.",
"duration": 5,
"seed": random_number,
"resolution": "1080p",
"movement_amplitude": "auto",
"payload": "",
"off_peak": false,
"credits": credits_number,
"created_at": "2025-01-01T15:41:31.968916Z"
}curl --request GET \
--url 'https://api.vidu.com/ent/v2/tasks/{your_id}/creations' \
--header 'Authorization: Token {your api key}' \
--header 'Content-Type: application/json'{
"id": "your_task_id",
"state": "success",
"err_code": "",
"credits": 4,
"payload": "",
"creations": [
{
"id": "your_creations_id",
"url": "your_generated_results_url",
"cover_url": "your_generated_results_cover_url",
"watermarked_url": "your_generated_results_watermarked_url"
}
]
}URL of the watermarked generated result, valid for 24 hours
URL of the watermarked generated result, valid for 24 hours
URL of the watermarked generated result, valid for 24 hours