Use Kling Image O1 with Comfy Router

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

API Reference for kling/kling-image-o1, served by Comfy Router from Kling.

Quick start

Create a key in your Comfy workspace 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-image-o1

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

Python

from comfy_sdk import Comfy

# Reads COMFY_API_KEY from the environment.
# The SDK automatically creates an idempotency key and reuses it for automatic retries.
with Comfy() as client:
    result = client.models.run(
        "kling/kling-image-o1",
        {
            "aspect_ratio": "1:1",
            "n": 1,
            "prompt": "A watercolour koi pond at dawn, soft light.",
            "resolution": "1k",
        },
    )

print(result)

Schema

Input

aspect_ratio · string · default: "\"auto\""

Aspect ratio of the generated images (width:height). auto is to intelligently generate images based on incoming content.

Possible values: 16:9, 9:16, 1:1, 4:3, 3:4, 3:2, 2:3, 21:9, auto

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

element_list · object[]

Reference Element List based on element ID configuration. The sum of reference elements and reference images shall not exceed 10.

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. Supports inputting 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. The sum of reference elements and reference images shall not exceed 10.

image_list[].image · string · required

Image Base64 encoding or image URL (ensure accessibility)

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.

n · integer · default: "1"

Number of generated images. Value range [1,9].

Range: 1 to 9

prompt · string · required

Text prompt words, which can include positive and negative descriptions. Must not exceed 2,500 characters. The Omni model can achieve various capabilities through Prompt with elements and images. Specify an image in the format of <<<>>>, such as <<<image_1>>>.

resolution · string · default: "\"1k\""

Image generation resolution. 1k is 1K standard, 2k is 2K high-res, 4k is 4K high-res.

Possible values: 1k, 2k, 4k

result_type · string · default: "\"single\""

Control whether to generate a single image or a series of images.

Possible values: single, series

series_amount · integer · default: "4"

Number of images in a series. Value range [2,9].

Range: 2 to 9

Generated from the schema Router serves at GET /v2/models/kling/kling-image-o1/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

Customer-defined task ID

data.task_result · object

data.task_result.images · object[]

data.task_result.images[].index · integer

Image Number (0-9)

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

URL for generated image

Format: uri

data.task_result.result_type · string

Whether the result is a single image or a series of images

Possible values: single, series

data.task_result.series_images · object[]

Series images result list

data.task_result.series_images[].index · integer

Series-image sequence number

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

URL for generated image

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 (such as triggering the content risk control of the platform, etc.)

data.updated_at · integer

Task update time, Unix timestamp in milliseconds

message · string

Error message

request_id · string

Request ID

Examples

Input

{
  "aspect_ratio": "1:1",
  "n": 1,
  "prompt": "A watercolour koi pond at dawn, soft light.",
  "resolution": "1k"
}

Output

{
  "code": 0,
  "data": {
    "created_at": 1798761600000,
    "task_id": "kling-image-task-3c4d5e6f7a8b",
    "task_result": {
      "images": [
        {
          "index": 0,
          "url": "https://example.invalid/kling/kling-image-o1/generated.png"
        }
      ],
      "result_type": "single"
    },
    "task_status": "succeed",
    "task_status_msg": "",
    "updated_at": 1798761660000
  },
  "message": "SUCCEED",
  "request_id": "6a4b2c80-1e93-4d57-b8f2-05c7e9a3d146"
}

Before you ship

The SDKs create an Idempotency-Key and reuse it for automatic retries. For manual retries, reuse the original key. Router can hold the connection for up to 10 minutes.

When a request fails, Router sends an X-Comfy-Error-Type response header explaining why. A 422 means Router rejected the input before calling the provider. Download generated assets promptly because result URLs can expire.

Headers

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

Using the Router API

Model discovery, validation errors, retries, and billing.

Limitations

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