Skip to content

TTS API 异步生成文档

基本信息

  • Base URL: https://tts-api.dubbingx.com/

  • 请求方法: 本文档所有请求均为 POST

  • 公共请求头:

    参数
    AuthorizationBearer apiKey
    Content-Typeapplication/json

    apiKey 为用户的 API Key,可在客户端中生成。


目录

  1. 音色相关
  2. 文本处理(可选)
  3. TTS 任务操作
  4. 商务合作

音色相关

1-1. 获取音色列表

  • 接口地址: /v1/getTTSTimbreList
  • 请求说明: 获取官方或自训练音色列表,可筛选、分页、搜索。

请求参数:

字段备注
pageIndex页码
pageSize每页数量
isMyModel是否为自训练模型,不传返回官方音色
keyword关键字搜索(名称/介绍均可)
gradepremium 多语态;ordinary 单语态;不传全选
gender0 女;1 男;不传全选
ageGroup孩童、少年、青年、中年、老年;不传全选

请求示例:

json
{
  "pageIndex": 1,
  "pageSize": 100,
  "grade": "premium",
  "gender": 1,
  "ageGroup": "老年",
  "keyword": "李"
}

返回字段说明:

字段备注
id音色ID
gradepremium/ordinary
gender0女;1男
voiceUrl试听音频
...其它字段见返回示例

返回示例:

json
{
  "code": 200,
  "success": true,
  "msg": "操作成功",
  "data": {
    "total": 1,
    "list": [
      {
        "id": "30002",
        "grade": "premium",
        "isOfficial": true,
        "name": "智吾褚",
        "description": "中青年  稳重   温暖",
        "gender": 1,
        "avatar": "https://public.dubbingx.com/avatar/10092/20240329-143217.png",
        "voiceUrl": "https://public.dubbingx.com/audition/10092/mujin.wav",
        "status": true,
        "createTime": "2023-11-03 18:24:12"
      }
    ]
  }
}

文本处理(可选)

1-2. 根据文本分析情绪并返回(可选)

  • 接口地址: /v2/analyzeEmotion
  • 功能: 分析指定文本的情绪,返回情绪类型与档位。

请求参数:

字段备注
text待分析文本

请求示例:

json
{
  "text": "今天天气真好!!"
}

返回字段说明:

字段备注
data情绪-子类型-档位

返回示例:

json
{
  "code": 200,
  "success": true,
  "msg": "操作成功",
  "data": "开心-正常-3"
}

1-3. 给文本自动添加停顿(可选)

  • 接口地址: /v2/autoPause
  • 功能: 让文本停顿更自然,自动插入 <break /> 标签。

请求参数:

字段备注
text待处理文本

请求示例:

json
{
  "text": "在遥远的东方,有一座被云雾环绕的古老山脉,山脉中隐匿着一个神秘的修仙门派。这里的修士们以“天命”为引导,修炼各种奇妙的法术,旨在突破人类的极限,踏入仙界。!!"
}

返回字段说明:

字段备注
data包含停顿的文本字符串

返回示例:

json
{
  "code": 200,
  "success": true,
  "msg": "操作成功",
  "data": "在遥远的东方<break time=\"0.3\">,有一座被云雾环绕的古老山脉<break time=\"0.4\">,山脉中隐匿着一个神秘的修仙门派<break time=\"0.5\">。这里的修士们以“天命”为引导<break time=\"0.3\">,修炼各种奇妙的法术<break time=\"0.4\">,旨在突破人类的极限<break time=\"0.4\">,踏入仙界<break time=\"0.5\">。"
}

TTS 任务操作

2-1. 发送TTS合成指令(异步返回结果)

V1 版本

  • 接口地址: /v1/addTtsTask

请求参数:

字段备注
voiceId音色ID,见“获取音色列表”
text需要合成的文字,支持 <phoneme><break>
emotion情绪(多语态下可传空自动识别,单语态无需传)
languagezh/jp/en/yue
audioPitch语调,1.0为原音高
audioSpeed语速,1.0为原语速
fileFormatwav/mp3,默认wav
endSilenceDuration结尾静音,ms,默认0,最大10000

控制字段说明:

  • <phoneme>:音素标注,只支持中文,格式<phoneme ph="duan2">段</phoneme>
  • <break>:停顿标签,格式<break time='0.15'/>,最长20秒

请求示例:

json
{
  "voiceId": "30065",
  "emotion": "常规-日常说话-3",
  "language": "zh",
  "text": "你好,<break time=\"0.8\"'/>这是一<phoneme ph=\"duan2\">段</phoneme>测试音频!",
  "fileFormat": "mp3"
}

V2 版本(SSML)

  • 接口地址: /v2/addTtsTask
  • 说明: 使用 SSML 格式,参数全部拼接于 <speak> 标签内

SSML 可用字段及说明:

字段说明
voiceId音色ID
emotion情绪(多语态下可空自动识别,单语态无需传)
languagezh/jp/en/yue
audioPitch语调
audioSpeed语速
phoneme音素标注,见上
break停顿标签,见上

请求示例:

json
{
  "text": "<speak voiceId=\"30065\" language=\"zh\" emotion=\"常规-日常说话-3\" audioPitch=\"1.1\" audioSpeed=\"1.1\">你好,<break time=\"0.8\"'/>这是一<phoneme ph=\"duan2\">段</phoneme>测试音频!</speak>",
  "fileFormat": "mp3"
}

返回字段说明:

字段说明
taskId合成任务的ID

返回示例:

json
{
  "code": 200,
  "success": true,
  "msg": "操作成功",
  "data": {
    "taskId": "1778319033905385473"
  }
}

2-2. 获取合成状态

  • 接口地址: /v1/getTtsTaskInfo/{taskId}
  • 方法: POST
  • 说明: 查询指定任务ID的合成进度及结果

返回字段说明:

字段说明
statusReady(待合成)、Generating(合成中)、Completed(已完成)、Failed(失败)
fileUrl合成完成后音频下载地址(status=Completed时)

返回示例:

json
{
  "code": 200,
  "success": true,
  "msg": "操作成功",
  "data": {
    "id": "1778319033905385473",
    "status": "Completed",
    "language": "zh",
    "fileName": "dce642383ca447b3ac4ed57cd3e5b2b4.wav",
    "fileUrl": "https://tts-bucket.dubbingx.com/10092/30002/dce642383ca447b3ac4ed57cd3e5b2b4.wav?Expires=1712849799&OSSAccessKeyId=LTAI5t8FMBqtNy467wQoCC3t&Signature=x7wCkhlQlCI8DPNdP8kLoPkvk0w%3D",
    "updateTime": "2024-04-11 15:07:59",
    "createTime": "2024-04-11 15:07:52"
  }
}

2-3. 批量获取合成状态

  • 接口地址: /v1/getTtsTaskListInfo
  • 请求参数: 传递 taskId 数组

请求示例:

json
["1778328789218971650","1778328790586314754","1778328790703755265","1778328790888304642"]

返回示例:

json
{
  "code": 200,
  "success": true,
  "msg": "操作成功",
  "data": [
    {
      "id": "1778328789218971650",
      "status": "Completed",
      "language": "zh",
      "fileName": "61a74e1801ef4984ac0c911e815efaa1.wav",
      "fileUrl": "",
      "updateTime": "2024-04-11 15:46:43",
      "createTime": "2024-04-11 15:46:38"
    },
    ...
  ]
}

商务合作

如需商务洽谈、优惠领取,请联系:


版权所有© 智声悦合(杭州)科技有限公司