Reference to Video

Q3 Create Task

POST/ent/v2/reference2video

Subjects-Reference to Video

How to create subjects: [https://platform.vidu.cn/docs/subjects](https://platform.vidu.cn/docs/subjects)

Subjects-Reference to Video

How to create subjects: [https://platform.vidu.cn/docs/subjects](https://platform.vidu.cn/docs/subjects)

Headers

Authorizationstring*

Replace {your api key} with your token

Example:Token {your api key}

Body parameters

modelstring*

Model name
Accepted values: viduq3-turbo

viduq3-turbo: Supports intelligent scene switching and simultaneous audio and video output, boasts the fastest generation speed, and offers the highest cost-effectiveness

Headers

Authorizationstring*

Replace {your api key} with your token

Example:Token {your api key}

Path parameters

idstring*

No description

Body parameters

idstring*

Task ID. Returned by the Create Task API upon successful creation.

Response

Headers

Authorizationstring*

No description

Example:Token <YOUR_API_KEY>

Body parameters

modelstring*

Model name
Accepted values: viduq3

viduq3: Supports intelligent camera switching, supports simultaneous audio and video output, and achieves superior consistency across multiple camera positions

imagesstring

Image reference supports multiple images. The model will use the subjects in the images provided in this parameter as references to generate a video with subject consistency. Different model versions support different numbers of reference images. Specific requirements are as follows:Note 1: The viduq3 series models support uploading 1 to 7 images.Note 2: Images can be provided via Base64 encoding or image URLs (make sure they are accessible).Note 3: Images must be in PNG, JPEG, JPG, or WebP format.Note 4: Image dimensions cannot be less than 128*128 pixels, and the aspect ratio must be less than 1:4 or 4:1.Note 5: Please note that the post body of the HTTP request must not exceed 20MB, 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

Headers

Authorizationstring*

Replace {your api key} with your token

Example:Token {your api key}

Body parameters

modelstring*

Model name. Accepted value: viduq3-mix. viduq3-mix: Strong visual quality, supports intelligent scene transitions, supports simultaneous audio and video output, with good dynamic effects and the strongest overall balance.

imagesstring

Headers

Authorizationstring*

Replace {your api key} with your token

Example:Token {your api key}

Path parameters

idstring*

Task ID returned after the task creation request succeeds

Response

Headers

Authorizationstring*

Replace {your api key} with your token

Example:Token {your api key}

Body parameters

modelstring*

Model name. Accepted value: viduq3-ad viduq3-ad: An industry fine-tuned model designed for advertising. Supports 1-7 image inputs, durations of 3-15 seconds, and 720p or 1080p resolution. For optimal results, avoid using overly similar input images.

imagesarray

Headers

Authorizationstring*

Replace {your api key} with your token

Example:Token {your api key}

Path parameters

idstring*

Task ID returned after the task creation request succeeds

Response

Request Body

modelstring*

Model name. Accepted value: viduq3-drama. viduq3-drama: An industry fine-tuned model designed for drama production. Supports 1-7 image inputs and durations of 2-16s.

auto_subjectsboolean

Whether to use the intelligent subject library capability. Defaults to false. Accepted values: true false. true: Use the intelligent subject library capability. false: Do not use the intelligent subject library capability.

Headers

Authorizationstring*

Replace {your api key} with your token

Example:Token {your api key}

Path parameters

idstring*

Task ID returned after the task creation request succeeds

Response

subjectsstring*

When using the q3, q2, q1, and 2.0 models, only image subjects and text subjects can be used.

The number of image or text subjects should not exceed 7.
When using the q2-pro model, video subjects, text subjects, and image subjects can be used.
The number of image or text subjects should not exceed 4.
The number of video subjects should not exceed 2 (or 1 for temporary video subjects).

namestring*

Subject name specified by the user. It can be used via [@name] during generation. For

Example:[@image1]normal

promptstring*

Text prompt
A textual description for video generation.
Note 1: The length cannot exceed 5000 characters.
Note 2: Use [@subjects_name] to represent subject content. For normal

Example:@1 and @2 are eating hot pot together, and the narrator says that everyone loves hot pot.

resolutionstring

Resolution parameter, with default values depending on the model and video duration:
viduq3-turbo (1-16s): Default is 720p, available options: 540p, 720p, 1080p

off_peakboolean

Off peak mode. Default: 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 their credits will be refunded.
Note 3: You can also manually cancel off-peak tasks.

watermarkboolean

Whether to add a watermark.

true: Add watermark.
false: Do not add watermark.
Note 1: Currently the watermark content is fixed as "Content generated by AI", and no watermark is added by default.
Note 2: You can obtain the watermarked video content through the watermarked_url parameter. See the Query Task API for details.

meta_datastring

Metadata label. A JSON-formatted string. Transparent transmission field. You can customize the format or use the example format as follows:
{
"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 label generated by Vidu is used by default.

callback_urlstring

Callback protocol
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 Query Task 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. See Callback Signature for details.

audioboolean

Whether to use the audio-video output capability. Default is true. Valid values:

false: Do not use audio-video output; outputs silent video.
true: Use audio-synchronized output; outputs video with sound (including dialogue and sound effects).
Note: In non-subject invocation, only the q3 models support this parameter.

resolutionstring

Resolution parameter, with default values depending on the model and video duration:
viduq3 (3-16s): Default is 720p, available options: 540p, 720p, 1080p

off_peakboolean

Off peak mode. Default: 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 their credits will be refunded.
Note 3: You can also manually cancel off-peak tasks.
Note 4: The viduq3 model supports off-peak tasks when the audio parameter is true.

callback_urlstring

Callback protocol
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 Query Task 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. See Callback Signature for details.

Image references support multiple images. The model uses the subjects in the images provided in this parameter as references to generate a video with consistent subjects. The supported number of images varies by model. Note 1: The viduq3-mix series supports uploading 1 to 7 images.
Note 2: Images can be provided as Base64-encoded data or image URLs. Ensure that the URLs are accessible.
Note 3: Supported image formats: PNG, JPEG, JPG, and WebP. Note 4: Image dimensions must be at least 128 x 128 pixels, and the aspect ratio must be less than 1:4 or 4:1. Note 5: The POST body of the HTTP request must not exceed 20MB, and the encoding must include an appropriate content type string. For base64,{base64_encode}normal

soundsstring

Audio references support uploading 1 to 3 audio files. The model uses the audio provided in this parameter as a reference to generate a video with consistent subjects.
Note 1: When using the audio reference feature, a maximum of 3 audio files can be uploaded. Each audio file must be 3-12 seconds long.
Note 2: Audio files must be in MP3 format.
Note 3: Each audio file must not exceed 50MB. Note 4: The byte length after Base64 decoding must be less than 20MB, and the encoding must include an appropriate content type string. For base64,{base64_encode}normal

Example:data:video/mp3

aspect_ratiostring

Defaults to 16:9. Accepted values: 1:1 9:16 16:9 3:4 4:3. auto: Automatically recommends an aspect ratio based on the input image or video.

resolutionstring

Resolution parameter. Default values depend on the model and video duration. viduq3-mix (3-16 seconds): Default is 720p, available options: 720p and 1080p.

callback_urlstring

Callback protocol. 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 Query Task API. The status in the callback response 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. For details, see Callback Signature.

Image references support multiple images. The model uses the subjects in the images provided in this parameter as references to generate a video with consistent subjects. The supported number of images varies by model. Details are as follows:
Note 1: The viduq3-ad series supports uploading 1 to 7 images.
Note 2: Images can be provided as Base64-encoded data or image URLs. Ensure that the URLs are accessible.
Note 3: Supported image formats: PNG, JPEG, JPG, and WebP.
Note 4: Image dimensions must be at least 128 x 128 pixels, and the aspect ratio must be less than 1:4 or 4:1.
Note 5: The POST body of the HTTP request must not exceed 20MB, and the encoding must include an appropriate content type string. For base64,{base64_encode}normal

soundsstring

Example:data:video/mp3

aspect_ratiostring

Defaults to 16:9. Accepted values: 1:1 9:16 16:9 3:4 4:3 auto: Automatically recommends an aspect ratio based on the input image or video

off_peakboolean

Off-peak mode. Defaults to false. Accepted values: true false - true: Generate the video during off-peak hours. - false: Generate the video immediately. - Note 1: Off-peak mode consumes fewer credits. For details, see product 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 the credits for the task will be refunded. - Note 3: You can also manually cancel off-peak tasks.

callback_urlstring

Callback protocol. 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 Query Task API. The status in the callback response 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. For details, see Callback Signature.

namestring*

The subject name specified by the user. During generation, it can be used in the format [@name], for example: [@image1].

imagesarray

Temporary subject images. Each temporary subject supports up to 3 images. Note 1: Images can be provided as Base64-encoded data or image URLs. Ensure that the URLs are accessible.
Note 2: Supported image formats: PNG, JPEG, JPG, and WebP.
Note 3: Image dimensions must be at least 128 x 128 pixels, and the aspect ratio must be less than 1:4 or 4:1.
Note 4: The POST body of the HTTP request must not exceed 20MB, and the encoding must include an appropriate content type string. For example: data:image/png;base64,{base64_encode}

videosarray

Temporary subject video. Supports at most one 5-second video. Note 1: Only the viduq2-pro model for reference-to-video supports video subjects. Note 2: Supports uploading at most one 5-second video. Note 3: Supported video formats: MP4, AVI, and MOV. Note 4: Video dimensions must be at least 128 x 128 pixels, and the aspect ratio must be less than 1:4 or 4:1. Note 5: The byte length after Base64 decoding must be less than 20MB, and the encoding must include an appropriate content type string. For example:

promptstring*

Text prompt for video generation. Note 1: The maximum length is 5000 characters. Note 2: Use [@subjects_name] to represent subject content. For example: "[@1] and [@2] are eating hot pot together, and the narration says everyone loves hot pot."

audioboolean

Whether to use audio-video output capability. Defaults to false. Accepted values: true false. true: Use audio-video output capability. false: Do not use audio-video output capability.

aspect_ratiostring

viduq3-drama (8-12s): Default is 1080p. Defaults to 16:9. Accepted values: 1:1 9:16 16:9 3:4 4:3. auto: Automatically recommends an aspect ratio based on the input image or video.

resolutionstring

Resolution parameter. Default values depend on the model and video duration.
viduq3-turbo (1-16 seconds): Default is 720p, available options: 540p, 720p, 1080p.
viduq3 (3-16 seconds): Default is 720p, available options: 540p, 720p, 1080p.
viduq2-pro and viduq2 (1-10 seconds): Default is 720p, available options: 540p, 720p, 1080p.
viduq1 (5 seconds): Default is 1080p, available option: 1080p.
vidu2.0 (4 seconds): Default is 360p, available options: 360p, 720p.

off_peakboolean

Off-peak mode. Defaults to false. Accepted values: true false. true: Generate the video during off-peak hours. false: Generate the video immediately. Note 1: Off-peak mode consumes fewer credits. For details, see product 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 the credits for the task will be refunded. Note 3: You can also manually cancel off-peak tasks.

callback_urlstring

Headers

Authorizationstring*

Replace {your api key} with your token

Example:Token {your api key}

Body parameters

modelstring*

Model name. Accepted value: viduq3-drama. viduq3-drama: An industry fine-tuned model designed for drama production. Supports 1-7 image inputs, durations of 2-15s, and 1080p resolution.

imagesarray

Image references support multiple images. The model uses the subjects in the images provided in this parameter as references to generate a video with consistent subjects. The supported number of images varies by model. Note 1: The viduq3-drama series supports uploading 1 to 7 images. Note 2: Images can be provided as Base64-encoded data or image URLs. Ensure that the URLs are accessible.
Note 3: Supported image formats: PNG, JPEG, JPG, and WebP.
Note 4: Image dimensions must be at least 128 x 128 pixels, and the aspect ratio must be less than 1:4 or 4:1.
Note 5: The POST body of the HTTP request must not exceed 20MB, and the encoding must include an appropriate content type string. For base64,{base64_encode}normal

Example:data:image/png

imagesstring

Temporary subject images. Up to 3 images.
Note 1: Images can be provided via Base64 encoding or image URLs (make sure they are accessible).
Note 2: Images must be in PNG, JPEG, JPG, or WebP format.
Note 3: Image dimensions cannot be less than 128*128 pixels, and the aspect ratio must be less than 1:4 or 4:1.
Note 4: Please note that the post body of the HTTP request must not exceed 20MB, and the encoding must include an appropriate content type string. For base64,{base64_encode}normal

Example:data:image/png

videosstring

Temporary subject video. Up to one 5-second video.
Note 1: Only the viduq2-pro Reference to Video model supports video subjects.
Note 2: Up to one 5-second video can be uploaded.
Note 3: Videos must be in MP4, AVI, or MOV format.
Note 4: Video dimensions cannot be less than 128*128 pixels, and the aspect ratio must be less than 1:4 or 4:1.
Note 5: Please note that the byte length after base64 decoding must be less than 20M, and the encoding must include an appropriate content type string. For base64,{base64_encode}normal

Example:data:video/mp4

voice_idstring

Voice ID
Used to determine the voice character in the video. When empty, the system will automatically recommend one. For optional enumeration values, refer to the Voice List.
Or you can use the Voice Cloning API to clone any voice. The voice_id parameters can be used interchangeably.

voice_idarray

Voice ID, used to determine the voice character in the video. If empty, the system will automatically recommend one. For accepted values, see the New Voice List. You can also use the Voice Cloning API to clone any voice. The voice_id parameter can be used interchangeably.

server_idstring

Subject ID obtained through the Create Subject API.
Note: If server_id is not provided, the subject is treated as a temporary subject and will not be saved by the system.

soundsarray

Example:data:video/mp3

aspect_ratiostring

Defaults to 16:9. Accepted values: 9:16 16:9. auto: Automatically recommends an aspect ratio based on the input image or video.

audioboolean

Whether to use audio-video output capability. Defaults to true. Accepted values: true false. false: Outputs a silent video without direct audio-video output. true: Outputs a video with synchronized audio and visuals, including dialogue and sound effects. Note: For non-subject invocation, only the q3 model supports this parameter.

off_peakboolean

Off-peak mode. Defaults to false. Accepted values: true false. true: Generate the video during off-peak hours. false: Generate the video immediately.
Note 1: Off-peak mode consumes fewer credits. For details, see product 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 the credits for the task will be refunded. Note 3: You can also manually cancel off-peak tasks.

callback_urlstring

200OKapplication/json

Response fields

idstring

Task ID

statestring

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

err_codestring

200OKapplication/json

Response fields

idstring

Task ID

statestring

Processing status. Available values: created: Task created successfully. queueing: Task is in the queue. processing: Task is being processed. success: Task completed successfully. failed: Task failed.

err_codestring

200OKapplication/json

Response fields

idstring

Task ID

statestring

Processing status Available values: - created: Task created successfully - queueing: Task is in the queue - processing: Task is being processed - success: Task completed successfully - failed: Task failed

err_codestring

200OKapplication/json

Response fields

idstring

Task ID

statestring

err_codestring

creationsarray

Generation results

idstring

Generation ID. Used to identify different generations.

urlstring

Generation URL. Valid for 24 hours.

cover_urlstring

Generation cover. Valid for 24 hours.

watermarked_urlstring

creationsarray

Generated results

idstring

Generated result ID, used to identify different generated results

urlstring

Generated result URL, valid for 24 hours

cover_urlstring

Generated result cover URL, valid for 24 hours

watermarked_urlstring

creationsarray

Generated results

idstring

Generated result ID, used to identify different generated results

urlstring

Generated result URL, valid for 24 hours

cover_urlstring

Generated result cover URL, valid for 24 hours

watermarked_urlstring

creationsarray

Generated results

idstring

Generated result ID, used to identify different generated results

urlstring

Generated result URL, valid for 24 hours

cover_urlstring

Generated result cover URL, valid for 24 hours

watermarked_urlstring

200OKapplication/json

Response fields

task_idstring

Task ID generated by Vidu

statestring

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

modelstring

200OKapplication/json

Response fields

idstring

Task ID

statestring

Processing state
Accepted values:
created 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

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

modelstring

200OKapplication/json

Response fields

task_idstring

Task ID generated by Vidu

statestring

modelstring

200OKapplication/json

Response fields

task_idstring

Task ID generated by Vidu

statestring

Processing status - created: Task created successfully - queueing: Task is in the queue - processing: Task is being processed - success: Task completed successfully - failed: Task failed

modelstring

200OKapplication/json

Response fields

task_idstring

Task ID generated by Vidu

statestring

modelstring

200OKapplication/json

Response fields

task_idstring

Task ID generated by Vidu

statestring

modelstring

creationsarray

Generation results

idstring

Generation ID. Used to identify different generations.

urlstring

Generation URL. Valid for 24 hours.

cover_urlstring

Generation cover. Valid for 24 hours.

watermarked_urlstring

Request example

curl --request POST \
  --url 'https://api.vidu.com/ent/v2/reference2video' \
  --header 'Authorization: Token {your api key}' \
  --header 'Content-Type: application/json' \
  --data '{
  "model": "viduq3-turbo",
  "auto_subjects": true,
  "subjects": {
    "name": "[@image1]normal",
    "images": "data:image/png",
    "videos": "data:video/mp4",
    "voice_id": "string",
    "server_id": "string"
  },
  "prompt": "@1 and @2 are eating hot pot together, and the narrator says that everyone loves hot pot.",
  "audio": true,
  "duration": 8,
  "seed": 0,
  "aspect_ratio": "3:4",
  "resolution": "1080p",
  "payload": "string",
  "off_peak": true,
  "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": "viduq3-turbo",
  "images": [""],
  "prompt": "[@1] and [@2] are eating hot pot together at [@3]",
  "duration": 5,
  "seed": random_number,
  "aspect_ratio": "3:4",
  "resolution": "720p",
  "audio": true,
  "payload":"",
  "off_peak": false,
  "credits":credits_number,
  "created_at": "2025-01-01T15:41:31.968916Z"
}

{
  "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/reference2video-1.png","https://prod-ss-images.s3.cn-northwest-1.amazonaws.com.cn/vidu-maas/template/reference2video-2.png","https://prod-ss-images.s3.cn-northwest-1.amazonaws.com.cn/vidu-maas/template/reference2video-3.png"],
  "prompt": "Santa Claus and the bear hug by the lakeside.",
  "duration": 5,
  "seed": random_number,
  "aspect_ratio": "3:4",
  "resolution": "540p",
  "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}' \
  --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"
    }
  ]
}

Request example

curl --request POST \
  --url 'https://api.vidu.com/ent/v2/reference2video' \
  --header 'Authorization: Token <YOUR_API_KEY>' \
  --header 'Content-Type: application/json' \
  --data '{
  "model": "viduq3",
  "images": "data:image/png",
  "prompt": "Santa Claus and the bear hug by the lakeside.",
  "duration": 5,
  "seed": 0,
  "aspect_ratio": "3:4",
  "audio": true,
  "resolution": "1080p",
  "payload": "string",
  "off_peak": true,
  "callback_url": "string"
}'

200

Response example

{
  "task_id": "your_task_id_here",
  "state": "created",
  "model": "viduq3",
  "images": ["https://prod-ss-images.s3.cn-northwest-1.amazonaws.com.cn/vidu-maas/template/reference2video-1.png","https://prod-ss-images.s3.cn-northwest-1.amazonaws.com.cn/vidu-maas/template/reference2video-2.png","https://prod-ss-images.s3.cn-northwest-1.amazonaws.com.cn/vidu-maas/template/reference2video-3.png"],
  "prompt": "Santa Claus and the bear hug by the lakeside.",
  "duration": 5,
  "seed": random_number,
  "aspect_ratio": "3:4",
  "resolution": "540p",
  "payload":"",
  "credits":credits_number,
  "created_at": "2025-01-01T15:41:31.968916Z"
}

{
  "task_id": "your_task_id_here",
  "state": "created",
  "model": "viduq3",
  "images": [""],
  "prompt": "[@1] and [@2] are eating hot pot together at [@3]",
  "duration": 5,
  "seed": random_number,
  "aspect_ratio": "3:4",
  "resolution": "720p",
  "audio": true,
  "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}'

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/reference2video' \
  --header 'Authorization: Token {your api key}' \
  --header 'Content-Type: application/json' \
  --data '{
  "model": "viduq3-mix",
  "images": "data:image/png",
  "sounds": "data:video/mp3",
  "prompt": "Santa Claus and the bear hug by the lakeside.",
  "duration": 5,
  "seed": 0,
  "aspect_ratio": "3:4",
  "resolution": "1080p",
  "payload": "string",
  "callback_url": "string"
}'

200

Response example

{
          "task_id": "your_task_id_here",
          "state": "created",
          "model": "viduq3-mix",
          "images": ["https://prod-ss-images.s3.cn-northwest-1.amazonaws.com.cn/vidu-maas/template/reference2video-1.png","https://prod-ss-images.s3.cn-northwest-1.amazonaws.com.cn/vidu-maas/template/reference2video-2.png","https://prod-ss-images.s3.cn-northwest-1.amazonaws.com.cn/vidu-maas/template/reference2video-3.png"],
          "prompt": "Santa Claus and the bear hug by the lakeside.",
          "duration": 5,
          "seed": random_number,
          "aspect_ratio": "3:4",
          "resolution": "540p",
          "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/reference2video' \
  --header 'Authorization: Token {your api key}' \
  --header 'Content-Type: application/json' \
  --data '{
  "model": "viduq3-ad",
  "images": "data:image/png",
  "sounds": "data:video/mp3",
  "prompt": "Santa Claus and the bear hug by the lakeside.",
  "duration": 5,
  "seed": 0,
  "aspect_ratio": "3:4",
  "resolution": "1080p",
  "payload": "string",
  "off_peak": true,
  "callback_url": "string"
}'

200

Response example

{
          "task_id": "your_task_id_here",
          "state": "created",
          "model": "viduq3-ad",
          "images": ["https://prod-ss-images.s3.cn-northwest-1.amazonaws.com.cn/vidu-maas/template/reference2video-1.png","https://prod-ss-images.s3.cn-northwest-1.amazonaws.com.cn/vidu-maas/template/reference2video-2.png","https://prod-ss-images.s3.cn-northwest-1.amazonaws.com.cn/vidu-maas/template/reference2video-3.png"],
          "prompt": "Santa Claus and the bear hug by the lakeside.",
          "duration": 5,
          "seed": random_number,
          "aspect_ratio": "3:4",
          "resolution": "540p",
          "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/reference2video' \
  --header 'Authorization: Token {your api key}' \
  --header 'Content-Type: application/json' \
  --data '{
  "model": "viduq3-drama",
  "images": "data:image/png",
  "sounds": "data:video/mp3",
  "prompt": "Santa Claus and the bear hug by the lakeside.",
  "duration": 5,
  "seed": 0,
  "aspect_ratio": "3:4",
  "audio": true,
  "resolution": "1080p",
  "payload": "string",
  "off_peak": true,
  "callback_url": "string"
}'

200

Response example

{
          "task_id": "your_task_id_here",
          "state": "created",
          "model": "viduq3-drama",
          "images": ["https://prod-ss-images.s3.cn-northwest-1.amazonaws.com.cn/vidu-maas/template/reference2video-1.png","https://prod-ss-images.s3.cn-northwest-1.amazonaws.com.cn/vidu-maas/template/reference2video-2.png","https://prod-ss-images.s3.cn-northwest-1.amazonaws.com.cn/vidu-maas/template/reference2video-3.png"],
          "prompt": "Santa Claus and the bear hug by the lakeside.",
          "duration": 5,
          "seed": random_number,
          "aspect_ratio": "3:4",
          "resolution": "540p",
          "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"
    }
  ]
}

json

{
          "task_id": "your_task_id_here",
          "state": "created",
          "model": "viduq3-drama",
          "images": [""],
          "prompt": "[@1] and [@2] are eating hot pot together at [@3]",
          "duration": 5,
          "seed": random_number,
          "aspect_ratio": "3:4",
          "resolution": "720p",
          "audio": true,
          "payload":"",
          "off_peak": false,
          "credits":credits_number,
          "created_at": "2025-01-01T15:41:31.968916Z"
        }

Search documentation

Features

Get started

About Us

Search documentation

Features

Get started

About Us

Vidu Q3

Reference to Video

Q3 Turbo Create Task

Q3 Turbo Query Creations

Q3 Create Task

Subjects-Reference to Video

Q3 Query Creations

Q3 Mix Create Task

Q3 Mix Query Creations

Q3 Ad Create Task

Q3 Ad Query Creations

Q3 Drama Create Task