开箱必看说明

最后修改时间: 36分钟之前

责任人: Leo

已上线

郑重说明

菜包音频基于开源库 GPT-SoVITS 开发，菜包音频不拥有任何音色版权。

采用多节点架构，合成服务和克隆服务是分开部署的，且均支持实时动态增减节点。创建合成任务or克隆任务时，会根据任务量自动分配到不同的节点执行任务。

后续菜包音频的代码进一步完善之后会有完整开源计划，敬请关注。

克隆音色必备

2分钟以上的语料素材
4-7秒的参考音频
音频格式为wav

克隆说明

音色克隆最少需要准备2分钟以上的语料素材。
同时还需要用剪映在语料素材中切一段4-7秒的音频作为参考音频。
菜包音频在合成音频的时候会根据这个参考的特征做合成，参考音频也很重要。

克隆一般在3-10分钟不等，具体时间看节点任务量。

合成音频流程

调用获取音色列表接口,获取可用的音色名称和ID
使用音色ID调用创建任务接口,提交文本合成任务
使用返回的task_id调用查询任务接口,获取合成进度和结果
当任务状态为完成(task_status=1)时,即可获取到合成的音频URL

提示: 建议先调用获取音色列表接口获取最新的音色信息,避免使用过期或无效的音色ID。

创建任务

最后修改时间: 7小时前

责任人: 未设置

开发中

POST https://caibaotts.tingwu.co/api/zbtask.php

Query 参数

参数名	类型	说明	是否必填	示例值
action	string	固定传	必填	create_caibao_task
apikey	string	apikey	必填	sk_khsHbsKnhcU

Body 参数 (multipart/form-data)

参数名	类型	说明	是否必填	示例值
language	string	语言（选项：中文/英文/中英混合）	必填	中文
text	string	需要合成的文本内容	必填	你好，世界！
voice_id	string	音色ID	必填	479bf79c1239
is_cache	integer	是否需要缓存命中	非必填	需要：0，不需要：1

返回示例

{
  "error": 0,
  "msg": "任务创建成功",
  "task": {
    "task_id": 116537,
    "hash": "5c99b34c7dcda508111749f6b18b82c4087276f6ec15717bb0a405c1fc0ff759",
    "anchor_type": "主播东东",
    "language": "中文",
    "text": "欢迎哥哥姐姐们来到沪富贵生鲜火锅的直播间，最近想带家人朋友们吃一次火锅吗？",
    "task_status": 0,
    "add_time": "2025-01-04 17:20:54",
    "apikey": "ak_q02bcd9dis0p",
    "voice_id": "d3f998ced2ce",
    "unique_task_id": "task_egod2iv"
  }
}

特殊说明

返回的内容中，task_id 为最重要字段，可用于任务查询接口查询任务状态和结果。

返回字段说明

字段名	类型	说明
error	integer	错误码，0表示成功
msg	string	返回信息
task	object	任务信息对象
└─ task_id	integer	任务ID
└─ hash	string	任务哈希值
└─ anchor_type	string	主播类型
└─ language	string	语言类型
└─ text	string	合成文本内容
└─ task_status	integer	任务状态
└─ add_time	string	任务创建时间
└─ apikey	string	API密钥
└─ voice_id	string	语音ID
└─ unique_task_id	string	唯一任务ID

获取任务详情

最后修改时间: 1小时前

责任人: 未设置

开发中

GET https://caibaotts.tingwu.co/api/zbtask.php

Query 参数

参数名	类型	说明	是否必填	示例值
action	string	固定传入	必填	get_task_detail
task_id	integer	任务ID，创建任务接口返回的task_id	必填	69535
apikey	string	apikey	必填	sk_khsHbsKnhcU

返回示例

{
    "error": 0,
    "msg": "获取成功",
    "task": {
        "task_id": "69535",
        "hash": "5c99b34c7dcda508111749f6b18b82c4087276f6ec15717bb0a405c1fc0ff759",
        "anchor_type": "主播东东",
        "language": "中文",
        "text": "欢迎哥哥姐姐们来到沪富贵生鲜火锅的直播间，最近想带家人朋友们吃一次火锅吗？",
        "task_status": "1",
        "add_time": "2024-12-28 21:04:34",
        "update_time": "2024-12-28 21:04:37",
        "audio_url": "https://zhubogpt.tos-cn-shanghai.volces.com/tts-audio/output/output_wav/0d5b7bc43eef60e014a4e4077417b3d5092ad3dc5ab4a059b88ea5c759eb069c.wav",
        "apikey": "sk_khsHbsKnhcU"
    }
}

特殊说明

audio_url字段最重要，最终合成的音频下载地址

返回字段说明

字段名	类型	说明
error	integer	错误码，0表示成功
msg	string	返回信息
└─ task	object	任务信息对象
└─ task_id	string	任务ID
└─ hash	string	任务哈希值
└─ anchor_type	string	主播音色
└─ language	string	语言类型
└─ text	string	转换文本内容
└─ task_status	string	任务状态：1-完成，2-处理中，3-失败
└─ add_time	string	创建时间
└─ update_time	string	更新时间
└─ audio_url	string	生成的音频URL
└─ apikey	string	API密钥

获取音色列表

最后修改时间: 1小时前

责任人: 未设置

开发中

GET https://caibaotts.tingwu.co/api/voice.php

Query 参数

参数名	类型	说明	是否必填	示例值
action	string	固定传入	必填	get_caibao_voice_list
apikey	string	apikey	可选	sk_khsHbsKnhcU

返回示例

{
    "error": 0,
    "msg": "获取成功",
    "total": 74,
    "list": [
        {
        "voice_id": "d3f998ced2ce",
        "voice": "主播东东",
        "desc": "",
        "is_public": "1"
        },
        {
        "voice_id": "337789d44644",
        "voice": "果切主播",
        "desc": "",
        "is_public": "1"
        }
    ]
}

特殊说明

voice字段为最重要参数,其值将直接用于创建合成任务,anchor_type参数就是voice的值。

字段说明

字段名	类型	说明
error	integer	错误码，0表示成功
msg	string	返回信息
total	integer	总记录数
list	array	主播列表数据
└─ voice_id	string	声音ID
└─ voice	string	主播名称
└─ desc	string	主播描述
└─ is_public	integer	是否公开：1-是，2-否

创建克隆任务

最后修改时间: 1小时前

责任人: 未设置

开发中

POST https://caibaotts.tingwu.co/api/voiceClone.php

Body 参数 (multipart/form-data)

参数名	类型	说明	是否必填	示例值
type	string	固定传入	必填	upload
voiceCloningName	string	音色名称	必填	测试音色
voiceCloningDesc	string	描述	必填
voiceCloningAvatar	string	头像url	非必填
voiceCloningAudio	string	语料音频url	必填
voiceCloningReferAudio	string	参考音频url	必填
apikey	string	apikey	必填	ak_i6gaj6gefuh1

返回示例

{
    "error": 0,
    "msg": "克隆任务提交成功",
    "data": {
        "voiceID": "S_j818f9gga1w1"
    }
}

特殊说明

返回的内容中，voiceID 为最重要字段，可用于克隆任务查询接口查询任务状态和结果。

获取克隆任务详情

最后修改时间: 7小时前

责任人: 未设置

开发中

GET https://caibaotts.tingwu.co/api/voice.php

Query 参数

参数名	类型	说明	是否必填	示例值
action	string	固定传	必填	get_voice_clon_detail
voice_id	string	音色ID	必填	ak_o82y4egwoyxd

返回示例

{
    "error": 0,
    "msg": "获取成功",
    "data": {
        "id": "217",
        "voice_id": "ak_o82y4egwoyxd",
        "voiceCloningName": "测试音频",
        "voiceCloningDesc": "测试音频测试音频测试音频",
        "voiceCloningAvatar": "",
        "voiceCloningAudio": "",
        "voiceCloningReferAudio": "",
        "cloneStatus": "2",
        "created_at": "2025-01-04 17:50:04",
        "update_at": "2025-01-04 17:50:04"
    }
}

返回字段说明

字段名	类型	说明
error	integer	错误码，0表示成功
msg	string	返回信息
data	object	克隆任务信息对象
└─ id	integer	克隆任务ID，自增主键
└─ voiceID	string	唯一ID
└─ voiceCloningName	string	克隆音色名称，必填
└─ voiceCloningDesc	text	克隆音色描述
└─ voiceCloningAvatar	string	克隆音色头像URL
└─ voiceCloningAudio	string	克隆音频URL
└─ voiceCloningReferAudio	string	参考音频URL
└─ cloneStatus	integer	克隆状态：1待克隆 2成功 3失败 4进行中
└─ created_at	datetime	创建时间
└─ update_at	datetime	更新时间

菜包音频API文档

菜包音频API文档

开箱必看说明

郑重说明

克隆音色必备

克隆说明

合成音频流程

创建任务

Query 参数

Body 参数 (multipart/form-data)

返回示例

特殊说明

返回字段说明

获取任务详情

Query 参数

返回示例

特殊说明

返回字段说明

获取音色列表

Query 参数

返回示例

特殊说明

字段说明

创建克隆任务

Body 参数 (multipart/form-data)

返回示例

特殊说明

获取克隆任务详情

Query 参数

返回示例

返回字段说明