Use Kling V3 with Comfy Router

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

API Reference for kling/kling-v3, 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

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

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",
        {
            "aspect_ratio": "16:9",
            "duration": "5",
            "mode": "std",
            "prompt": "A red fox trotting through falling snow, cinematic lighting.",
        },
    )

print(result)

Schema

Input

aspect_ratio · string · default: "\"16:9\""

Video aspect ratio

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

callback_url · string (uri)

The callback notification address

Format: uri

camera_control · object

camera_control.config · object

camera_control.config.horizontal · number

Controls camera’s movement along horizontal axis (x-axis). Negative indicates left, positive indicates right.

Range: -10 to 10

camera_control.config.pan · number

Controls camera’s rotation in vertical plane (x-axis). Negative indicates downward rotation, positive indicates upward rotation.

Range: -10 to 10

camera_control.config.roll · number

Controls camera’s rolling amount (z-axis). Negative indicates counterclockwise, positive indicates clockwise.

Range: -10 to 10

camera_control.config.tilt · number

Controls camera’s rotation in horizontal plane (y-axis). Negative indicates left rotation, positive indicates right rotation.

Range: -10 to 10

camera_control.config.vertical · number

Controls camera’s movement along vertical axis (y-axis). Negative indicates downward, positive indicates upward.

Range: -10 to 10

camera_control.config.zoom · number

Controls change in camera’s focal length. Negative indicates narrower field of view, positive indicates wider field of view.

Range: -10 to 10

camera_control.type · string

Predefined camera movements type. simple: Customizable camera movement. down_back: Camera descends and moves backward. forward_up: Camera moves forward and tilts up. right_turn_forward: Rotate right and move forward. left_turn_forward: Rotate left and move forward.

Possible values: simple, down_back, forward_up, right_turn_forward, left_turn_forward

cfg_scale · number · default: "0.5"

Flexibility in video generation. The higher the value, the lower the model’s degree of flexibility, and the stronger the relevance to the user’s prompt.

Range: 0 to 1

Format: float

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

Video length in seconds

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

external_task_id · string

Customized Task ID

mode · string · default: "\"std\""

Video generation mode. std: Standard Mode, which is cost-effective. pro: Professional Mode, generates videos with longer duration but higher quality output.

Possible values: std, pro

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.

negative_prompt · string

Negative text prompt. It is recommended to supplement negative prompt information through negative sentences directly within positive prompts.

prompt · string

Positive text prompt. Use <<<voice_1>>> to specify a voice matching the voice_list parameter order. A task can reference up to 2 tones. When specifying a tone, the sound parameter value must be on.

shot_type · string

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

Possible values: customize, intelligence

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

Whether to generate sound simultaneously when generating videos. Only V2.6 and subsequent versions of the model support this parameter.

Possible values: on, off

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/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": "std",
  "prompt": "A red fox trotting through falling snow, cinematic lighting."
}

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.