1. 接口描述
接口请求域名: vclm.tencentcloudapi.com 。
提交Kling多模态编辑任务
默认接口请求频率限制:20次/秒。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:SubmitVideoEditKlingJob。 |
| Version | 是 | String | 公共参数,本接口取值:2024-05-23。 |
| Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
| Prompt | 否 | String | 文本提示词,可包含正向描述和负向描述 可将提示词模板化来满足不同的视频生成需求 不能超过2500个字 示例值:一只狗 |
| Model | 否 | String | 模型名称,支持kling-video-o1,kling-v3-omni。默认kling-video-o1。 示例值:kling-v3-omni |
| ImageList.N | 否 | Array of ImageInfo | 参考图列表 包括主体、场景、风格等参考图片,也可作为首帧或尾帧生成视频;当作为首帧或尾帧生成视频时: 通过type参数来定义图片是否为首尾帧:first_frame为首帧,end_frame为尾帧 暂时不支持仅尾帧,即有尾帧图时必须有首帧图 首帧或首尾帧生视频时,不能使用视频编辑功能 用key:value承载,如下: "ImageInfo":[ 图片格式支持.jpg / .jpeg / .png 图片文件大小不能超过10MB,图片宽高尺寸不小于300px,不大于8000px,图片宽高比要在1:2.5 ~ 2.5:1之间 有参考视频时,参考图片数量不得超过4;无参考视频时,参考图片数量不得超过7 数组中超过2张图片时,不支持设置尾帧 |
| AspectRatio | 否 | String | 生成视频的画面纵横比(宽:高) 枚举值:16:9, 9:16, 1:1 未使用首帧参考或视频编辑功能时,当前参数必填 示例值:16:9 |
| Duration | 否 | Integer | 生成视频时长,单位s 枚举值:3,4,5,6,7,8,9,10,其中:使用文生视频、首帧图生视频时,仅支持5和10s 示例值:5 |
| LogoAdd | 否 | Integer | 为生成视频添加标识的开关,默认为1,0 需前往 控制台 申请开启显示标识自主完成方可生效。 1:添加标识; 0:不添加标识; 其他数值:默认按1处理。 示例值:0 |
| LogoParam | 否 | LogoParam | 默认在生成视频的右下角添加“ AI 生成”字样,如需替换为其他的标识图片,需前往 控制台 申请开启显示标识自主完成。 |
| Mode | 否 | String | 生成视频的模式 枚举值:std,pro 示例值:pro |
| VideoList.N | 否 | Array of ReferVideoInfo | 参考视频,通过URL方式获取 可作为特征参考视频,也可作为待编辑视频,默认为待编辑视频;可选择性保留视频原声
|
| MultiShot | 否 | Boolean | 是否生成多镜头视频 当前参数为true时,prompt参数无效,且不支持设定首尾帧生视频 当前参数为false时,shot_type参数及multi_prompt参数无效 示例值:true |
| ShotType | 否 | String | 分镜方式 枚举值:customize 当multi_shot参数为true时,当前参数必填 示例值:customize |
| MultiPrompt.N | 否 | Array of MultiPrompt | 各分镜信息,如提示词、时长等 通过index、prompt、duration参数定义分镜序号及相应提示词和时长,其中: 最多支持6个分镜,最小支持1个分镜 每个分镜相关内容的最大长度不超过512 每个分镜的时长不大于当前任务的总时长,不小于1 所有分镜的时长之和等于当前任务的总时长 |
| ElementList.N | 否 | Array of Element | 参考主体列表 基于主体库中主体的ID配置,用key:value承载,如下: "element_list":[ { "element_id":long }, { "element_id":long } ] 参考主体数量与有无参考视频、参考图片数量有关,其中: 当使用首帧生成视频时,最多支持3个主体; 当使用首尾帧生成视频时,kling-v3-omni模型最多支持3个主体,kling-video-o1模不支持主体; 有参考视频时,参考图片数量和参考主体数量之和不得超过4,且不支持使用视频角色主体; 无参考视频时,参考图片数量和参考主体数量之和不得超过7; |
| CallbackUrl | 否 | String | 本次任务结果回调通知地址,如果配置,服务端会在任务状态发生变更时主动通知 示例值:https://callback.com |
| Sound | 否 | String | 是否开启声音 示例值:off / on |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| JobId | String | 任务ID 示例值:4e773028-d7b3-4ffb-8337-206cfcff5978 |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 提交视频编辑任务
输入示例
POST / HTTP/1.1
Host: vclm.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: SubmitVideoEditKlingJob
<公共请求参数>
{
"Prompt": "一个女孩在跳舞",
"AspectRatio": "16:9"
}
输出示例
{
"Response": {
"JobId": "1428937152266903552",
"RequestId": "91e1dfc5-7bfc-4e41-92b5-1367dc1264d9"
}
}
5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee
命令行工具
6. 错误码
该接口暂无业务逻辑相关的错误码,其他错误码详见 公共错误码。