通过 Comfy Router 使用 Kling V3 Omni
通过 Comfy Router 调用 kling/kling-v3-omni：端点、请求结构以及 Router 返回的响应。
通过 Comfy Router 使用 Kling V3 Omni
通过 Comfy Router 调用 kling/kling-v3-omni：端点、请求结构以及 Router 返回的响应。
kling/kling-v3-omni 的 API 参考，由 Comfy Router 提供，模型来自 Kling。
输入： 文本, 图像, 视频 · 输出： 视频
快速开始
在你的 Comfy 工作区中创建密钥，并将其导出为 COMFY_API_KEY。Python 和 TypeScript 代码片段使用 Comfy SDK（pip install comfy-sdk 和 npm install @comfyorg/sdk）；cURL 代码片段是通过原始 HTTP 执行的同一调用。
模型 ID： kling/kling-v3-omni
端点： POST https://api.comfy.org/v2/models/kling/kling-v3-omni
[tab] 等待结果 ``python Python theme={null} from comfy_sdk import Comfy # 从环境变量中读取 COMFY_API_KEY。 # SDK 会自动创建幂等键，并在自动重试时复用它。 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)``typescript TypeScript theme={null} import { comfy } from "@comfyorg/sdk"; // 从环境变量中读取 COMFY_API_KEY。 // SDK 会自动创建幂等键，并在自动重试时复用它。 const { data } = await comfy.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.", }); console.log(data);``bash cURL theme={null} curl https://api.comfy.org/v2/models/kling/kling-v3-omni \ -H "X-API-Key: $COMFY_API_KEY" \ -H "Idempotency-Key: $(uuidgen)" \ -H "Content-Type: application/json" \ -d "{\"aspect_ratio\": \"16:9\", \"duration\": \"5\", \"mode\": \"pro\", \"prompt\": \"A paper boat drifting down a rain-soaked street at dusk.\"}"``
[tab] 入队并稍后收集 同样的请求体，发送到POST https://api.comfy.org/v2/models/kling/kling-v3-omni/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-v3-omni", { "aspect_ratio": "16:9", "duration": "5", "mode": "pro", "prompt": "A paper boat drifting down a rain-soaked street at dusk.", }, ) 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-v3-omni", { aspect_ratio: "16:9", duration: "5", mode: "pro", prompt: "A paper boat drifting down a rain-soaked street at dusk.", }); 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-v3-omni/requests \ -H "X-API-Key: $COMFY_API_KEY" \ -H "Idempotency-Key: $(uuidgen)" \ -H "Content-Type: application/json" \ -d "{\"aspect_ratio\": \"16:9\", \"duration\": \"5\", \"mode\": \"pro\", \"prompt\": \"A paper boat drifting down a rain-soaked street at dusk.\"}" # 2. 轮询直到状态为 COMPLETED，每个响应都会给出 Retry-After 秒数，需按此等待。 REQUEST_ID="<request_id from the 201 body>" curl -i https://api.comfy.org/v2/models/kling/kling-v3-omni/requests/$REQUEST_ID/status \ -H "X-API-Key: $COMFY_API_KEY" # 3. 收集。返回 200 时附带模型的原生输出，仍在运行时返回 202 及状态响应体。 curl https://api.comfy.org/v2/models/kling/kling-v3-omni/requests/$REQUEST_ID \ -H "X-API-Key: $COMFY_API_KEY"``
Schema
输入
aspect\_ratio string
生成视频画面的宽高比（宽度:高度）。当未使用首帧参考或视频编辑功能时，此参数必填。
可选值：16:9、9:16、1:1
callback\_url string (uri)
本任务结果的回调通知地址。若配置此项，任务状态发生变化时服务器将主动通知。此项会被忽略：comfy-api 在转发前会丢弃该字段；由 Comfy Router 代你轮询。
格式：uri
duration string (default: "5")
视频时长，单位为秒。使用视频编辑功能时（refer\_type: base），输出时长与输入视频相同，此参数无效。
可选值：3、4、5、6、7、8、9、10、11、12、13、14、15
element\_list object[]
基于元素 ID 配置的参考元素列表。
element\_list\[].element\_id integer required
元素 ID
格式：int64
external\_task\_id string
自定义任务 ID。在单个用户账号内必须唯一。此项会被忽略：comfy-api 在转发前会丢弃该字段；由 Comfy Router 代你轮询。
image\_list object[]
参考图像列表。可包含元素、场景、风格等参考图像，也可用作首帧或结束帧来生成视频。
image\_list\[].image\_url string
图像 Base64 编码或图片网址（确保可访问）。支持的格式包括 .jpg/.jpeg/.png。文件大小不能超过 10MB。宽度和高度尺寸不得小于 300px，宽高比在 1:2.5 \~ 2.5:1 之间。
image\_list\[].type string
该图像是首帧还是结束帧。first\_frame 为首帧，end\_frame 为结束帧。目前不支持仅使用结束帧。
可选值：first_frame、end_frame
mode string (default: "pro")
视频生成模式。std：标准模式，生成 720P 视频，性价比高。pro：专业模式，生成 1080P 视频，视频输出质量更高。
可选值：pro、std
model\_name string
模型名。使用 Comfy Router 时可省略或发送 null，模型由请求路径选择。若提供名称，则必须与该路径一致。
multi\_prompt object[]
每个分镜的信息，例如提示词和时长。最多支持 6 个分镜，最少 1 个。当 multi\_shot 为 true 且 shot\_type 为 customize 时必填。
multi\_prompt\[].duration string
该分镜的时长，单位为秒。不得超过任务总时长，且不得小于 1。所有分镜时长之和等于任务总时长。
multi\_prompt\[].index integer
镜头序号
multi\_prompt\[].prompt string
该分镜的提示词。最大长度 512 个字符。
multi\_shot boolean (default: false)
是否生成多镜头视频。为 true 时，prompt 参数无效。为 false 时，shot\_type 和 multi\_prompt 参数无效。
prompt string
文本提示词，可包含正面和负面描述。不得超过 2,500 个字符。可通过 \<\<\<>>> 格式指定元素、图像或视频，例如 \<\<element\_1>>、\<\<\<image\_1>>>、\<\<\<video\_1>>>。
shot\_type string
分镜方式。当 multi\_shot 参数设置为 true 时必填。
可选值：customize、intelligence
sound string (default: "off")
生成视频时是否同时生成声音。
可选值：on、off
video\_list object[]
参考视频列表。可用作功能参考视频，也可用作待编辑的视频，默认为待编辑的视频。
video\_list\[].keep\_original\_sound string
是否保留视频原始声音。yes 表示保留，no 表示不保留。
可选值：yes、no
video\_list\[].refer\_type string
参考视频类型。feature 为功能参考视频，base 为待编辑的视频。
可选值：feature、base
video\_list\[].video\_url string required
上传视频的网址。仅支持 .mp4/.mov 格式。时长在 3-10 秒之间。分辨率必须在 720px 到 2160px 之间。支持 24-60 fps 的帧率。只能上传 1 个视频，且大小不超过 200MB。
watermark\_info object
是否同时生成带水印的结果。目前不支持自定义水印。
watermark\_info.enabled boolean
true 表示生成水印，false 表示不生成。
由 Router 在 GET /v2/models/kling/kling-v3-omni/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
data.task\_result object
data.task\_result.videos object[]
data.task\_result.videos\[].duration string
视频总时长（秒）
data.task\_result.videos\[].id string
已生成的视频 ID
data.task\_result.videos\[].url string (uri)
已生成视频的 URL
格式：uri
data.task\_result.videos\[].watermark\_url string (uri)
已生成的带水印视频 URL，防盗链格式
格式：uri
data.task\_status string
任务状态
可能的值：submitted、processing、succeed、failed
data.task\_status\_msg string
任务状态信息，任务失败时显示失败原因
data.updated\_at integer
任务更新时间，Unix 时间戳（毫秒）
data.watermark\_info object
data.watermark\_info.enabled boolean
message string
报错信息
request\_id string
请求 ID
示例
输入
{
"aspect_ratio": "16:9",
"duration": "5",
"mode": "pro",
"prompt": "A paper boat drifting down a rain-soaked street at dusk."
}
输出
{
"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-v2-5-turbo/generated.mp4"
}
]
},
"task_status": "succeed",
"task_status_msg": "",
"updated_at": 1798761840000
},
"message": "SUCCEED",
"request_id": "9f2c1a04-7b6e-4d38-8a51-3c0e7d9b2f46"
}
发布前须知
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 目前不支持的功能，以及替代方案。