Appearance
VC 音色转换接口文档
请求地址以及请求头
注意:本文档下所有请求均使用POST方法
公共请求头
参数 | 值 |
---|---|
Authorization | Bearer apiKey |
Content-Type | application/json |
apiKey 为用户的API key,可在客户端中生成
1. 获取VC音色列表
/v1/getVcTimbreList
注意:该接口为POST请求
请求参数
字段 | 备注 |
---|---|
pageIndex | 分页 |
pageSize | 每页的数量 |
isMyModel | 是否展示自训练模型,不传返回官方音色 |
keyword | 关键字搜索,可以搜索名称以及介绍 |
gender | 0女;1男;不传为全选 |
ageGroup | 孩童,少年,青年,中年,老年;不传为全选 |
请求参数示例
json
{
"pageIndex": 1,
"pageSize": 20,
"isMyModel": false,
"keyword": "温柔",
"gender": 0,
"ageGroup": "青年"
}
返回值
字段 | 备注 |
---|---|
id | 音色ID |
name | 音色名称 |
description | 音色描述 |
gender | 性别,0:女,1:男 |
avatar | 头像URL |
voiceUrl | 试听音频URL |
status | 状态,true:启用,false:禁用 |
createTime | 创建时间 |
json
{
"code": 200,
"success": true,
"msg": "操作成功",
"data": [
{
"id": "100486",
"name": "赵睿诚",
"description": "中音,柔和,温暖,",
"gender": 1,
"avatar": "https://public-cdn-b.dubbingx.com/avatar/10003/1748413071569-2025-05-2802%3A17%3A51",
"voiceUrl": "https://public-cdn-b.dubbingx.com/audition/10003/1731552438898-2024-11-1410%3A47%3A18.wav",
"status": true,
"createTime": "2024-11-13 16:04:21"
}
]
}
2. 上传音频文件
/v1/uploadFile
请求方式:multipart/form-data
请求参数
字段 | 备注 |
---|---|
file | 音频文件,支持常见音频格式 |
返回值
字段 | 备注 |
---|---|
url | 上传后的音频文件访问URL |
fileName | 读取到的文件名 |
key | 文件在服务器上的存储路径 |
json
{
"code": 200,
"success": true,
"msg": "操作成功",
"data": {
"url": "https://vc-cdn-b.dubbingx.com/xxx.wav",
"fileName": "悲伤-呢喃.wav",
"key": "dbd8352ee8a32bf71982bb0b54216950"
},
"time": "2025-06-27 11:47:11",
"traceId": "1938443967439777793"
}
3. 添加音色转换任务
/v1/addVoiceConvertTask
请求参数
字段 | 备注 |
---|---|
timbreId | 目标音色ID,必填,从音色列表接口获取 |
pitch | 变调参数,-12~12,默认为0,非必填(参考值:男转女10到12,女转男-10~-12,非绝对值,即粗变细1~12,细变粗-1~-12) |
fileKey | 必填,通过上传文件接口获取 |
请求参数示例
json
{
"timbreId": 1001,
"pitch": 2,
"fileKey": "dbd8352ee8a32bf71982bb0b54216950"
}
返回值
字段 | 备注 |
---|---|
taskId | 音色转换任务ID |
json
{
"code": 200,
"success": true,
"msg": "操作成功",
"data": {
"taskId": 1778319033905385473
}
}
4. 获取音色转换任务状态
/v1/getVoiceConvertTaskInfo/{taskId}
请求参数 将transformId拼在URL最后
注意:该接口为POST请求
返回数据
字段 | 备注 |
---|---|
id | 任务ID |
status | 任务状态:Ready 准备中, Transitioning 处理中, Completed 已完成, Failed 失败 |
timbreId | 音色ID |
audioUrl | 转换后文件下载链接(仅在状态为Completed时返回) |
updateTime | 更新时间 |
createTime | 创建时间 |
json
{
"code": 200,
"success": true,
"msg": "操作成功",
"data": {
"id": "835994",
"userId": "10001",
"timbreId": "30065",
"audioUrl": "https://vc-cdn-b.dubbingx.com/acb4a6fd58cb3bb16c47dd779c8380f7/685e403f/10001/30065/baaf1037b5c143dbaf8f005d20f8e11d.wav",
"status": "Completed",
"updateTime": "2025-06-27 13:54:50",
"createTime": "2025-06-27 13:54:48"
},
"time": "2025-06-27 13:54:55",
"traceId": "1938476115134963713"
}