跳转到主要内容
kling/kling-v3 的 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 端点: POST https://api.comfy.org/v2/models/kling/kling-v3
相同的请求体,发送到 POST https://api.comfy.org/v2/models/kling/kling-v3/requests。运行一经受理,Router 就会立即返回 201 和 request_id;结果就绪后即可收集,可以从本进程或其他进程收集。状态、取消与收集的细节见队列投递。

服务提供商

除非请求中指定了其他提供商,否则该模型由 Comfy Router 直接提供服务。以下提供商也通过同一端点、使用相同的模型 ID 提供该模型,并通过 model_provider 查询参数进行选择。
  • Comfy(默认):POST https://api.comfy.org/v2/models/kling/kling-v3
  • Higgsfield,名称为 higgsfield/higgsfield-kling-3-std:POST https://api.comfy.org/v2/models/kling/kling-v3?model_provider=higgsfield
  • Tencent:POST https://api.comfy.org/v2/models/kling/kling-v3?model_provider=tencent
    • 限制:720P,无声;3–15 秒(默认 5 秒);宽高比为 16:9、9:16 或 1:1
    • 以下情况会以 invalid_input 拒绝:image、image_tail、sound: "on"、std 之外的 mode(例如 "pro")、multi_shot、multi_prompt、shot_type
    • 回退:如果 Tencent 失败,请求会在 Kling(默认提供商)上重试一次。发送 fallback_provider=false 可选择退出。被拒绝的输入和 BYOK 请求不会回退。
strict_mode 默认为 false,因此 Router 会将本页记录的原始请求体转换为提供商自己的 schema,并将响应转换回来。请参阅 API 参考中的 model_provider、strict_mode 和 fallback_provider,以及服务提供商,了解所有以这种方式路由的模型。

Schema

输入

string
默认值:"\"16:9\""
视频宽高比可选值:16:9、9:16、1:1
string (uri)
回调通知地址。此项会被忽略:comfy-api 在转发前会丢弃该字段;Comfy Router 会代你轮询。格式:uri
object
object
number
控制相机沿水平轴(x 轴)的移动。负值表示向左,正值表示向右。范围:-10 到 10
number
控制相机在竖直平面内的旋转(x 轴)。负值表示向下旋转,正值表示向上旋转。范围:-10 到 10
number
控制相机的翻滚量(z 轴)。负值表示逆时针,正值表示顺时针。范围:-10 到 10
number
控制相机在水平平面内的旋转(y 轴)。负值表示向左旋转,正值表示向右旋转。范围:-10 到 10
number
控制相机沿竖直轴(y 轴)的移动。负值表示向下,正值表示向上。范围:-10 到 10
number
控制相机焦距的变化。负值表示视野变窄,正值表示视野变宽。范围:-10 到 10
string
预定义的相机运动类型。simple:可自定义的相机运动。down_back:相机下降并向后移动。forward_up:相机向前移动并向上倾斜。right_turn_forward:向右旋转并向前移动。left_turn_forward:向左旋转并向前移动。可选值:simple、down_back、forward_up、right_turn_forward、left_turn_forward
number
默认值:"0.5"
视频生成中的灵活性。该值越高,模型的灵活程度越低,与用户提示词的相关性越强。范围:0 到 1格式:float
string
默认值:"\"5\""
视频时长,单位为秒可选值:3、4、5、6、7、8、9、10、11、12、13、14、15
string
自定义任务 ID。此项会被忽略:comfy-api 在转发前会丢弃该字段;Comfy Router 会代你轮询。
string
模型名。使用 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
负面文本提示词。推荐直接在正向提示词中用否定句补充负面提示词信息。
string
正向文本提示词。使用 <<<voice_1>>> 指定与 voice_list 参数顺序匹配的声音。一个任务最多可引用 2 个音色。指定音色时,sound 参数值必须为 on。
string
分镜方法。当 multi_shot 参数设置为 true 时必填。可选值:customize、intelligence
string
默认值:"\"off\""
生成视频时是否同时生成声音。仅 V2.6 及后续版本的模型支持此参数。可选值:on、off
object[]
生成视频时引用的声音列表。最多支持 2 个声音;在 prompt 中按列表顺序以 <<<voice_1>>> 和 <<<voice_2>>> 引用它们。需要将 sound 设置为 “on”,仅 V2.6 及后续版本的模型支持该值;在更早的模型上,或将 sound 保留为默认值 “off” 时,声音不会应用。
string
必填
通过声音定制 API 返回的声音 ID,或系统预设声音 ID。
object
是否同时生成带水印的结果。目前不支持自定义水印。
boolean
true 表示生成水印,false 表示不生成。
string
参考图像:URL 或 Base64 编码字符串,不能超过 10MB,分辨率不低于 300*300px,宽高比在 1:2.5 ~ 2.5:1 之间。Base64 不应包含 data:image 前缀。
string
参考图像:结束帧控制。URL 或 Base64 编码字符串,不能超过 10MB,分辨率不低于 300*300px。Base64 不应包含 data:image 前缀。不能与 dynamic_masks/static_mask 或 camera_control 同时使用。
string
默认值:"\"std\""
视频生成模式。std:标准模式,性价比高。pro:专业模式,生成的视频时长更长,但输出质量更高。4k:超高清模式,生成 4K 分辨率的视频。在该系列中,只有 kling-v3 支持 4k;其他所有 Kling 文生视频模型仅支持 pro/std。可选值:std、pro、4k
该内容根据 Router 在 GET /v2/models/kling/kling-v3/openapi.json 提供的 schema 生成,该文档与 Router 在请求到达提供商之前校验调用所用的文档相同。

输出

integer
错误码
object
integer
任务创建时间,Unix 时间戳(毫秒)
string
任务扣除的单位数
string
任务 ID
object
string
object
object[]
string
视频总时长(秒)
string
已生成视频 ID
string (uri)
已生成视频的 URL格式:uri
string (uri)
带水印的已生成视频 URL,防盗链格式格式:uri
string
任务状态可能的值:submitted、processing、succeed、failed
string
任务状态信息,任务失败时显示失败原因
integer
任务更新时间,Unix 时间戳(毫秒)
object
boolean
string
报错信息
string
请求 ID

示例

输入

输出

发布前须知

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。

请求头

身份验证、幂等性、请求 ID、错误分类、重试节奏、消费限额。

使用 Router API

模型发现、验证错误、重试与计费。

限制

Router 目前不支持的功能,以及替代方案。