Use Kling V3 Omni with Comfy Router

Call kling/kling-v3-omni through Comfy Router: endpoint, request shape and the response Router returns.

API Reference for kling/kling-v3-omni, served by Comfy Router from Kling.

Quick start

Create a key at platform.comfy.org/profile/api-keys and export it as COMFY_API_KEY. The Python and TypeScript snippets use the Comfy SDKs (pip install comfy-sdk, npm install @comfyorg/sdk); the cURL snippet is the same call over raw HTTP.

Model ID: kling/kling-v3-omni

Endpoint: POST https://api.comfy.org/v2/models/kling/kling-v3-omni

Python

from comfy_sdk import Comfy

# Reads COMFY_API_KEY from the environment. Each call sends a fresh
# Idempotency-Key and waits up to 10 minutes for the finished result.
with Comfy() as client:
    result = client.models.run(
        "kling/kling-v3-omni",
        {
            "aspect_ratio": "16:9",
            "duration": "5",
            "mode": "pro",
            "prompt": "A paper boat drifting down a rain-soaked street at dusk.",
        },
    )

print(result)

Schema

Input

aspect_ratio · string

The aspect ratio of the generated video frame (width:height). Required when first-frame reference or video editing features are not used.

Possible values: 16:9, 9:16, 1:1

callback_url · string (uri)

The callback notification address for the result of this task. If configured, the server will actively notify when the task status changes.

Format: uri

duration · string · default: "\"5\""

Video Length in seconds. When using video editing function (refer_type: base), output duration is the same as input video and this parameter is invalid.

Possible values: 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15

element_list · object[]

Reference Element List based on element ID configuration.

element_list[].element_id · integer · required

Element ID

Format: int64

external_task_id · string

Customized Task ID. Must be unique within a single user account.

image_list · object[]

Reference Image List. Can include reference images of the element, scene, style, etc., or be used as the first or last frame to generate videos.

image_list[].image_url · string

Image Base64 encoding or image URL (ensure accessibility). Supported formats include .jpg/.jpeg/.png. File size cannot exceed 10MB. Width and height dimensions shall not be less than 300px, aspect ratio between 1:2.5 ~ 2.5:1.

image_list[].type · string

Whether the image is in the first or last frame. first_frame is the first frame, end_frame is the last frame. Currently does not support only the end frame.

Possible values: first_frame, end_frame

mode · string · default: "\"pro\""

Video generation mode. std: Standard Mode, generating 720P videos, cost-effective. pro: Professional Mode, generating 1080P videos, higher quality video output.

Possible values: pro, std

model_name · string

Model name. Omit it or send null when using Comfy Router; the model is selected by the request path. A supplied name must match that path.

multi_prompt · object[]

Information about each storyboard, such as prompts and duration. Supports up to 6 storyboards, with a minimum of 1. Required when multi_shot is true and shot_type is customize.

multi_prompt[].duration · string

Duration of this storyboard in seconds. Must not exceed total task duration and must not be less than 1. Sum of all storyboard durations equals total task duration.

multi_prompt[].index · integer

Shot sequence number

multi_prompt[].prompt · string

Prompt word for this storyboard. Maximum length 512 characters.

multi_shot · boolean · default: "false"

Whether to generate multi-shot video. When true, the prompt parameter is invalid. When false, the shot_type and multi_prompt parameters are invalid.

prompt · string

Text prompt words, which can include positive and negative descriptions. Must not exceed 2,500 characters. Can specify elements, images, or videos in the format <<<>>> such as <<element_1>>, <<<image_1>>>, <<<video_1>>>.

shot_type · string

Storyboard method. Required when the multi_shot parameter is set to true.

Possible values: customize, intelligence

sound · string · default: "\"off\""

Whether sound is generated simultaneously when generating videos.

Possible values: on, off

video_list · object[]

Reference Video list. Can be used as a reference video for feature or as a video to be edited, with the default being the video to be edited.

video_list[].keep_original_sound · string

Whether to keep the video original sound. yes indicates retention, no indicates non retention.

Possible values: yes, no

video_list[].refer_type · string

Reference video type. feature is the feature reference video, base is the video to be edited.

Possible values: feature, base

video_list[].video_url · string · required

URL of uploaded video. Only .mp4/.mov formats are supported. Duration between 3-10 seconds. Resolution must be between 720px and 2160px. Frame rates of 24-60 fps supported. Only 1 video can be uploaded, with size not exceeding 200MB.

watermark_info · object

Whether to generate watermarked results simultaneously. Custom watermark is not supported at this time.

watermark_info.enabled · boolean

true means generate watermark, false means do not generate.

Generated from the schema Router serves at GET /v2/models/kling/kling-v3-omni/openapi.json, the same document it validates a call against before the request reaches the provider.

Output

code · integer

Error code

data · object

data.created_at · integer

Task creation time, Unix timestamp in milliseconds

data.final_unit_deduction · string

The deduction units of task

data.task_id · string

Task ID

data.task_info · object

data.task_info.external_task_id · string

data.task_result · object

data.task_result.videos · object[]

data.task_result.videos[].duration · string

Total video duration in seconds

data.task_result.videos[].id · string

Generated video ID

data.task_result.videos[].url · string (uri)

URL for generated video

Format: uri

data.task_result.videos[].watermark_url · string (uri)

URL for generated video with watermark, hotlink protection format

Format: uri

data.task_status · string

Task Status

Possible values: submitted, processing, succeed, failed

data.task_status_msg · string

Task status information, displaying the failure reason when the task fails

data.updated_at · integer

Task update time, Unix timestamp in milliseconds

data.watermark_info · object

data.watermark_info.enabled · boolean

message · string

Error message

request_id · string

Request ID

Examples

Input

{
  "aspect_ratio": "16:9",
  "duration": "5",
  "mode": "pro",
  "prompt": "A paper boat drifting down a rain-soaked street at dusk."
}

Output

{
  "code": 0,
  "data": {
    "created_at": 1798761600000,
    "task_id": "kling-task-1a2b3c4d5e6f",
    "task_result": {
      "videos": [
        {
          "duration": "5",
          "id": "kling-video-6f5e4d3c2b1a",
          "url": "https://example.invalid/kling/kling-v1/generated.mp4"
        }
      ]
    },
    "task_status": "succeed",
    "task_status_msg": "",
    "updated_at": 1798761840000
  },
  "message": "SUCCEED",
  "request_id": "9f2c1a04-7b6e-4d38-8a51-3c0e7d9b2f46"
}

Before you ship

The snippets above are the shortest working call. Three things are the same for every model and are documented once on the Comfy Router headers page: send an Idempotency-Key on every paid call and reuse it when you retry, expect the connection to be held up to Router’s 10 minute deadline, and keep X-Comfy-Request-Id from every response. The SDKs do all three for you; the cURL tab does none of them. On failure, X-Comfy-Error-Type names the bucket, and a 422 means the body failed the model’s schema and was never billed.

Headers

Authentication, idempotency, request IDs, error buckets, retry pacing, spend limits.

Quick Start

Typed error handling in Python and TypeScript, reading the 422, walking the catalog.

Limitations

What Router does not do today, and what to use instead.