语音合成 - TTS - 米可智能 API

请求参数

Header 参数

Authorization

string

必需

您的的 api key

示例值:

******

Body 参数application/json

type

enum<string>

音色类型（原 mode 参数）

必需

使用的 voiceId 是内置还是定制的音色。custom: 定制音色；builtIn: 内置音色

枚举值:

custombuiltIn

示例值:

custom 或 builtIn

voiceId

string

音色Id

必需

内置或定制音色的 ID

text

string

需要合成的文本

必需

需要合成的文本内容

notify

string

回调地址

必需

回调地址，用于接收任务结果，任务结果数据会通过 POST 请求发送到该地址

model

enum<string> | enum<null>

定制音色的语音合成模型（仅限 type 为 custom 时）

可选

mars_v3 (或 mars)：支持 15 种语言，速度更快；venus_v2 (或 venus)：支持普通话、英语、日语、韩语、粤语等五种语言，音色质量更好；mars_v2，相对于 mars_v3，普通话的断句可能更好。

枚举值:

venus_v2mars_v3mars_v2venus（将弃用）mars（将弃用）

默认值:

mars_v3

lang

string

文本的语言

可选

文本的语言（可以参考“语言列表”），使用克隆的音色时必须指定

示例值:

zh-cn

volume

number

音频的音量

可选

音量，取值 0～2，默认 1

默认值:

1

speed

number

音频的语速

可选

语速，取值 0～2，默认 1

默认值:

1

format

enum<string> | enum<null>

输出格式

可选

结果音频的格式，mp3 或 wav，默认 mp3

枚举值:

mp3wav

默认值:

mp3

示例

{
    "type": "builtIn",
    "voiceId": "xiaoling",
    "text": "这是一个测试",
    "model": "venus",
    "lang": "zh-cn",
    "notify": "https://test123.com/notify",
    "volume": 1,
    "speed": 1
}

示例代码

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST 'https://mapi.yunmaovideo.com/api-v1/tts' \
--header 'Authorization: ******' \
--header 'Content-Type: application/json' \
--data-raw '{
    "type": "builtIn",
    "voiceId": "xiaoling",
    "text": "这是一个测试",
    "model": "venus",
    "lang": "zh-cn",
    "notify": "https://test123.com/notify",
    "volume": 1,
    "speed": 1
}'

返回响应

🟢200提交成功

application/json

Body

code

integer

状态码

必需

data

object

返回数据

必需

taskId

string

必需

创建成功的任务 ID

msg

string

返回信息

必需

示例

成功示例成功示例

{
    "code": 0,
    "data": {
        "taskId": "VjZYavdrXhGy"
    },
    "msg": ""
}

🟢200回调-合成成功

🟢200回调-合成失败