1. 接口描述
接口请求域名: vod.tencentcloudapi.com 。
该接口用于创建 AIGC 自定义音色。
默认接口请求频率限制:20次/秒。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:CreateAigcCustomVoice。 |
| Version | 是 | String | 公共参数,本接口取值:2018-07-17。 |
| Region | 否 | String | 公共参数,此参数为可选参数。 |
| SubAppId | 否 | Integer | 点播应用 ID。从2023年12月25日起开通点播的客户,如访问点播应用中的资源(无论是默认应用还是新创建的应用),必须将该字段填写为应用 ID。 示例值:221073 |
| VoiceName | 否 | String | 音色名称,文本内容最大长度 20 个字符 示例值:myVoice |
| VoiceUrl | 否 | String | 音色数据文件获取链接,支持 .mp3 / .wav / .mp4 / .mov 格式的音视频文件。音频中人声需干净无杂音,有且只能有一种人声,时长不短于 5 秒且不长于 30 秒。 示例值:myVoiceUrl |
| VideoId | 否 | String | 历史作品 ID,可通过引用历史作品提供音频素材。 示例值:myVideoId |
| SessionId | 否 | String | 用于去重的识别码,如果三天内曾有过相同的识别码的请求,则本次的请求会返回错误。最长 50 个字符,不带或者带空字符串表示不做去重。 示例值:mySessionId1112 |
| SessionContext | 否 | String | 来源上下文,用于透传用户请求信息,任务完成回调将返回该字段值,最长 1000 个字符。 示例值:mySessionContext |
| TasksPriority | 否 | Integer | 任务的优先级,数值越大优先级越高,取值范围是 -10 到 10,不填代表 0。 示例值:10 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| TaskId | String | 任务 ID。 示例值:221073-CreateAigcCustomVoice-d5cd48945834b441e6e2db3966d4c954t |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 创建自定义音色
输入示例
POST / HTTP/1.1
Host: vod.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateAigcCustomVoice
<公共请求参数>
{
"SubAppId": 221073,
"VoiceName": "myVoice",
"VoiceUrl": "myVoiceUrl",
"VideoId": "myVideoId"
}
输出示例
{
"Response": {
"TaskId": "221073-CreateAigcCustomVoice-d5cd48945834b441e6e2db3966d4c954t",
"RequestId": "daab1385-c7d7-4668-90a0-99f73f14c009"
}
}
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 | 操作失败。 |
| FailedOperation.InvalidVodUser | 没有开通点播业务。 |
| InternalError | 内部错误。 |
| InvalidParameter | 参数错误。 |
| InvalidParameterValue.SessionContextTooLong | SessionContext 过长。 |
| InvalidParameterValue.SessionId | 去重识别码重复,请求被去重。 |
| InvalidParameterValue.SessionIdTooLong | SessionId 过长。 |
| InvalidParameterValue.SubAppId | 参数值错误:应用 ID。 |
| UnauthorizedOperation | 未授权操作。 |