API reference · KwaiVGI

kwaivgi/kling-image/o1

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

IMAGEAsyncOpen 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-image/o1

Input Schema

6 parameters · 1 required · 5 optional

Parameter	Type	Required	Description
`prompt`	string	Required	Text prompt for image generation. Reference images using @Image1, @Image2, etc. (or @Image if only one image). Max 2500 characters. · Max length: 2500
`images`	string[]	Optional	List of reference images. Reference images in prompt using @Image1, @Image2, etc. (1-indexed). Max 10 images.
`elements`	object[]	Optional	Elements (characters/objects) to include in the image. Reference in prompt as @Element1, @Element2, etc. Maximum 10 total (elements + reference images).
`resolution`	string	Optional	Image generation resolution. 1K: standard, 2K: high-res. · Options: 1K, 2K · Default: "1K" 1K2K
`aspect_ratio`	string	Optional	The aspect ratio of the generated image. · Options: 21:9, 16:9, 3:2, 4:3, 5:4, 1:1, 4:5, 3:4, 2:3, 9:16 21:916:93:24:35:41:14:53:42:39:16
`output_format`	string	Optional	The format of the generated image. · Options: jpeg, png · Default: "png" jpegpng

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

# Step 1: Submit
curl -X POST https://api.sandbase.ai/v1/run \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '{
  "model": "kwaivgi/kling-image/o1",
  "images": [
    "https://static.sandbase.ai/examples/kwaivgi/kling-image/o1/input_images_0.png",
    "https://static.sandbase.ai/examples/kwaivgi/kling-image/o1/input_images_1.png"
  ],
  "prompt": "Put @Image1 to the back seat of the car in @Image2, put @Element1 on to the @Image1",
  "elements": [
    {
      "frontal_image_url": "https://storage.googleapis.com/falserverless/example_inputs/kling-image-o1/element-1-front.png",
      "reference_image_urls": [
        "https://storage.googleapis.com/falserverless/example_inputs/kling-image-o1/element-1-reference.png"
      ]
    }
  ],
  "resolution": "1K",
  "output_format": "png"
}'

# Step 2: Poll result (replace <id>)
curl https://api.sandbase.ai/v1/run/<id> \
  -H "Authorization: Bearer YOUR_API_KEY"

← Back to Kling O1 Image