1. 接口描述
接口请求域名: mps.tencentcloudapi.com 。
调用该接口,用于创建AI生音频任务。
默认接口请求频率限制:20次/秒。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:CreateAigcAudioTask。 |
| Version | 是 | String | 公共参数,本接口取值:2019-06-12。 |
| Region | 否 | String | 公共参数,此参数为可选参数。 |
| ModelName | 否 | String | 模型名称。生音乐当前支持的模型: GL、MinimaxMusic。 示例值:Tme |
| ModelVersion | 否 | String | 指定模型特定版本号。默认使用系统当前所支持的模型稳定版本。 示例值:1.0 |
| SceneType | 否 | String | 指定场景生音频。音乐: music。 示例值:music |
| Prompt | 否 | String | 生成视频的描述。(注:最大支持2000字符)。当未传入图片时,此参数必填。 示例值:生成一段音乐 |
| VideoInfos.N | 否 | Array of AigcAudioReferenceVideoInfo | 参考视频信息。仅部分模型支持。 |
| AudioInfos.N | 否 | Array of AigcAudioReferenceAudioInfo | 传入参考音频信息。 比如传入音频生成音乐时需要传入。 |
| OutputAudioFormat | 否 | String | 输出音频格式,默认不填。mp3、wav。 示例值:wav |
| StoreCosParam | 否 | AigcStoreCosParam | 文件结果指定存储Cos桶信息。 注意:需开通Cos,创建并授权MPS_QcsRole角色。 |
| ExtraParameters | 否 | AigcAudioExtraParam | 用于传入要求的额外参数。 |
| AdditionalParameters | 否 | String | 用于传入一些模型需要的特殊场景参数,Json格式序列化成字符串。 示例值:{"sequential_image_generation":"auto"} |
| Operator | 否 | String | 接口操作者名称。 示例值:admin |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| TaskId | String | 任务创建成功后,返回的任务ID。 示例值:24***AigcAudio-6a383a9f51468da5bfc25**9a462 |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 请求示例
输入示例
POST / HTTP/1.1
Host: mps.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateAigcAudioTask
<公共请求参数>
{
"ModelName": "Tme",
"ModelVersion": "1.0",
"SceneType": "music",
"Prompt": "生成一段音乐",
"VideoInfos": [
{
"VideoUrl": "https://l***-******-tts-131140***2.c***ap-*ua****ou.myqcloud.com/251006278_1513228070381297256.mp4"
}
],
"AudioInfos": [
{
"AudioUrl": "https://li**-q*******ts-1311402212*cos*ap-guangzh****yqcloud.com/25*******_1513228070381297256.wav"
}
],
"OutputAudioFormat": "wav",
"ExtraParameters": {
"ResourceId": "438910555_1"
},
"AdditionalParameters": "{\"sequential_image_generation\":\"auto\"}",
"Operator": "admin"
}
输出示例
{
"Response": {
"TaskId": "24*******AigcAudio-6a38**3a9f51468da5bfc25****9a462",
"RequestId": "fcc72969-6464-45ba-8369-232f7a1e1c76"
}
}
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. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| InvalidParameter.ViolationContent | 输入审核拦截。 |