1. 接口描述
接口请求域名: mps.tencentcloudapi.com 。
调用该接口,用于创建AI生视频任务。
默认接口请求频率限制:10次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:CreateAigcVideoTask。 |
| Version | 是 | String | 公共参数,本接口取值:2019-06-12。 |
| Region | 否 | String | 公共参数,此参数为可选参数。 |
| ModelName | 否 | String | 模型名称。 当前支持的模型列表: Hunyuan, Hailuo, Kling, Jimeng, Vidu, OS, GV。 示例值:Hailuo |
| ModelVersion | 否 | String | 指定模型特定版本号。默认使用系统当前所支持的模型稳定版本。 1. Hailuo, 可选[02、2.3]。 2. Kling,可选[2.0、2.1、2.5]。 3. Jimeng, 可选[3.0pro]。 4. Vidu,可选[q2、q2-pro、q2-turbo]。 4. GV, 可选[3.1]。 5. OS,可选[2.0]。 示例值:2.3 |
| Prompt | 否 | String | 生成视频的描述。(注:最大支持2000字符)。当未传入图片时,此参数必填。 示例值:move the picture |
| NegativePrompt | 否 | String | 用于描述您想要阻止模型生成的内容。 注意:部分模型支持。 例如: 顶部照明、明亮的色彩 人物、动物 多辆汽车、风。 示例值:Top lighting, bright colors |
| EnhancePrompt | 否 | Boolean | 默认取值为False,模型会严格地遵循指令。如果需要更精细的prompt获得最佳效果,可将此参数设置为True,将自动优化传入的prompt,以提升生成质量。 示例值:false |
| ImageUrl | 否 | String | 用于指导视频生成的图片 URL。该URL需外网可访问。 注意: 1. 推荐图片大小不超过10M,不同模型大小限制不相同。 2. 支持的图片格式:jpeg、png。 3. 使用OS模型时,需输入图片尺寸为: 1280x720、720x1280。 示例值:https://1500039689.vod-xxx.com/6cd2c44bvodcq1500039689/179cafb25145403699605999621/xxdjoxE6jcA.png |
| LastImageUrl | 否 | String | 模型将以此参数传入的图片作为尾帧画面来生成视频。 支持此参数的模型: 1. GV,传入尾帧图片时,必须同时传入ImageUrl作为首帧。 2. Kling, 在Resolution:1080P的情况下 2.1版本支持首位帧。 3. Vidu, q2-pro, q2-turbo 支持首尾帧。 注意: 1. 推荐图片大小不超过10M,各模型限制不同。 2. 支持的图片格式:jpeg、png。 示例值:https://aigc-xxx-image-1303333058.cos.ap-guangzhou.myqcloud.com/xxx_8655.png |
| ImageInfos.N | 否 | Array of AigcVideoReferenceImageInfo | 最多包含三张素材资源图片的列表,用于描述模型在生成视频时要使用的资源图片。 支持多图输入的模型: 1. GV,使用多图输入时,不可使用ImageUrl和LastImageUrl。 2. Vidu,支持多图参考生视频。q2模型1-7张图片,可通过ImageInfos里面的ReferenceType作为主体id来传入。 注意: 1. 图片大小不超过10M。 2. 支持的图片格式:jpeg、png。 |
| Duration | 否 | Integer | 生成视频的时长。 注意: 1. Kling支持 5、10秒。默认: 5秒。 2. Jimeng支持5、10秒。 默认: 5秒。 3. Hailuo的std模式可支持6、10秒,其他仅6秒。默认:6秒。 4. Vidu支持1-10秒。 4. GV支持 8秒。 默认:8秒。 5. OS支持4、8、12秒。 默认:8秒。 示例值:8 |
| ExtraParameters | 否 | AigcVideoExtraParam | 用于传入模型要求的额外参数。 |
| StoreCosParam | 否 | AigcStoreCosParam | 文件结果指定存储Cos桶信息。 注意:需开通Cos,创建并授权MPS_QcsRole角色。 |
| Operator | 否 | String | 接口操作者名称。 示例值:admin |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| TaskId | String | 任务创建成功后,返回的任务ID。 调用查询接口,轮询获取任务进度及生成结果。 示例值:2147483792 |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 请求示例
输入示例
POST / HTTP/1.1
Host: mps.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateAigcVideoTask
<公共请求参数>
{
"ModelName": "GV",
"Prompt": "move the picture",
"NegativePrompt": "Top lighting,bright colors",
"EnhancePrompt": false,
"ImageUrl": "https://1500039689.vod-**.com/6cd2c44bvodcq1500039689/179cafb25145403699605999621/**oxE6jcA.png",
"LastImageUrl": "https://aigc-**-image-1303333058.cos.ap-guangzhou.myqcloud.com/xxx_8655.png",
"Duration": 8,
"ExtraParameters": {
"Resolution": "720P",
"AspectRatio": "16:9"
},
"StoreCosParam": {
"CosBucketName": "aigc-***-video-1**58",
"CosBucketRegion": "ap-guangzhou",
"CosBucketPath": "my_cos_file"
},
"Operator": "admin"
}
输出示例
{
"Response": {
"TaskId": "2147**3792",
"RequestId": "643fb583-0032-44ac-bfa8-bef25e310998"
}
}
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. 错误码
该接口暂无业务逻辑相关的错误码,其他错误码详见 公共错误码。