v1

latestOpenAPI 3.0.22026-07-2610288167.4 KB
API Nodes
Released

post/proxy/vidu/reference2video

Request body

aspect_ratiostring
audioboolean

Enable direct audio-video generation capability (default true for q3 model)

audio_type'all' | 'speech_only' | 'sound_effect_only'

Audio type when audio is true: all (sound effects + vocals), speech_only, sound_effect_only. Ineffective for q3 model

bgmboolean

Add background music to generated video (ineffective for q3 model)

callback_urlstring

Callback URL for task status updates

durationinteger

Video duration in seconds. viduq3-pro: 1-16, viduq2-pro-fast: 1-10, viduq2-pro/turbo: 1-8

enhanceboolean
imagesstring[]

Images for img2video (accepts 1 image as start frame)

is_recboolean

Use recommended prompt (consumes additional 10 credits)

meta_datastring

Metadata identification, JSON format string for custom metadata

modelstring

Model name: viduq3-pro, viduq2-pro-fast, viduq2-pro, viduq2-turbo, viduq1, viduq1-classic, vidu2.0

movement_amplitude'auto' | 'small' | 'medium' | 'large'

Movement amplitude of objects in frame (ineffective for q2, q3 models)

off_peakboolean

Off peak mode (lower cost, tasks generated within 48 hours)

payloadstring

Transparent transmission parameters (max 1048576 characters)

priorityinteger
promptstring

Text prompt for video generation (max 2000 characters)

resolutionstring

Resolution: 360p, 540p, 720p, 1080p, 2K (availability depends on model and duration)

seedinteger

Random seed (defaults to random if not specified)

style'general' | 'anime'
voice_idstring

Voice ID for audio (ineffective for q3 model)

watermarkboolean

Add watermark to video (default false)

wm_positioninteger

Watermark position: 1 (top left), 2 (top right), 3 (bottom right, default), 4 (bottom left)

wm_urlstring

Watermark image URL (uses default watermark if not provided)

Response

OK

aspect_ratiostring
bgmboolean

Whether background music was added

created_atstring date-time
creditsinteger required
durationinteger
imagesstring[]
modelstring
movement_amplitude'auto' | 'small' | 'medium' | 'large'
off_peakboolean

Off peak mode status

payloadstring

Transparent transmission parameters

promptstring
resolutionstring
seedinteger
state'created' | 'processing' | 'queueing' | 'success' | 'failed' required
style'general' | 'anime'
task_idstring required
watermarkboolean

Whether watermark was added