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
- Wait for the result
- Queue and collect later
数据结构
输入
string
生成视频画面的宽高比(宽度:高度)。当未使用首帧参考或视频编辑功能时,此参数必填。可选值:
16:9、9:16、1:1string (uri)
本任务结果的回调通知地址。若配置此项,任务状态发生变化时服务器将主动通知。格式:
uristring
默认值:"\"5\""
视频时长,单位为秒。使用视频编辑功能时(refer_type: base),输出时长与输入视频相同,此参数无效。可选值:
3、4、5、6、7、8、9、10、11、12、13、14、15object[]
基于元素 ID 配置的参考元素列表。
integer
必填
元素 ID格式:
int64string
自定义任务 ID。在单个用户账号内必须唯一。
object[]
参考图像列表。可包含元素、场景、风格等参考图像,也可用作首帧或结束帧来生成视频。
string
图像 Base64 编码或图片网址(确保可访问)。支持的格式包括 .jpg/.jpeg/.png。文件大小不能超过 10MB。宽度和高度尺寸不得小于 300px,宽高比在 1:2.5 ~ 2.5:1 之间。
string
该图像是首帧还是结束帧。first_frame 为首帧,end_frame 为结束帧。目前不支持仅使用结束帧。可选值:
first_frame、end_framestring
默认值:"\"pro\""
视频生成模式。std:标准模式,生成 720P 视频,性价比高。pro:专业模式,生成 1080P 视频,视频输出质量更高。可选值:
pro、stdstring
模型名。使用 Comfy Router 时可省略或发送 null,模型由请求路径选择。若提供名称,则必须与该路径一致。
object[]
每个分镜的信息,例如提示词和时长。最多支持 6 个分镜,最少 1 个。当 multi_shot 为 true 且 shot_type 为 customize 时必填。
string
该分镜的时长,单位为秒。不得超过任务总时长,且不得小于 1。所有分镜时长之和等于任务总时长。
integer
镜头序号
string
该分镜的提示词。最大长度 512 个字符。
boolean
默认值:"false"
是否生成多镜头视频。为 true 时,prompt 参数无效。为 false 时,shot_type 和 multi_prompt 参数无效。
string
文本提示词,可包含正面和负面描述。不得超过 2,500 个字符。可通过 <<<>>> 格式指定元素、图像或视频,例如 <<element_1>>、<<<image_1>>>、<<<video_1>>>。
string
分镜方式。当 multi_shot 参数设置为 true 时必填。可选值:
customize、intelligencestring
默认值:"\"off\""
生成视频时是否同时生成声音。可选值:
on、offobject[]
参考视频列表。可用作功能参考视频,也可用作待编辑的视频,默认为待编辑的视频。
string
是否保留视频原始声音。yes 表示保留,no 表示不保留。可选值:
yes、nostring
参考视频类型。feature 为功能参考视频,base 为待编辑的视频。可选值:
feature、basestring
必填
上传视频的网址。仅支持 .mp4/.mov 格式。时长在 3-10 秒之间。分辨率必须在 720px 到 2160px 之间。支持 24-60 fps 的帧率。只能上传 1 个视频,且大小不超过 200MB。
object
是否同时生成带水印的结果。目前不支持自定义水印。
boolean
true 表示生成水印,false 表示不生成。
GET /v2/models/kling/kling-v3-omni/openapi.json 提供的 schema 生成,该文档与请求到达提供商之前用于校验调用的文档相同。
输出
integer
错误码
object
integer
任务创建时间,Unix 时间戳(毫秒)
string
任务的扣费单位数
string
任务 ID
object
string
object
object[]
string
视频总时长(秒)
string
已生成的视频 ID
string (uri)
已生成视频的 URL格式:
uristring (uri)
已生成的带水印视频 URL,防盗链格式格式:
uristring
任务状态可能的值:
submitted、processing、succeed、failedstring
任务状态信息,任务失败时显示失败原因
integer
任务更新时间,Unix 时间戳(毫秒)
object
boolean
string
报错信息
string
请求 ID
示例
输入
输出
发布前须知
SDK 会生成Idempotency-Key 并在自动重试中复用它。手动重试时,请复用原始 key。Router 最长可保持连接 10 分钟。
请求失败时,Router 会发送 X-Comfy-Error-Type 响应头说明原因。422 表示 Router 在调用提供商之前就拒绝了输入。生成的资源请及时下载,因为结果链接会过期。
请求头
身份验证、幂等性、请求 ID、错误分类、重试节奏、消费限额。
使用 Router API
模型发现、校验错误、重试与计费。
限制
Router 目前不支持的功能,以及替代方案。