使用 Comfy Router 调用 Kling Image O1
通过 Comfy Router 调用 kling/kling-image-o1:端点、请求结构以及 Router 返回的响应。
使用 Comfy Router 调用 Kling Image O1
通过 Comfy Router 调用 kling/kling-image-o1:端点、请求结构以及 Router 返回的响应。
kling/kling-image-o1 的 API 参考,该模型来自 Kling,由 Comfy Router 提供服务。
输入: 文本, 图像 · 输出: 图像
快速开始
在你的 Comfy 工作区中创建一个密钥,并将其导出为 COMFY_API_KEY。Python 和 TypeScript 代码片段使用 Comfy SDK(pip install comfy-sdk 和 npm install @comfyorg/sdk);cURL 代码片段则是通过原始 HTTP 发起的相同调用。
模型 ID:kling/kling-image-o1
端点:POST https://api.comfy.org/v2/models/kling/kling-image-o1
[tab] 等待结果 ``python Python theme={null} from comfy_sdk import Comfy # 从环境变量中读取 COMFY_API_KEY。 # SDK 会自动创建幂等键,并在自动重试时复用它。 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)``typescript TypeScript theme={null} import { comfy } from "@comfyorg/sdk"; // 从环境变量中读取 COMFY_API_KEY。 // SDK 会自动创建幂等键,并在自动重试时复用它。 const { data } = await comfy.models.run("kling/kling-image-o1", { aspect_ratio: "1:1", n: 1, prompt: "A watercolour koi pond at dawn, soft light.", resolution: "1k", }); console.log(data);``bash cURL theme={null} curl https://api.comfy.org/v2/models/kling/kling-image-o1 \ -H "X-API-Key: $COMFY_API_KEY" \ -H "Idempotency-Key: $(uuidgen)" \ -H "Content-Type: application/json" \ -d "{\"aspect_ratio\": \"1:1\", \"n\": 1, \"prompt\": \"A watercolour koi pond at dawn, soft light.\", \"resolution\": \"1k\"}"``
[tab] 加入队列,稍后收集 将相同的请求体发送到POST https://api.comfy.org/v2/models/kling/kling-image-o1/requests。运行一经受理,Router 就会立即返回201和request_id;结果就绪后,可从本进程或其他进程进行收集。状态、取消与收集的完整流程见 队列投递。 ``python Python theme={null} import asyncio from comfy_sdk import AsyncComfy # 从环境变量中读取 COMFY_API_KEY。 # 每次调用 submit() 都会生成自己的 Idempotency-Key,并在自动重试时复用它。 async def main(): async with AsyncComfy() as client: handle = await client.models.submit( "kling/kling-image-o1", { "aspect_ratio": "1:1", "n": 1, "prompt": "A watercolour koi pond at dawn, soft light.", "resolution": "1k", }, ) print("request_id:", handle.request_id) # 配合模型 ID,就是另一个进程所需的全部信息 # 轮询直到请求完成,等待服务器指定的 Retry-After。 async for update in handle.iter_events(): print(update.status, update.queue_position) # 提供商自身的负载,与 models.run() 返回的值相同。 # 失败或已取消的请求会在此处抛出带类型的 Router 错误。 result = await handle.get() print(result) asyncio.run(main())``typescript TypeScript theme={null} import { comfy } from "@comfyorg/sdk"; // 从环境变量中读取 COMFY_API_KEY。 // 每次调用 submit() 都会生成自己的 Idempotency-Key,并在自动重试时复用它。 const handle = await comfy.models.submit("kling/kling-image-o1", { aspect_ratio: "1:1", n: 1, prompt: "A watercolour koi pond at dawn, soft light.", resolution: "1k", }); console.log("requestId:", handle.requestId); // 配合模型 ID,就是另一个进程所需的全部信息 // 轮询直到请求完成,等待服务器指定的 Retry-After。 for await (const update of handle.events()) { console.log(update.status, update.queuePosition); } // 与 models.run() 返回的结果相同。失败或已取消的请求会在此处被拒绝。 const result = await handle.get(); console.log(result.data);``bash cURL theme={null} # 1. 提交。Router 返回 201,并附带 request_id、status_url、response_url 和 cancel_url。 curl https://api.comfy.org/v2/models/kling/kling-image-o1/requests \ -H "X-API-Key: $COMFY_API_KEY" \ -H "Idempotency-Key: $(uuidgen)" \ -H "Content-Type: application/json" \ -d "{\"aspect_ratio\": \"1:1\", \"n\": 1, \"prompt\": \"A watercolour koi pond at dawn, soft light.\", \"resolution\": \"1k\"}" # 2. 轮询直到状态为 COMPLETED,每次响应都会指明需要等待的 Retry-After 秒数。 REQUEST_ID="<request_id from the 201 body>" curl -i https://api.comfy.org/v2/models/kling/kling-image-o1/requests/$REQUEST_ID/status \ -H "X-API-Key: $COMFY_API_KEY" # 3. 收集。仍在运行时返回 202 及状态响应体,完成时返回 200 及模型的原始输出。 curl https://api.comfy.org/v2/models/kling/kling-image-o1/requests/$REQUEST_ID \ -H "X-API-Key: $COMFY_API_KEY"``
Schema
输入
aspect\_ratio string (default: "auto")
生成图像的宽高比(宽度:高度)。auto 表示根据传入内容智能生成图像。
可选值:16:9、9:16、1:1、4:3、3:4、3:2、2:3、21:9、auto
callback\_url string (uri)
此任务结果的回调通知地址。若已配置,任务状态发生变化时服务器会主动通知。此项会被忽略:comfy-api 在转发前会丢弃该字段;由 Comfy Router 代你轮询。
格式:uri
element\_list object[]
基于元素 ID 配置的参考元素列表。参考元素与参考图像的数量之和不得超过 10。
element\_list\[].element\_id integer required
元素 ID
格式:int64
external\_task\_id string
自定义任务 ID。在单个用户账户内必须唯一。此项会被忽略:comfy-api 在转发前会丢弃该字段;由 Comfy Router 代你轮询。
image\_list object[]
参考图像列表。支持传入图像 Base64 编码或图像网址(确保可访问)。支持的格式包括 .jpg/.jpeg/.png。文件大小不能超过 10MB。宽度和高度尺寸不得小于 300px,宽高比在 1:2.5 \~ 2.5:1 之间。参考元素与参考图像的数量之和不得超过 10。
image\_list\[].image string required
图像 Base64 编码或图像网址(确保可访问)
model\_name string
模型名。使用 Comfy Router 时可省略或传 null;模型由请求路径选择。如果提供了名称,则必须与该路径匹配。
n integer (default: 1)
生成图像的数量。取值范围 \[1,9]。
范围:1 至 9
prompt string required
文本提示词,可包含正面和负面描述。不得超过 2,500 个字符。Omni 模型可以通过带有元素和图像的 Prompt 实现多种能力。使用 \<\<\<>>> 格式指定图像,例如 \<\<\<image\_1>>>。
resolution string (default: "1k")
图像生成分辨率。1k 为 1K 标准,2k 为 2K 高清,4k 为 4K 高清。
可选值:1k、2k、4k
result\_type string (default: "single")
控制生成单张图像还是组图。series 在 kling-image-o1 上不受支持(当省略 model\_name 时,v1 代理使用的也是该值);此类请求会以 HTTP 400 被拒绝。
可选值:single、series
series\_amount integer (default: 4)
组图中图像的数量。取值范围 \[2,9]。
范围:2 至 9
由 Router 在 GET /v2/models/kling/kling-image-o1/openapi.json 提供的 Schema 生成,与请求到达提供商之前用于校验调用的文档为同一份。
输出
code integer
错误码
data object
data.created\_at integer
任务创建时间,Unix 时间戳(毫秒)
data.final\_unit\_deduction string
任务的扣减单位
data.task\_id string
任务 ID
data.task\_info object
data.task\_info.external\_task\_id string
客户自定义任务 ID
data.task\_result object
data.task\_result.images object[]
data.task\_result.images\[].index integer
图像编号(0-9)
data.task\_result.images\[].url string (uri)
已生成图像的网址
格式:uri
data.task\_result.result\_type string
结果是单张图像还是组图
可选值:single、series
data.task\_result.series\_images object[]
组图结果列表
data.task\_result.series\_images\[].index integer
组图序号
data.task\_result.series\_images\[].url string (uri)
已生成图像的网址
格式:uri
data.task\_status string
任务状态
可选值:submitted、processing、succeed、failed
data.task\_status\_msg string
任务状态信息,任务失败时显示失败原因(例如触发平台的内容风控等)
data.updated\_at integer
任务更新时间,Unix 时间戳(毫秒)
message string
报错信息
request\_id string
请求 ID
示例
输入
{
"aspect_ratio": "1:1",
"n": 1,
"prompt": "A watercolour koi pond at dawn, soft light.",
"resolution": "1k"
}
输出
{
"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"
}
发布前须知
SDK 会生成 Idempotency-Key 并在自动重试中复用它。手动重试时,请复用原始 key。Router 最长可保持连接 10 分钟。
请求失败时,Router 会发送 X-Comfy-Error-Type 响应头说明原因。422 表示 Router 在调用提供商之前就拒绝了输入,413 表示请求体超出了 Router 可接受的大小。已生成的资源请及时下载,因为结果 URL 会过期。
上文任何字段描述中提到的尺寸限制,都是提供商对该字段自身的限定,引自提供商的规范。Router 会对整个请求体另行设置上限,base64 编码的媒体内容也计入其中:参见请求体大小。
本页记录的是通过 Comfy Router 调用的某一个合作伙伴模型。同一个 comfy-sdk / @comfyorg/sdk 包还提供第二个客户端,用于在 Comfy Cloud 上运行完整的 ComfyUI 工作流图:Comfy(api_key=...) / new Comfy({ apiKey }),并带有 client.workflows、client.assets 和 client.jobs。请参阅 Comfy SDKs。
[card] 请求头 身份验证、幂等性、请求 ID、错误分类、重试节奏、消费限额。
[card] 使用 Router API 模型发现、验证错误、重试与计费。
[card] 限制 Router 目前不支持的功能,以及替代方案。