1. 请求方式

域名： https://openspeech.bytedance.com
具体请求方式可参考下方示例代码

2. 训练（upload接口）

接口路径: POST/api/v1/mega_tts/audio/upload
接口描述: 提交音频训练音色
认证方式使用Bearer Token，在请求的header中加上"Authorization": "Bearer; {token}"，并在请求的json中填入对应的appid。

AppID/Token/Cluster 等信息可参考 控制台使用FAQ-Q1

请求参数

Header:

Body:

json示例

{
        "speaker_id": "S_*******",
        "appid": "your appid",
        "audios": [{
                "audio_bytes": "base64编码后的音频",
                "audio_format": "wav"
        }],
        "source": 2
}

返回数据

Body:

json示例

{
    "BaseResp":{
        "StatusCode":0,
        "StatusMessage":""
    },
    "speaker_id":"S_*******"
}

3. 状态查询（status接口）

接口路径: POST/api/v1/mega_tts/status
接口描述: 查询音色训练状态

请求参数

Header:

Body:

json示例

{
    "appid": "your appid",
    "speaker_id": "S_*******"
}

返回数据

Body:

json示例

{
    "BaseResp":{
        "StatusCode":0,
        "StatusMessage":""
    },
    "creaet_time":1701055304000,
    "version": "V1",
    "demo_audio": "http://**********.wav"
    "speaker_id":"S_*******",
    "status":2
}

4. 状态码

5. 示例代码

uploadAndStatus.py

1.77KB

音色训练成功后，需要通过调用TTS接口来使用音色合成指定文本的音频。

Websocket

使用账号申请部分申请到的appid&access_token进行调用
文本一次性送入，后端边合成边返回音频数据

HTTP

使用账号申请部分申请到的appid&access_token进行调用
文本全部合成完毕之后，一次性返回全部的音频数据

API接入说明

访问鉴权

1. 鉴权方式说明 公共参数--API签名调用指南-火山引擎 (volcengine.com)
   线上请求地址域名 open.volcengineapi.com

2. 固定公共参数

   Region = "cn-north-1"
   Service = "speech_saas_prod"
   Version = "2023-11-07"
   

3. AKSK获取 访问控制-火山引擎 (volcengine.com)
   说明：Access Key（密钥）管理--API访问密钥（Access Key）-火山引擎 (volcengine.com)

4. 调用方式

   1. SDK SDK概览--API签名调用指南-火山引擎 (volcengine.com)

   2. 直接签名后调用
      结合文档内api说明调用 ListMegaTTSTrainStatus 的例子(*其他语言和使用sdk调用的方式请参考火山鉴权源码说明 一)

   3. 示例代码：
      

      

      sign.py

      6.17KB

      
      

      sign.java

      8.70KB

      
      

      sign.go

      5.07KB

      

错误码

1. 非 2xx 开头的HTTP返回状态码被可以认为是错误

2. 错误的HTTP返回结构体如下

   {
       "ResponseMetadata": {
           "RequestId": "20220214145719010211209131054BC103", // header中的X-Top-Request-Id参数
           "Action": "ListMegaTTSTrainStatus",
           "Version": "2023-11-07",
           "Service": "{Service}",// header中的X-Top-Service参数
           "Region": "{Region}", // header中的X-Top-Region参数
           "Error": {
               "Code": "InternalError.NotCaptured",
               "Message": "xxx"
           }
       }
   }
   

3. "ResponseMetadata.Error.Code" 客户端可以依照这个字段判断错误种类，已知种类和含义如下

   Code	Description
   OperationDenied.InvalidSpeakerID	账号或AppID无权限操作或无法操作SpeakerID列表中的一个或多个实例
   OperationDenied.InvalidParameter	请求体字段不合法（缺失必填字段、类型错误等）
   InternalError.NotCaptured	未知的服务内部错误

API列表

1. 查询 SpeakerID 状态

a. Description
查询已购买的音色状态；如果SpeakerIDs为空则返回账号的AppID下所有的列表（有最大值限制1000）；如果SpeakerIDs不为空则返回对应的结果，且结果总是包含输入的SpeakerID（即使查询不到它）
b. Method: POST
c. Request

d. Response

{
          "ResponseMetadata": {
              "RequestId": "20220214145719010211209131054BC103", // header中的X-Top-Request-Id参数
              "Action": "",
              "Version": "",
              "Service": "{Service}",// header中的X-Top-Service参数
              "Region": "{Region}" // header中的X-Top-Region参数
          },
          "Result":{
                  "Statuses": [
                         {
                              "CreateTime": 1700727790000, // unix epoch格式的创建时间，单位ms
                              "DemoAudio": "https://example.com", // http demo链接
                              "InstanceNO": "Model_storage_meUQ8YtIPm", // 火山引擎实例number
                              "IsActivable": true, // 是否可激活
                              "SpeakerID": "S_VYBmqB0A", // speakerID
                              "State": "Success", // speakerID的状态
                              "Version": "V1", // speakerID已训练过的次数
                              "ExpireTime": 1732895999000, //过期时间
                              "Alias": "", //别名，和控制台同步
                              "AvailableTrainingTimes": 9 //剩余训练次数，激活音色为0
                        },
                        {
                              "SpeakerID": "S_VYBmqB0B", // speakerID
                              "State": "Unknown", // speakerID的状态
                        }
                  ]
          }
      }

e. State of speakerID is an enum with possible values of:

2. 分页查询SpeakerID状态 BatchListMegaTTSTrainStatus

a. Description
查询已购买的音色状态；相比ListMegaTTSTrainStatus 增加了分页相关参数和返回；支持使用token和声明页数两种分页方式；其中，

• 分页token在最后一页为空
• 分页token采用私有密钥进行加密
• 分页接口为新接口，不影响已有接口行为

b. Method: POST
c. Request

d. Response

{
       "ResponseMetadata": {
           "RequestId": "20220214145719010211209131054BC103", // header中的X-Top-Request-Id参数
           "Action": "BatchListMegaTTSTrainStatus",
           "Version": "2023-11-07",
           "Service": "{Service}",// header中的X-Top-Service参数
           "Region": "{Region}" // header中的X-Top-Region参数
       },
       "Result":{
               "AppID": "xxx",
               "TotalCount": 2, // speakerIDs总数量
               "NextToken": "", // NextToken字符串，可发送请求后面的结果; 如果没有更多结果将为空
               "PageNumber": 1, // 使用分页参数时的当前页数
               "PageSize": 2, // 使用分页参数时当前页包含的条数
               "Statuses": [
                      {
                           "CreateTime": 1700727790000, // unix epoch格式的创建时间，单位ms
                           "DemoAudio": "https://example.com", // http demo链接
                           "InstanceNO": "Model_storage_meUQ8YtIPm", // 火山引擎实例Number
                           "IsActivable": true, // 是否可激活
                           "SpeakerID": "S_VYBmqB0A", // speakerID
                           "State": "Success", // speakerID的状态
                           "Version": "V1" // speakerID已训练过的次数
                     },
                     {
                           "SpeakerID": "S_VYBmqB0B", // speakerID
                           "State": "Unknown", // speakerID的状态
                     }
               ]
       }
   }

3. 激活 (activate) SpeakerID

a. Description
对应火山页面的启动音色；如果输入的音色列表中有一个或多个音色不能被激活，或找不到它的记录，那么所有的音色都不会被激活，并且会返回错误 OperationDenied.InvalidSpeakerID；如果输入的音色列表为空，那么返回字段不合法的错误OperationDenied.InvalidParameter；距离音色可被访问可能会有分钟级别延迟；
b. Method: POST
c. Request

d. Response

{
          "ResponseMetadata": {
              "RequestId": "20220214145719010211209131054BC103", // header中的X-Top-Request-Id参数
              "Action": "",
              "Version": "",
              "Service": "{Service}",// header中的X-Top-Service参数
              "Region": "{Region}" // header中的X-Top-Region参数
          },
          "Result":{
                  "Statuses": [
                         {
                              "CreateTime": 1700727790000, // unix epoch格式的创建时间，单位ms
                              "DemoAudio": "https://example.com", // http demo链接
                              "InstanceNO": "Model_storage_meUQ8YtIPm", // volcengine Instance Number
                              "IsActivable": false, // speakerID是否可激活
                              "SpeakerID": "S_VYBmqB0A", // speakerID
                              "State": "Active", // speakerID的状态
                              "Version": "V1" // speakerID已训练过的次数
                        }
                  ]
          }
      }