Vidu Q Video Models

Vidu 2.0

Start-End to Video

Create Task

POST/ent/v2/start-end2video

Query Creations

GET/ent/v2/tasks/{id}/creations

Headers

Authorizationstring*

Replace {} with your API key

Example:Token {your api key}

Body parameters

modelstring*

Model name
Accepted values: vidu2.0

vidu2.0: Fast generation speed

imagesstring*

Image parametersTwo 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

Headers

Authorizationstring*

Replace {} with your API key

Example:Token {your api key}

Path parameters

idstring*

No description

Body parameters

idstring*

Task ID, returned by the create task API on success

Response

Example:data:image/png

promptstring

Text prompt
Text description for video generation.
Note: The character length must not exceed 5000 characters

durationinteger

Video duration. Default values vary by model:

vidu2.0: default 4s, available: 4, 8

seedinteger

Random seed

Defaults to a random seed number
Manually set values will override the default random seed

resolutionstring

Resolution (based on model & duration):

vidu2.0 (4s): default 360p, options: 360p, 720p, 1080p
vidu2.0 (8s): default 720p, options: 720p

movement_amplitudestring

The movement amplitude of objects in the frame
Defaults to auto, accepted value: auto small medium large
Note: This parameter does not take effect when using the q2 & q3 model

bgmboolean

Whether to add background music to the generated video. Does not take effect for the q3 model.
Default: false. Acceptable values: true, false.

When true, the system will automatically select suitable music from the preset BGM library and add it; when not passed or false, no BGM will be added.
BGM has no duration limit and the system adapts automatically according to the video duration

payloadstring

transparent transmission parameters
No processing, only data transmission, with a maximum length of 1048576 characters

off_peakboolean

off peak mode, Defaults to false, enum:

true: off peak generate mode;
false: normal generate mode;
Note 1: The off peak mode consumes fewer credits, please refer to Pricing for details
Note 2: Tasks submitted in off peak mode will be generated within 48 hours. Tasks that cannot be completed will be automatically cancelled and their credits will be refunded;
Note 3: You can also manually cancel off peak tasks

watermarkboolean

Whether to add a watermark

true: add a watermark;
false: do not add a watermark;
Note: The watermark content is currently fixed and is generated by AI. No watermark is added by default

wm_positioninteger

Watermark position, indicating where the watermark appears in the image. Options:
1: top left
2: top right
3: bottom right
4: bottom left
Default: 3

wm_urlstring

Watermark content, which is an image URL here
When not passed, the default watermark is used: content generated by AI

meta_datastring

Metadata identifier, a JSON format string and transparent transmission field. You can use a custom format or the example format, as shown below:
{
"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 metadata identifier generated by Vidu is used by default

callback_urlstring

Callback
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).
Vidu uses a callback signature algorithm for verification, check out the details here: Callback Signature

200OKapplication/json

Response fields

idstring

Task ID

statestring

It will be returned to a specific processing state:

created created task successfully
queueing task in queue
processing processing
generation successful

200OKapplication/json

Response fields

task_idstring

Task ID

statestring

It will be returned to a specific processing state:

created created task successfully
queueing task in queue
processing processing
generation successful

failed task failed

err_codestring

Error code, see the error code table for details

creditsinteger

The number of credits consumed by this task (unit: credits)

payloadstring

The payload parameter passed in when this task was called

bgmboolean

Whether bgm is used in this task call

off_peakboolean

Whether off peak mode is used in this task call

creationsarray

Generation results

idstring

Creation ID, used to identify different creations

urlstring

URL of the generated result, valid for 24 hours

cover_urlstring

Cover of the generated result, valid for 24 hours

watermarked_urlstring

failed task failed

modelstring

The parameter of the model used for this call

promptstring

The text prompt used for this call

imagesstring

The image used for this call

durationinteger

The video duration parameter used for this call

seedinteger

The random seed parameter used for this call

resolutionstring

The resolution parameter used for this call

bgmboolean

The bgm parameter used for this call

audioboolean

Whether audio-video co-generation is used for this call

movement_amplitudestring

The camera movement amplitude parameter used for this call

payloadstring

The payload parameter used for this call

off_peakboolean

The off_peak parameter used for this call

creditsinteger

The credits used for this call

watermarkboolean

Whether a watermark is used for the task submitted in this call

created_atstring

Task creation time

URL of the watermarked generated result, valid for 24 hours

Request example

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": "vidu2.0",
  "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",
  "movement_amplitude": "auto",
  "bgm": true,
  "payload": "string",
  "off_peak": false,
  "watermark": true,
  "wm_position": 0,
  "wm_url": "string",
  "meta_data": "string",
  "callback_url": "string"
}'

200

Response example

{
  "task_id": "your_task_id_here",
  "state": "created",
  "model": "vidu2.0",
  "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"
}

Request example

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'

200

Response example

{
  "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"
    }
  ]
}

Features

Get started

About Us

Features

Get started

About Us

Vidu 2.0

Start-End to Video

Create Task

Query Creations

Headers

Body parameters

Headers

Path parameters

Body parameters

Response

Response

Search documentation

Features

Get started

About Us

Search documentation

Features

Get started

About Us

Vidu 2.0

Start-End to Video

Create Task

Query Creations

Headers

Body parameters

Headers

Path parameters

Body parameters

Response

Response