Skip to content

Vidu reference-to-video

Submit a subject-reference video generation task.

http
POST /vidu/ent/v2/reference2video

Available models

ModelDescription
Q3 flagship; direct audio/video output
Q2 Pro
Q2 turbo
Q2 Pro fast
Clear visuals, stable camera
Q1 classic
Version 2.0

Headers

NameTypeRequiredDescription
stringYesRequest authentication. Use a Bearer Token, for example: .
stringYesRequest content type; must be .

Request body

NameTypeRequiredDescription
stringYesModel name. See Available models above.
arrayYesSubject array. Multiple subjects supported; each has (subject ID), (image URLs for the subject, up to 3 per subject), and optional (voice ID). Use as the subject ID and reference it later with .
arrayYesSubject images. Note 1: Base64 or image URL. Note 2: formats png, jpeg, jpg, webp. Note 3: min 128×128 pixels; aspect ratio must be less extreme than 1:4 or 4:1; max 50 MB. Note 4: HTTP POST body max 20 MB; Base64 encoding must include a content-type prefix, for example: .
stringNoVoice ID for the video audio. Auto-recommended when empty. Enum values: new voice list, or use the voice-clone API to clone any voice; voice_id values are interchangeable.
stringNoText prompt. Text description of the video; reference subjects with . Ignored when recommended prompts are used.
booleanNoDirect audio/video output. : video with dialogue and ambient audio; : silent video.
stringNoVoice ID (global). Determines voice timbre; auto-recommended when empty. Note: ignored for q3 models.
booleanNoWhether to use recommended prompts. : system auto-recommends prompts; : generate from the input prompt.
booleanNoBackground music. : pick suitable music from the preset BGM library; : no BGM.
integerNoVideo duration in seconds. series: default 5s, range 1–10s.
integerNoRandom seed. Omit or pass 0 for a random seed; set manually to use a fixed seed.
stringNoResolution. Default depends on model and duration. (1–10s): default 720p; options 540p, 720p, 1080p.
booleanNoOff-peak mode. : generate during off-peak hours; : generate immediately.
booleanNoWhether to add a watermark. : add watermark; : no watermark.
integerNoWatermark position. : top-left; : top-right; : bottom-right; : bottom-left.
stringNoWatermark image URL. Default watermark when omitted: "AI-generated content".
stringNoPassthrough parameter. Not processed; transmitted as-is.
stringNoMetadata identifier. JSON string; passthrough field.

Request example

bash
curl -X POST https://octopusx.ai/vidu/ent/v2/reference2video \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '
{
  "model": "viduq3-pro",
  "subjects": [
    {
      "id": "subject_1",
      "images": ["https://example.com/subject.png"],
      "voice_id": "voice_001"
    }
  ],
  "prompt": "Make @subject_1 walk forward and smile",
  "audio": true,
  "is_rec": false,
  "bgm": false,
  "duration": 5,
  "seed": 0,
  "resolution": "720p"
}'

Response example

json
{
  "task_id": "48038932-0ff5-4251-8b4b-7a76c09fd114",
  "status": "processing",
  "created_at": 1774494511
}

Response fields

NameTypeDescription
stringTask ID, used to query task status.
stringTask status. Options: (in progress), (failed), (completed).
integerCreation timestamp (Unix timestamp).