T2A API接口

开发环境

POST

/v1/text_to_speech

3.2 返回(response)参数

请求成功

二进制音频信息

Content-Type：audio/mpeg

请求失败

参数	语义	类型	备注
base_resp	如果请求出错，对应的错误状态码和详情
base_resp.status_code	状态码	int64	1000，未知错误1001，超时1002，触发限流1004，鉴权失败1013，服务内部错误2013，输入格式信息不正常
trace_id	生成id	string	用于在咨询/反馈时帮助定位问题
base_resp.status_msg	错误详情	string

该接口支持基于自然语言交互生成回复的能力。接口本身为无状态接口，即单次调用时，模型所接收到的信息量仅为接口传入内容，不涉及业务逻辑，同时模型也不存储您传入的数据。

该接口支持以下功能：

1、支持音量、语调、语速调整；

2、支持混音功能；

3、支持固定间隔时间控制；

该接口的适用场景：短句生成、语音聊天、在线社交等

请求示例

Shell

JavaScript

Java

Swift

curl --location --request POST 'http://dev-cn.your-api-server.com/v1/text_to_speech?GroupId=
$group_id' \
--header 'Authorization: Bearer $
{api_key}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "voice_id": "male-qn-qingse",// 如同时传入voice_id和timber_weights时，则会自动忽略voice_id，以timber_weights传递的参数为准
    "text": "你好",//如需要控制停顿时长，则增加输入<#X#>，X取值0.01-99.99，单位为秒，如：你<#5#>好（你与好中间停顿5秒）
    "model": "speech-01",
    "speed": 1.0,
    "vol": 1.0,
    "pitch": 0,
    "timber_weights": [
        {
            "voice_id": "male-qn-qingse",
            "weight": 1
        },
        {
            "voice_id": "female-shaonv",
            "weight": 1
        },
        {
            "voice_id": "female-yujie",
            "weight": 1
        },
        {
            "voice_id": "audiobook_male_2",
            "weight": 1
        }
    ]
}'

响应示例

{}

请求参数

Query 参数

GroupId

string

必需

该值应拼接在调用API的url末尾

示例值:

$group_id

Header 参数

Authorization

string

必需

示例值:

Bearer $ {api_key}

Content-Type

string

必需

示例值:

application/json

Body 参数application/json

voice_id

string

必需

如同时传入voice_id和timber_weights时，则会自动忽略voice_id，以timber_weights传递的参数为准

text

string

必需

如需要控制停顿时长，则增加输入<#X#>，X取值0.01-99.99，单位为秒，如：你<#5#>好（你与好中间停顿5秒）

model

string

调用的模型版本

必需

speed

integer

生成声音的语速

可选

可选，默认值为1.0取值越大，语速越快

vol

integer

范围(0, 10]

可选

可选，默认值为1.0取值越大，音量越高

pitch

integer

生成声音的语调

可选

可选，默认值为0（0为原音色输出，取值需为整数）

timber_weights

array [object {2}]

音色相关信息

可选

音色相关信息，详见下方字段

voice_id

string

请求的音色编号

必需

支持系统音色(id)以及复刻音色（id）两种类型，其中系统音色（ID）如下：青涩青年音色(male-qn-qingse)精英青年音色(male-qn-jingying)霸道青年音色(male-qn-badao)青年大学生音色(male-qn-daxuesheng)少女音色(female-shaonv)御姐音色(female-yujie)成熟女性音色(female-chengshu)甜美女性音色(female-tianmei)男性主持人(presenter_male)女性主持人(presenter_female)男性有声书1(audiobook_male_1)男性有声书2(audiobook_male_2)女性有声书1(audiobook_female_1)女性有声书2(audiobook_female_2)青涩青年音色-beta（male-qn-qingse-jingpin）精英青年音色-beta（male-qn-jingying-jingpin）霸道青年音色-beta（male-qn-badao-jingpin）青年大学生音色-beta（male-qn-daxuesheng-jingpin）少女音色-beta（female-shaonv-jingpin）御姐音色-beta（female-yujie-jingpin）成熟女性音色-beta（female-chengshu-jingpin）甜美女性音色-beta（female-tianmei-jingpin）

weight

integer

权重

必需

最多支持4种音色混合，取值为整数，单一音色取值占比越高，合成音色越像；

示例

返回响应

🟢200成功

application/json

Body

object {0}

修改于 2024-01-04 06:24:58

T2A 快速接入

字典功能（Dictionary）

T2A API接口

3.2 返回(response)参数#

请求参数

返回响应

3.2 返回(response)参数