1. 接口描述
接口请求域名: vclm.tencentcloudapi.com 。
提交生视频任务
默认接口请求频率限制:20次/秒。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:SubmitAigcVideoJob。 |
| Version | 是 | String | 公共参数,本接口取值:2024-05-23。 |
| Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
| Vendor | 是 | String | 模型名称。 枚举值: ● Vidu; ● Kling:可灵; ● HY:混元; ● YT:优图; 示例值:Vidu 示例值:HY |
| Model | 是 | String | 模型版本。 枚举值: ● 当Vendor为Vidu时,可选值[q2, q2-pro, q2-turbo] ● 当Vendor为Kling时,可选值[v1.6, v2.0, v2.1, v2.5, , v2.6, O1] ● 当Vendor为HY时,默认值:[v1.5] ● 当Vendor为YT时,默认值:[v2.0] 示例值:v1.5 |
| ModelParam | 否 | String | 模型参数Json-Format字符串 示例值:{ "image":"https://**-guangzhou.myqcloud.com/.jpeg", "resolution":"1080p", "images":["https://**-guangzhou.myqcloud.com/****.jpeg"] } |
| Prompt | 否 | String | 正向文本提示词。不能超过2000个字符 示例值:一只小猫在草地奔跑 示例值:美女在沙滩跳舞 |
| LogoAdd | 否 | Integer | 为生成结果图添加显式水印标识的开关,默认为1。 示例值:0 |
| LogoParam | 否 | LogoParam | 标识内容设置。 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| JobId | String | 任务ID。 示例值:1412464707775373312 |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 提交生视频任务示例
输入示例
POST / HTTP/1.1
Host: vclm.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: SubmitAigcVideoJob
<公共请求参数>
{
"Vendor": "VO",
"Model": "V3.1",
"ModelParam": "{\n\"image\":\"https://**********************-guangzhou.myqcloud.com/****.jpeg\",\n\"resolution\":\"1080p\",\n\"images\":[\"https://**********************-guangzhou.myqcloud.com/****.jpeg\"]\n}",
"Prompt": "美女在沙滩跳舞",
"LogoAdd": 0
}
输出示例
{
"Response": {
"JobId": "1412464707775373312",
"RequestId": "bb40df7c-c705-4bf1-b0d6-196e17dfef10"
}
}
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. 错误码
该接口暂无业务逻辑相关的错误码,其他错误码详见 公共错误码。