API reference · KwaiVGI

kwaivgi/kling-video/v3

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/v3

Input Schema

13 parameters · 1 required · 12 optional

Parameter	Type	Required	Description
`prompt`	string	Required	Text prompt for video generation or transformation. When using reference media, refer to them as @Image1, @Image2, and @Video1. · Max length: 2500
`image`	string	Optional	Optional first-frame image URL for image-to-video.
`video`	string	Optional	Optional reference video URL for video-to-video generation.
`images`	string[]	Optional	Optional reference image URLs.
`duration`	integer	Optional	Generated video duration in seconds. · Options: 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15 · Default: 5 3456789101112131415
`end_image`	string	Optional	Optional end-frame image URL for image-to-video.
`shot_type`	string	Optional	Options: customize, intelligent · Default: "customize" customizeintelligent
`resolution`	string	Optional	Generation quality tier. · Options: standard, pro, 4k · Default: "standard" standardpro4k
`aspect_ratio`	string	Optional	Options: 16:9, 9:16, 1:1 · Default: "16:9" 16:99:161:1
`multi_prompt`	object[]	Optional	—
`generate_audio`	boolean	Optional	Default: true
`keep_original_sound`	boolean	Optional	Default: true
`character_orientation`	string	Optional	Options: image, video imagevideo

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": "kwaivgi/kling-video/v3",
    "image": "https://static.sandbase.ai/examples/mirrored/f77b827ca02a-TNErq9yD7ZxGRATjfAqnh_EIgJSN67.png",
    "video": "https://static.sandbase.ai/examples/mirrored/f1ecbb471a16-hklvF__w53diz6Rve7f5__JuDW2xl0mr6sJ_Kjz3Vxe_vidoeook--1-_1.mp4",
    "prompt": "Based on @Video1, make the character from @Image1 dance.",
    "duration": 5,
    "shot_type": "customize",
    "resolution": "standard",
    "aspect_ratio": "16:9",
    "generate_audio": true,
    "keep_original_sound": true,
    "character_orientation": "image"
  }),
});

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 Kling Video V3