Image to Video

On this page

API

What you imagine is what Vidu

platform@vidu.com

Features

Templates Text to Video Image to Video Start End to Video Reference to Video Real-time Video

Get started

Quickstart Pricing Help Center

About Us

Company

Headers

Authorizationstring*

Replace {your api key} with your API key

Example:Token {your api key}

Body parameters

modelstring*

Model name

viduq3-turbo: Compared to viduq3-pro, the generation speed is faster

imagesarray*

The start frame imageThe model will use the image provided in this parameter as the start frame to generate the video.Note 1: Accepts Base64-encoded image or image URL (make sure it is accessible).Note 2: Only accepts 1 image.Note 3: Supported formats: png, jpeg, jpg, webp.Note 4: The aspect ratio of the image must be less than 1:4 or 4:1.Note 5: The image size is limited to 50MB.Note 6: The byte length after Base64 decode must be less than 10MB, and the encoding must include an appropriate content type string, for base64,{base64_encode}normal

Headers

Authorizationstring*

Replace {your api key} with your API key

Example:Token {your api key}

Path parameters

idstring*

Task id
The id is returned upon the successful creation of a task by the Start Generating API

Response

Headers

Authorizationstring*

Replace {your api key} with your API key

Example:Token {your api key}

Body parameters

modelstring*

Model name

viduq3-pro-fast: Efficiently generate high-quality audio and video content with faster generation speed and high cost-effectiveness

imagesarray*

An image to be used as the start frame of the generated video. The model will use the image provided via this parameter as the first frame to generate the video.Note 1: Accepts Base64-encoded image or image URL (ensure it is accessible).Note 2: Only 1 image is accepted.Note 3: Supported image formats: png, jpeg, jpg, webp.Note 4: The aspect ratio of the image must be less than 1:4 or 4:1.Note 5: The image size must not exceed 50MB.Note 6: Note that the byte length after base64 decode must be less than 10MB, and the encoding must contain an appropriate content type string. For base64,{base64_encode}normal

Headers

Authorizationstring*

Replace {your api key} with your API key

Example:Token {your api key}

Path parameters

idstring*

Task ID, returned by the Create Task API upon successful creation

Response

Headers

Authorizationstring*

Replace {your api key} with your token

Example:Token {your api key}

Body parameters

modelstring*

Model name

viduq3-pro-fast: Efficiently generate high-quality audio and video content, with faster generation speed and high cost-effectiveness

imagesarray*

Start frame image
The model will use the image passed in this parameter as the start frame to generate the video.Note 1: Supports passing a Base64-encoded image or an image URL (ensure it is accessible);Note 2: Only 1 image is supported;Note 3: Supported image formats: png, jpeg, jpg, webp;Note 4: The aspect ratio of the image must be less than 1:4 or 4:1;Note 5: The image size must not exceed 50 MB;Note 6: Please note that the byte length after base64 decode must be less than 10M, and the encoding must include an appropriate content type string, for base64,{base64_encode}normal

Headers

Authorizationstring*

Replace {your api key} with your token

Example:Token {your api key}

Path parameters

idstring*

Task ID, returned by the Create Task API upon successful creation

Response

promptstring

Text prompt
A textual description for video generation, with a maximum length of 20000 characters.
Note: If the is_rec parameter for recommended prompts is used, the model will ignore the prompt entered in this parameter.

audioboolean

Whether to use direct audio-video generation capability. Default: true. Enumerated values:

false: No direct audio-video generation, outputs silent video
true: Direct audio-video generation required, outputs video with dialogue and background sound
Note 1: The voice_id parameter takes effect only when this parameter is true
Note 2: When this parameter is true, off-peak mode is not supported

is_recboolean

Whether to use the recommended prompt.

true: System will automatically recommend a prompt and use its content to generate the video.
false: The video will be generated based on user input prompt.

off_peakboolean

Off-peak mode. Default: false. Accepted values:

true: Generate the video in off-peak mode
false: Generate the video immediately
Note 1: Off-peak mode consumes fewer credits. For details, see Pricing.
Note 2: Tasks submitted in off-peak mode will be generated within 48 hours. Tasks that are not completed will be automatically cancelled and their credits will be refunded.
Note 3: You can also manually cancel off-peak tasks.

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 Creation 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

promptstring

Text prompt
A textual description for video generation.
Note 1: Maximum length of 20000 characters.
Note 2: If the is_rec recommended prompt parameter is used, the model will ignore the prompt entered for this parameter.

audioboolean

Whether to use direct audio-video generation capability. Default: true. Enumerated values:

false: No direct audio-video generation, outputs silent video
true: Direct audio-video generation required, outputs video with dialogue and background sound
Note 1: The voice_id parameter takes effect only when this parameter is true
Note 2: When this parameter is true, off-peak mode is not supported

is_recboolean

Whether to use the recommended prompt.

true: System will automatically recommend a prompt and use its content to generate the video.
false: The video will be generated based on user input prompt.

off_peakboolean

off peak mode, Defaults to false, accepted value: true false

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

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

promptstring

Text prompt
A text description of the video to be generated.
Note 1: The length must not exceed 20000 characters
Note 2: If the is_rec recommended prompt parameter is used, the model will ignore the prompt entered in this parameter

audioboolean

Whether to use the direct audio-video generation capability. Default is true. Enumerated values:

false: No direct audio-video generation, outputs silent video
true: Direct audio-video generation required, outputs video with dialogue and background sound
Note 1: The voice_id parameter takes effect only when this parameter is true
Note 2: When this parameter is true, off peak mode is not supported

is_recboolean

Whether to use the recommended prompt.

true: System will automatically recommend a prompt and use its content to generate the video.
false: The video will be generated based on user input prompt.

off_peakboolean

Off peak mode. Default is false. Accepted values:

true: Generate video in off peak mode;
false: Generate video immediately;
Note 1: Off peak mode consumes fewer credits, see Pricing for details
Note 2: Tasks submitted in off peak mode will be generated within 48 hours. Tasks that are not completed will be automatically cancelled and the credits for that task will be refunded;
Note 3: You can also manually cancel off peak tasks

callback_urlstring

Callback protocol
You need to actively set the callback_url when creating a task. The request method is POST. When the status of the video generation task changes, Vidu will send a callback request containing the latest status of the task to this address. The structure of the callback request content is the same as the return body of the Query Task API
The "status" returned by the callback includes the following states:

processing Task is being processed
success Task is completed (if sending fails, the callback will be retried three times)
failed Task failed (if sending fails, the callback will be retried three times)
Vidu uses a callback signature algorithm for authentication, see Callback Signature for details

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

idstring

Task ID

statestring

Processing state
Accepted values:
created created successfully
queueing task in queue
processing processing
success generation successful
failed task failed

err_codestring

200OKapplication/json

Response fields

idstring

Task ID

statestring

Processing state
Accepted values:
created Task created successfully
queueing Task in queue
processing Task is being processed
success Task succeeded
failed Task failed

err_codestring

200OKapplication/json

Response fields

task_idstring

Task ID generated by Vidu

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

200OKapplication/json

Response fields

task_idstring

Task ID generated by Vidu

statestring

Processing state
Accepted values:
created Task created successfully
queueing Task in queue
processing Task is being processed
success Task succeeded
failed Task failed

modelstring

The model name used for this call

promptstring

The prompt parameter used for this call

creationsarray

Generated results

idstring

Creation id, used to identify different creations

urlstring

The URL of the generated results, valid for 24 hours

cover_urlstring

The cover URL of the generated results, valid for 24 hours

watermarked_urlstring

creationsarray

Generation results

idstring

Generation ID, used to identify different creations

urlstring

Creation URL, valid for 24 hours

cover_urlstring

Creation cover, valid for 24 hours

watermarked_urlstring

creationsarray

Generated results

idstring

Creation ID, used to identify different creations

urlstring

Creation URL, valid for 24 hours

cover_urlstring

Creation cover, valid for 24 hours

watermarked_urlstring

Request example

curl --request POST \
  --url 'https://api.vidu.com/ent/v2/img2video' \
  --header 'Authorization: Token {your api key}' \
  --header 'Content-Type: application/json' \
  --data '{
  "model": "viduq3-turbo",
  "images": "data:image/png",
  "prompt": "The astronaut waved and the camera moved up.",
  "audio": true,
  "is_rec": true,
  "duration": 5,
  "seed": 0,
  "resolution": "1080p",
  "payload": "string",
  "off_peak": true,
  "callback_url": "string"
}'

200

Response example

{
  "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/image2video.png"],
  "prompt": "The astronaut waved and the camera moved up.",
  "duration": 5,
  "seed": random_number,
  "resolution": "1080p",
  "payload":"",
  "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}'

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

Request example

curl --request POST \
  --url 'https://api.vidu.com/ent/v2/img2video' \
  --header 'Authorization: Token {your api key}' \
  --header 'Content-Type: application/json' \
  --data '{
  "model": "viduq3-pro",
  "images": "data:image/png",
  "prompt": "The astronaut waved and the camera moved up.",
  "audio": true,
  "is_rec": true,
  "duration": 5,
  "seed": 0,
  "resolution": "1080p",
  "payload": "string",
  "off_peak": true,
  "callback_url": "string"
}'

200

Response example

{
  "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/image2video.png"],
  "prompt": "The astronaut waved and the camera moved up.",
  "duration": 5,
  "seed": random_number,
  "resolution": "1080p",
  "payload":"",
  "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}'

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

Request example

curl --request POST \
  --url 'https://api.vidu.com/ent/v2/img2video' \
  --header 'Authorization: Token {your api key}' \
  --header 'Content-Type: application/json' \
  --data '{
  "model": "viduq3-pro-fast",
  "images": "data:image/png",
  "prompt": "The astronaut waved and the camera moved up.",
  "audio": true,
  "is_rec": true,
  "duration": 5,
  "seed": 0,
  "resolution": "1080p",
  "payload": "string",
  "off_peak": true,
  "callback_url": "string"
}'

200

Response example

{
  "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/image2video.png"],
  "prompt": "The astronaut waved and the camera moved up.",
  "duration": 5,
  "seed": random_number,
  "resolution": "1080p",
  "payload":"",
  "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}'

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 Q3

Q3 Turbo Create Task

Q3 Turbo Query Creations

Q3 Pro Create Task

Q3 Pro Query Creations

Q3 Pro Fast Create Task

Q3 Pro Fast Query Creations

Headers

Body parameters

Headers

Path parameters

Response

Headers

Body parameters

Headers

Path parameters

Response

Headers

Body parameters

Headers

Path parameters

Response

Response

Response

Response

Search documentation

Features

Get started

About Us

Search documentation

Features

Get started

About Us

Vidu Q3

Image to Video

Q3 Turbo Create Task

Q3 Turbo Query Creations

Q3 Pro Create Task

Q3 Pro Query Creations

Q3 Pro Fast Create Task

Q3 Pro Fast Query Creations

Headers

Body parameters

Headers

Path parameters

Response

Headers

Body parameters

Headers

Path parameters

Response

Headers

Body parameters

Headers

Path parameters

Response

Response

Response

Response