通过 Comfy Router 使用 Kling V2.6
通过 Comfy Router 调用 kling/kling-v2-6:端点、请求形状以及 Router 返回的响应。
通过 Comfy Router 使用 Kling V2.6
通过 Comfy Router 调用 kling/kling-v2-6:端点、请求形状以及 Router 返回的响应。
kling/kling-v2-6 的 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-v2-6
端点: POST https://api.comfy.org/v2/models/kling/kling-v2-6
[tab] 等待结果 ``python Python theme={null} from comfy_sdk import Comfy # 从环境中读取 COMFY_API_KEY。 # SDK 会自动创建幂等键,并在自动重试时复用它。 with Comfy() as client: result = client.models.run( "kling/kling-v2-6", { "aspect_ratio": "16:9", "duration": "5", "mode": "std", "prompt": "A red fox trotting through falling snow, cinematic lighting.", }, ) print(result)``typescript TypeScript theme={null} import { comfy } from "@comfyorg/sdk"; // 从环境中读取 COMFY_API_KEY。 // SDK 会自动创建幂等键,并在自动重试时复用它。 const { data } = await comfy.models.run("kling/kling-v2-6", { aspect_ratio: "16:9", duration: "5", mode: "std", prompt: "A red fox trotting through falling snow, cinematic lighting.", }); console.log(data);``bash cURL theme={null} curl https://api.comfy.org/v2/models/kling/kling-v2-6 \ -H "X-API-Key: $COMFY_API_KEY" \ -H "Idempotency-Key: $(uuidgen)" \ -H "Content-Type: application/json" \ -d "{\"aspect_ratio\": \"16:9\", \"duration\": \"5\", \"mode\": \"std\", \"prompt\": \"A red fox trotting through falling snow, cinematic lighting.\"}"``
[tab] 加入队列并稍后收集 相同的请求体,发送到POST https://api.comfy.org/v2/models/kling/kling-v2-6/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-v2-6", { "aspect_ratio": "16:9", "duration": "5", "mode": "std", "prompt": "A red fox trotting through falling snow, cinematic lighting.", }, ) 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-v2-6", { aspect_ratio: "16:9", duration: "5", mode: "std", prompt: "A red fox trotting through falling snow, cinematic lighting.", }); console.log("requestId:", handle.requestId); // 加上模型 ID,就是另一个进程所需的全部信息 // 轮询直到请求完成,按服务器给出的 Retry-After 等待。 for await (const update of handle.events()) { console.log(update.status, update.queuePosition); } // 与 models.run() 返回的结果相同。失败或已取消的请求会在此处 reject。 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-v2-6/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\": \"std\", \"prompt\": \"A red fox trotting through falling snow, cinematic lighting.\"}" # 2. 轮询直到状态为 COMPLETED,按每个响应给出的 Retry-After 秒数等待。 REQUEST_ID="<request_id from the 201 body>" curl -i https://api.comfy.org/v2/models/kling/kling-v2-6/requests/$REQUEST_ID/status \ -H "X-API-Key: $COMFY_API_KEY" # 3. 收集。返回 200 时为模型的原生输出,仍在运行时返回 202 及状态响应体。 curl https://api.comfy.org/v2/models/kling/kling-v2-6/requests/$REQUEST_ID \ -H "X-API-Key: $COMFY_API_KEY"``
Schema
输入
aspect\_ratio string (default: "16:9")
视频宽高比例
可能的值:16:9、9:16、1:1
callback\_url string (uri)
回调通知地址。此项会被忽略:comfy-api 在转发前会丢弃该字段;由 Comfy Router 代你轮询。
格式:uri
camera\_control object
camera\_control.config object
camera\_control.config.horizontal number
控制相机沿水平轴(x 轴)的移动。负值表示向左,正值表示向右。
范围:-10 到 10
camera\_control.config.pan number
控制相机在垂直平面内的旋转(x 轴)。负值表示向下旋转,正值表示向上旋转。
范围:-10 到 10
camera\_control.config.roll number
控制相机的滚动幅度(z 轴)。负值表示逆时针,正值表示顺时针。
范围:-10 到 10
camera\_control.config.tilt number
控制相机在水平平面内的旋转(y 轴)。负值表示向左旋转,正值表示向右旋转。
范围:-10 到 10
camera\_control.config.vertical number
控制相机沿竖直轴(y 轴)的移动。负值表示向下,正值表示向上。
范围:-10 到 10
camera\_control.config.zoom number
控制相机焦距的变化。负值表示视野变窄,正值表示视野变宽。
范围:-10 到 10
camera\_control.type string
预定义的相机运动类型。simple:可自定义的相机运动。down\_back:相机下降并向后移动。forward\_up:相机向前移动并向上倾斜。right\_turn\_forward:向右旋转并向前移动。left\_turn\_forward:向左旋转并向前移动。
可能的值:simple、down_back、forward_up、right_turn_forward、left_turn_forward
cfg\_scale number (default: 0.5)
视频生成的灵活度。该值越高,模型的灵活度越低,与用户提示词的相关性越强。
范围:0 到 1
格式:float
duration string (default: "5")
视频时长,单位为秒
可能的值:3、4、5、6、7、8、9、10、11、12、13、14、15
external\_task\_id string
自定义任务 ID。此项会被忽略:comfy-api 在转发前会丢弃该字段;由 Comfy Router 代你轮询。
mode string (default: "std")
视频生成模式。std:标准模式,性价比高。pro:专业模式,生成的视频时长更长,输出质量更高。
可能的值:std、pro
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 参数无效。
negative\_prompt string
负面文本提示词。建议直接在正向提示词中通过否定句补充负面提示信息。
prompt string
正向文本提示词。使用 \<\<\<voice\_1>>> 指定与 voice\_list 参数顺序匹配的声音。一个任务最多可引用 2 个音色。指定音色时,sound 参数值必须为 on。
shot\_type string
分镜方式。当 multi\_shot 参数设为 true 时必填。
可能的值:customize、intelligence
sound string (default: "off")
生成视频时是否同时生成声音。仅 V2.6 及后续版本的模型支持该参数。
可能的值:on、off
voice\_list object[]
生成视频时引用的音色列表。最多支持 2 个音色;在 prompt 中按列表顺序以 \<\<\<voice\_1>>> 和 \<\<\<voice\_2>>> 引用。需要将 sound 设为 "on",且仅 V2.6 及之后版本的模型支持;在更早的模型上,或 sound 保持默认值 "off" 时,音色不会生效。
voice\_list\[].voice\_id string required
通过音色定制 API 返回的音色 ID,或系统预置音色 ID。
watermark\_info object
是否同时生成带水印的结果。当前不支持自定义水印。
watermark\_info.enabled boolean
true 表示生成水印,false 表示不生成。
根据 Router 在 GET /v2/models/kling/kling-v2-6/openapi.json 提供的 schema 生成,该文档与请求到达提供商之前 Router 用于校验调用的文档相同。
输出
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": "std",
"prompt": "A red fox trotting through falling snow, cinematic lighting."
}
输出
{
"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 目前不支持的功能,以及替代方案。