Kling 3.0 Omni Pro Video Reference API Reference

Request body

Submit an async generation request. The model field selects the model; other fields are model-specific input parameters.

stringmodelrequired

Model identifier. Set to kwaivgi/kling-video/3.0/omni/pro/video-to-video/reference.

Default: kwaivgi/kling-video/3.0/omni/pro/video-to-video/reference

stringpromptrequired

Use @Element1, @Element2 to reference elements and @Image1, @Image2 to reference images in order.

Optional<array<string>>images

Reference images for style/appearance. Reference in prompt as @Image1, @Image2, etc. Maximum 4 total (elements + reference images) when using video.

stringvideorequired

Reference video URL. Only .mp4/.mov formats supported, 3-10 seconds duration, 720-2160px resolution, max 200MB. Max file size: 200.0MB, Min width: 720px, Min height: 720px, Max width: 2160px, Max height: 2160px, Min duration: 3.0s, Max duration: 10.05s, Min FPS: 24.0, Max FPS: 60.0, Timeout: 30.0s

Optional<integer>duration

Video duration in seconds.

Allowed values: 3, 4, 5, 6, 7, 8, 9, 10

Default: 5

Optional<array<object>>elements

Elements (characters/objects) to include. Reference in prompt as @Element1, @Element2, etc. Maximum 4 total (elements + reference images) when using video.

Optional<boolean>keep_audio

Whether to keep the original audio from the video.

Default: false

Optional<string>aspect_ratio

The aspect ratio of the generated image.

Allowed values: 16:9, 9:16, 1:1

Response Schema

The submit endpoint returns a run response. If its status is pending or running, poll GET /v1/run/{id} with the returned opaque ID until it reaches a terminal state.

stringidrequired

Opaque SandBase run identifier. Use it exactly as returned; no prefix is guaranteed.

stringstatusrequired

Current public run status.

Allowed values: pending, running, completed, failed, timeout

Optional<string>model

Public SandBase model name used for this run.

Optional<array<object>>outputs

Present only for completed runs. Each object is capability-specific; inspect the selected model schema for its fields.

Optional<object>error

Present only for failed or timeout runs. Contains a public error type and sanitized message.

Optional<string>error.type

Stable public error category.

Optional<string>error.message

Sanitized error message safe to show to clients.

Optional<object>usage

Usage details when available.

Model capabilities

array<string>capability_tagsrequired

Capabilities declared by the model registry.

Default: video-to-video

stringexecution_moderequired

Execution mode declared by the model registry.

Default: async

# 1. Submit a generation request curl -X POST https://api.sandbase.ai/v1/run \ -H "Authorization: Bearer $SANDBASE_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "model": "kwaivgi/kling-video/3.0/omni/pro/video-to-video/reference", "prompt": "Based on @Video1, generate the next shot. keep the style of the video", "video": "https://static.sandbase.ai/examples/kwaivgi/kling-video/omni/pro/video-to-video/reference/output_url_0.mp4", "duration": 5, "aspect_ratio": "16:9" }' # 2. If the response is still running, poll the returned id curl https://api.sandbase.ai/v1/run/f3d2e8a1-7c4b-4a12-9d2e-123456789abc \ -H "Authorization: Bearer $SANDBASE_API_KEY"