Skip to main content
API Reference for kling/kling-image-4.0, served by Comfy Router from Kling. Input: Text, Image · Output: Image

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 and npm install @comfyorg/sdk); the cURL snippet is the same call over raw HTTP. Model ID: kling/kling-image-4.0 Endpoint: POST https://api.comfy.org/v2/models/kling/kling-image-4.0
The same body, sent to POST https://api.comfy.org/v2/models/kling/kling-image-4.0/requests. Router answers 201 with a request_id as soon as the run is admitted, and the result is collected once it is ready, from this process or another one. Queued delivery walks through status, cancellation and collection.

Schema

Input

object[]
required
The prompt and up to 10 reference images and elements.
string
Element ID, when type is “element”. Only multi-image elements are supported.
string
Reference ID for this input, used as @id in the prompt. Must be unique within the task.
string
Text prompt, when type is “prompt”. Up to 50,000 English characters or 21,000 non-English characters. Reference other inputs as @id.
string
required
Input type. One of “prompt”, “refer_image” or “element”. A prompt item is required. Up to 10 reference images and elements in total.Possible values: prompt, refer_image, element
string
Image URL or Base64 data, when type is “refer_image”. Images are .jpg, .jpeg or .png up to 30MB, at least 300px per side, with an aspect ratio between 2:5 and 5:2.
object
General configuration such as watermark options. options.callback_url and options.external_task_id are not supported on Kling 4.0; Comfy Router refuses a request that sets either inside options. A top-level callback_url or external_task_id is not part of this schema and is removed before the request reaches Kling.
object
Whether to generate watermarked results simultaneously. Custom watermarks are not supported. An explicit null is treated as absent, as the /proxy Kling 4.0 check and Kling do.
boolean
true means generate watermarked result, false means do not generate. Default false.
object
Output configuration such as result type, image count, resolution and aspect ratio.
string
Aspect ratio (width:height) of the generated images. Default “auto”, which follows the input.Possible values: 16:9, 9:16, 1:1, 4:3, 3:4, 3:2, 2:3, 21:9, auto
integer
Number of independent images in single mode, 1 through 9. Default 1. Ignored in series mode.Range: 1 to 9
string
Output resolution. One of “2k”, “4k” or “8k”. Default “2k”.Possible values: 2k, 4k, 8k
string
One of “single” (independent images, counted by n) or “series” (a related set, counted by series_amount). Default “single”.Possible values: single, series
integer | `auto`
Number of images in a series, 2 through 10, or “auto” to let Kling choose 2 to 10 from the input. Default 4. Used only in series mode.Range: 2 to 10
Generated from the schema Router serves at GET /v2/models/kling/kling-image-4.0/openapi.json, the same document it validates a call against before the request reaches the provider.

Output

integer
Error code. 0 indicates success.
object[]
Tasks matching the query.
object[]
Billing details for the task.
string
Consumption amount, accurate to two decimal places.
string
Cash account the charge was drawn from (only present when charge_type is “cash”), for example “balance”. Some tasks return it; others may omit it.
string
Consumption account type. “cash” for balance, “unit” for a resource package.
string
ISO 4217 currency code of amount and list_price, for example “USD”. Some tasks return it; others may omit it.
string
List price of the task before any discount, as a decimal string. Some tasks return it; others may omit it.
string
Consumable resource bundle type (only present when charge_type is “unit”). One of “video”, “image” or “audio”.
integer
Task creation time. Unix timestamp in milliseconds.Format: int64
string
The custom task ID for this task, if any.
string
The task ID.
string
Task status information, displaying the failure reason when the task fails.
object[]
Generated outputs for the task.
string
Duration of the generated video in seconds.
string
Grouping marker, present only for grouped images.
string
Output ID generated by the system.
string
Duration of the generated MP3 audio in seconds.
string
MP3 URL of the generated audio (hotlink-protected).
string
Name of the generated material.
string
Source of the material. “kling” denotes the official library; numbers are creator IDs.
string
Status of the material. One of “succeeded” or “deleted”.
string
Output content type. One of “video”, “image”, “audio”, “voice” or “element”.
string
URL of the generated result (hotlink-protected). Cleared after 30 days.
string
URL of the watermarked result (hotlink-protected).
string
Duration of the generated WAV audio in seconds.
string
WAV URL of the generated audio (hotlink-protected).
string
Task status. One of “submitted”, “processing”, “succeeded” or “failed”.
integer
Task update time. Unix timestamp in milliseconds.Format: int64
string
Error message.
string
Request ID generated by the system.

Examples

Input

Output

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, and a 413 means the request body was larger than Router accepts. Download generated assets promptly because result URLs can expire. Any size limit named in a field description above is the provider’s own bound on that field, quoted from the provider’s specification. Router applies a separate cap to the whole request body, which base64-encoded media counts against: see request body size. This page documents one partner model called through Comfy Router. The same comfy-sdk / @comfyorg/sdk package also ships a second client, for running a whole ComfyUI workflow graph on Comfy Cloud: Comfy(api_key=...) / new Comfy({ apiKey }), with client.workflows, client.assets and client.jobs. See Comfy SDKs.

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.