API reference · KwaiVGI

kwaivgi/kling-video/o3/standard/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 IDkwaivgi/kling-video/o3/standard/reference-to-video
01

Input Schema

9 parameters · 2 required · 7 optional

ParameterTypeRequiredDescription
imagestringRequiredImage to use as the first frame of the video.
promptstringRequiredText prompt for video generation. Either prompt or multi_prompt must be provided, but not both. · Max length: 2500
imagesstring[]OptionalReference images for style/appearance. Reference in prompt as @Image1, @Image2, etc. Maximum 4 total (elements + reference images) when using video.
durationintegerOptionalVideo duration in seconds (3-15s). · Options: 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15 · Default: 5
3456789101112131415
end_imagestringOptionalImage to use as the last frame of the video.
shot_typestringOptionalThe type of multi-shot video generation. 'intelligent' lets the model automatically determine shot structure. · Options: customize, intelligent · Default: "customize"
customizeintelligent
aspect_ratiostringOptionalThe aspect ratio of the generated image. · Options: 16:9, 9:16, 1:1
16:99:161:1
multi_promptobject[]OptionalList of prompts for multi-shot video generation.
generate_audiobooleanOptionalWhether to generate native audio for the video. · Default: false
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": "kwaivgi/kling-video/o3/standard/reference-to-video",
    "image": "https://static.sandbase.ai/examples/alibaba/wan/2.2/speech-to-video/input_image_0.png",
    "images": [
      "https://static.sandbase.ai/examples/alibaba/wan/2.2/speech-to-video/input_image_0.png"
    ],
    "prompt": "@Element1 and @Element2 is having dinner at this table on @Image1",
    "duration": 8,
    "shot_type": "customize",
    "generate_audio": false
  }),
});

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