Skip to content

Vidu video generation

Submit an async video task with Vidu models.

http
POST /v1/videos

Available models

ModelDescription
Q3 flagship; direct audio/video output
Q2 Pro
Q2 turbo

Headers

NameTypeRequiredDescription
stringYesRequest authentication. Use a Bearer Token, for example: .

Request body

NameTypeRequiredDescription
stringYesModel name. See Available models above.
stringYesText prompt. Text description of the video. Ignored when recommended prompts are used.
fileNoReference image. Upload a single image for image-to-video. Base64 or image URL (must be accessible). Only one image; formats png, jpeg, jpg, webp. Aspect ratio must be less extreme than 1:4 or 4:1; max size 50 MB.
stringNoAspect ratio. Options: (default), , , , . Note: and are only supported on q2 and q3 models.
booleanNoWhether to use direct audio/video output. : silent video; : video with dialogue and ambient audio.
stringNoVoice ID; ignored for q3 models. Determines voice timbre; auto-recommended when empty.
booleanNoWhether to use recommended prompts. : system auto-recommends prompts and generates from them (count=1); : generate from the input prompt.
booleanNoWhether to add background music. : pick suitable music from the preset BGM library; : no BGM.
integerNoVideo duration in seconds. viduq2 series default 5; options 1–10.
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. 1–10s: default 720p; options 540p, 720p, 1080p.
stringNoPassthrough parameter. Not processed; transmitted as-is.
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 content as an image URL. Default watermark when omitted: AI-generated content.
stringNoMetadata identifier; JSON string; passthrough field.

Request example

bash
curl -X POST https://octopusx.ai/v1/videos \
  -H "Authorization: Bearer <token>" \
  -F "model=viduq3-pro" \
  -F "prompt=A cat chasing butterflies on the grass" \
  -F "aspect_ratio=16:9" \
  -F "duration=5"
bash
curl -X POST https://octopusx.ai/v1/videos \
  -H "Authorization: Bearer <token>" \
  -F "model=viduq3-pro" \
  -F "prompt=Make the person walk forward and smile" \
  -F "aspect_ratio=9:16" \
  -F "duration=5" \
  -F "images=@/path/to/image.png"

Response example

json
{
  "id": "video_123",
  "object": "video",
  "model": "viduq3-pro",
  "status": "queued",
  "progress": 0,
  "created_at": 1712697600,
  "size": "1024x1808",
  "seconds": "5",
  "quality": "standard"
}

Response fields

NameTypeDescription
stringTask ID.
stringAlways .
stringModel name.
stringTask status. Options: (queued), (in progress), (completed), (failed), (cancelled).
integerProgress percentage (0–100).
integerCreation time (Unix timestamp).
stringVideo dimensions, for example .
stringVideo duration in seconds.
stringVideo quality, for example .