1. 接口描述
接口请求域名: mps.tencentcloudapi.com 。
创建 AIGC 文档生成视频任务
(使用 DescribeAigcTaskStatus 接口进行任务查询)
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:CreateDocToVideoTask。 |
| Version | 是 | String | 公共参数,本接口取值:2019-06-12。 |
| Region | 否 | String | 公共参数,本接口不需要传递此参数。 |
| Input | 是 | DocToVideoInput | AIGC文档生成视频的输入信息 |
| CosInfo | 否 | DocToVideoCosInfo | 用户cos信息,用于保存生成结果 |
| ResourceId | 否 | String | 资源ID,需要保证对应资源是开启状态。默认为账号主资源ID。 示例值:vts-****-1 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| TaskId | String | 任务id 示例值:516e11a9-**-e0c84dffda8b |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 测试样例
输入示例
POST / HTTP/1.1
Host: mps.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateDocToVideoTask
<公共请求参数>
{
"Input": {
"FileUrl": [
"https://aigc-tes**************************************************************************sample_min.docx"
],
"Prompt": "根据文档内容,帮我生成一个视频",
"ModelName": "WAND",
"ModelVersion": "1.0-lite",
"Ratio": "1:1",
"ReferenceDuration": 15,
"EnableTTS": true,
"PPTXFidelity": false,
"Mode": "auto",
"EnableCaption": false
},
"ResourceId": "vts-********-1"
}
输出示例
{
"Response": {
"TaskId": "516e11a9-**************-e0c84dffda8b",
"RequestId": "825f6082-c99b-455a-97a6-97bb56740cbe"
}
}
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. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation.CreateAIGCTaskFailed | 创建AIGC任务失败 |
| FailedOperation.UserArrears | 用户状态已停服 |
| InvalidParameter | 参数错误。 |
| LimitExceeded.CreateTask | 无法创建任务,当前正在执行的任务数达到上限 |