API reference · Vidu

vidu/q2/image-to-video/pro

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/q2/image-to-video/pro
01

Input Schema

8 parameters · 2 required · 6 optional

ParameterTypeRequiredDescription
imagestringRequiredURL of the image to use as the starting frame
promptstringRequiredText prompt for video generation, max 3000 characters · Max length: 3000
bgmbooleanOptionalWhether to add background music to the video (only for 4-second videos) · Default: false
seedintegerOptionalRandom seed for reproducibility. If None, a random seed is chosen.
durationintegerOptionalDuration of the video in seconds · Options: 2, 3, 4, 5, 6, 7, 8 · Default: 4
2345678
end_imagestringOptionalURL of the image to use as the ending frame. When provided, generates a transition video between start and end frames.
resolutionstringOptionalOutput video resolution · Options: 720p, 1080p · Default: "720p"
720p1080p
movement_amplitudestringOptionalThe movement amplitude of objects in the frame · Options: auto, small, medium, large · Default: "auto"
autosmallmediumlarge
02

Output Schema

FieldTypeDescription
idstringUnique identifier for the generation task
statusstringTask status: pending, running, completed, failed, timeout
modelstringModel used for the generation
outputsarrayArray of output items
outputs[].urlstringURL of the generated artifact
outputs[].content_typestringMIME type (e.g. image/png, video/mp4)
errorobject | nullError details if failed, null on success
error.typestringMachine-readable error type code
error.messagestringHuman-readable error description

Async Workflow

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

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

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/q2/image-to-video/pro",
    "bgm": false,
    "image": "https://static.sandbase.ai/examples/shengshu/vidu/q2/image-to-video/pro/input_image_0.webp",
    "prompt": "A woman walking through a vibrant city street at night, neon lights reflecting off wet pavement.",
    "duration": 4,
    "resolution": "720p",
    "movement_amplitude": "auto"
  }),
});

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);