API reference · Vidu

vidu/q4/reference-to-video

Integrate this model through SandBase's unified API, with production-ready schemas and examples.

VIDEOAsyncOpen model

Production endpoint

Send your first request

OpenAI-compatible endpoint with unified authentication and usage tracking.

POSThttps://api.sandbase.ai/v1/run

Model IDvidu/q4/reference-to-video

Input Schema

8 parameters · 2 required · 6 optional

Parameter	Type	Required	Description
`prompt`	string	Required	Text prompt for video generation, max 5000 characters. Refer to references by position: [@reference_image_1], [@reference_image_2], ... for images and [reference_audio_1], [reference_audio_2], ... for audio clips. · Min length: 1 · Max length: 5000
`reference_image_urls`	string[]	Required	URLs of 1 to 12 reference images (png, jpeg, jpg, webp) used to keep characters, products, objects, or locations consistent.
`seed`	integer	Optional	Random seed for reproducibility. If None, a random seed is chosen.
`audio`	boolean	Optional	Whether to generate audio (dialogue and sound effects) with the video. When false, the output video is silent. · Default: true
`duration`	integer	Optional	Duration of the video in seconds (3-16) · Min: 3 · Max: 16 · Default: 5
`resolution`	string	Optional	Output video resolution. Sets the per-second rate. · Options: 540p, 720p, 1080p, 2K, 4K · Default: "720p" 540p720p1080p2K4K
`aspect_ratio`	string	Optional	The aspect ratio of the output video. · Options: 16:9, 9:16, 4:3, 3:4, 1:1 · Default: "16:9" 16:99:164:33:41:1
`reference_audio_urls`	string[]	Optional	URLs of up to 3 mp3 reference audio clips (3-12 seconds each, max 50 MB) used to keep voices consistent.

Output Schema

Field	Type	Description
`id`	string	Unique identifier for the generation task
`status`	string	Task status: pending, running, completed, failed, timeout
`model`	string	Model used for the generation
`outputs`	array	Array of output items
`outputs[].url`	string	URL of the generated artifact
`outputs[].content_type`	string	MIME type (e.g. image/png, video/mp4)
`error`	object \| null	Error details if failed, null on success
`error.type`	string	Machine-readable error type code
`error.message`	string	Human-readable error description

Async Workflow

This model uses asynchronous execution. Submit a request and poll for the result.

Submit — POST to /v1/run, receive an id
Poll — GET /v1/run/{id} until status is completed, failed, or timeout
Retrieve — Read outputs from the completed response

Code Examples

Ready-to-run snippets

const apiKey = process.env.SANDBASE_API_KEY;
const response = await fetch("https://api.sandbase.ai/v1/run", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${apiKey}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "model": "vidu/q4/reference-to-video",
    "audio": true,
    "prompt": "[@reference_image_1] walks along the beach at sunset holding [@reference_image_2], then turns to the camera and smiles.",
    "duration": 5,
    "resolution": "720p",
    "aspect_ratio": "16:9",
    "reference_image_urls": [
      "https://storage.googleapis.com/falserverless/web-examples/vidu/new-examples/reference1.png",
      "https://storage.googleapis.com/falserverless/web-examples/vidu/new-examples/reference2.png"
    ]
  }),
});

if (!response.ok) throw new Error(await response.text());
let result = await response.json();
for (let attempt = 0; attempt < 120 && !["completed", "failed", "timeout"].includes(result.status); attempt++) {
  await new Promise((resolve) => setTimeout(resolve, 2_000));
  const poll = await fetch(`https://api.sandbase.ai/v1/run/${result.id}`, {
    headers: { Authorization: `Bearer ${apiKey}` },
  });
  if (!poll.ok) throw new Error(await poll.text());
  result = await poll.json();
}
if (result.status !== "completed") throw new Error(`Generation ended: ${result.status}`);
console.log(result);

← Back to Vidu Q4 Reference to Video