Skip to main content
POST

Authorizations

Authorization
string
header
required

Pass Authorization: Bearer <token> in the request header.

Body

application/json
model
enum<string>
required

Model name. Available value: viduq4-preview

  • viduq4-preview: Vidu's latest flagship model (preview), supports referencing 1-15 images and 0-3 audio files
Available options:
viduq4-preview
images
string[]
required

Supports multiple images. The model generates a video with subject consistency based on the subjects in the images provided. Requirements: Note 1: viduq4-preview model supports uploading 1-15 images; Note 2: Supports image Base64 encoding or image URL (ensure accessibility); Note 3: Supports png, jpeg, jpg, webp formats, max 50MB per image; Note 4: http request post body must not exceed 20MB, and encoding must include an appropriate content-type string, e.g.: data:image/png;base64,{base64_encode}

Required array length: 1 - 15 elements
prompt
string
required

Text prompt for video generation. Note: Character length must not exceed 20000 characters

Maximum string length: 20000
sounds
string[]

Supports uploading 0-3 audio files. The model uses the audio provided as reference to generate a video with subject consistency. Note 1: Each reference audio duration range is 3-12s; Note 2: Supports mp3 format; Note 3: Each audio file must not exceed 50MB; Note 4: http request post body must not exceed 20MB, and encoding must include an appropriate content-type string, e.g.: data:video/mp3;base64,{base64_encode}

Maximum array length: 3
audio
boolean
default:true

Whether to use audio-visual direct output

  • false: no audio-visual direct output, outputs a silent video
  • true: requires audio-visual sync, outputs a video with sound (including dialogue and sound effects) Note: viduq4-preview model default is true
duration
integer
default:5

Video duration parameter Default: 5 Enum: 3 - 16

Required range: 3 <= x <= 16
seed
integer

Random seed. When not provided or set to 0, a random number is used; when manually set, the configured seed is used.

aspect_ratio
enum<string>
default:16:9

Video aspect ratio parameter Default: 16:9 Enum: 1:1 / 9:16 / 16:9 / 3:4 / 4:3

Available options:
16:9,
9:16,
1:1,
3:4,
4:3
resolution
enum<string>

Video resolution parameter Default: 720p Enum: 540p / 720p / 1080p / 2K / 4K Note: viduq4-preview supports 2K and 4K video output

Available options:
540p,
720p,
1080p,
2K,
4K
payload
string

Passthrough parameter, no processing, only data transmission. Note: maximum 1048576 characters.

Maximum string length: 1048576
watermark
boolean
default:false

Whether to add watermark

  • true: add watermark
  • false: no watermark Note: Currently watermark content is fixed and AI-generated; not added by default
wm_position
enum<integer>
default:3

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

Available options:
1,
2,
3,
4
Required range: 1 <= x <= 4
wm_url
string

Watermark content. This is an image URL; when not provided, the default watermark (AI-generated content) is used.

meta_data
string

Metadata identifier, a JSON format string passthrough field. You can customize the format or use the example format below: { "Label": "your_label","ContentProducer": "your_content_producer","ContentPropagator": "your_content_propagator","ProduceID": "your_product_id", "PropagateID": "your_propagate_id","ReservedCode1": "your_reserved_code1", "ReservedCode2": "your_reserved_code2" } When this parameter is empty, the Vidu-generated metadata identifier is used by default.

callback_url
string

Callback protocol You need to actively set callback_url when creating a task. The request method is POST. When the video generation task changes status, Vidu will send a callback request containing the latest task status to this address. The callback request body structure is consistent with the query task API response body. The "status" returned by the callback includes the following states:

  • processing: task is being processed
  • success: task completed (if sending fails, callback retries three times)
  • failed: task failed (if sending fails, callback retries three times) Vidu uses a callback signature algorithm for authentication, see: https://platform.vidu.cn/docs/callback-signature

Response

Submission successful, returns a video task object.

task_id
string

Task ID generated by Vidu.

state
enum<string>

Processing state Available values: created: task created successfully queueing: task in queue processing: task being processed success: task succeeded failed: task failed

Available options:
created,
queueing,
processing,
success,
failed
model
string

Model name used for this call.

prompt
string

Prompt parameter used for this call.

images
string[]

Image parameter used for this call.

sounds
string[]

The sound parameter for this call

duration
integer

Video duration parameter used for this call.

seed
integer

Random seed parameter used for this call.

resolution
string

Resolution parameter used for this call.

payload
string

Passthrough parameter passed in for this call.

credits
integer

Number of credits consumed for this call.

watermark
boolean

Whether a watermark was used for this task submission.

created_at
string<date-time>

Task creation time.