API 使用指南
v2.4.0
API端点
POST https://edge-tts.yormb.cn/v1/audio/speech
KEY认证
使用 Bearer Token 认证方式。将您的 API Key 放在 Authorization 请求头中。
Authorization: Bearer YOUR_API_KEY
请求体参数 (JSON)
主要参数
| 参数 | 类型 | 默认值 | 描述 |
|---|---|---|---|
model |
string |
"tts-1" |
模型 ID。支持 tts-1, tts-1-hd,或映射的音色如 tts-1-alloy。 |
input |
string |
必需 | 需要转换为语音的文本。支持任意长度。 |
voice |
string |
"zh-CN-XiaoxiaoNeural" |
直接指定微软的音色名称。当 model 参数未被映射时生效。 |
speed |
number |
1.0 |
语速。范围从 0.25 到 2.0。 |
pitch |
number |
1.0 |
音调。 |
stream |
boolean |
false |
是否使用流式响应。设为 true 可极大降低长文本的首次延迟。 |
concurrency |
number |
10 |
并发请求数。控制同时向微软服务器发送多少个文本块请求。 |
chunk_size |
number |
300 |
文本分块大小(字符数)。Worker 会根据平台限制自动调整此值以确保成功。 |
cleaning_options |
object |
{...} |
一个包含文本清理开关的对象。 |
cleaning_options 参数
| 参数 | 类型 | 默认值 | 描述 |
|---|---|---|---|
remove_markdown |
boolean |
true |
是否移除 Markdown 格式。 |
remove_emoji |
boolean |
true |
是否移除 Emoji。 |
remove_urls |
boolean |
true |
是否移除 URL。 |
remove_line_breaks |
boolean |
true |
是否移除所有空格和换行符。 |
remove_citation_numbers |
boolean |
true |
是否智能移除论文引用标记。 |
custom_keywords |
string |
"" |
自定义要移除的关键词,以逗号分隔。 |
cURL 示例
1. 标准请求
curl --location 'https://edge-tts.yormb.cn/v1/audio/speech' \
--header 'Authorization: Bearer YOUR_API_KEY' \
--header 'Content-Type: application/json' \
--data '{
"model": "tts-1-alloy",
"input": "你好,这是一个标准的语音合成请求。"
}' \
--output standard.mp3
2. 流式请求 (用于长文本)
curl --location 'https://edge-tts.yormb.cn/v1/audio/speech' \
--header 'Authorization: Bearer YOUR_API_KEY' \
--header 'Content-Type: application/json' \
--data '{
"model": "tts-1-nova",
"input": "这是一个流式请求的示例,对于较长的文本,你能更快地听到声音的开头部分。",
"stream": true
}' \
--output streaming.mp3
3. 使用高级过滤选项
curl --location 'https://edge-tts.yormb.cn/v1/audio/speech' \
--header 'Authorization: Bearer YOUR_API_KEY' \
--header 'Content-Type: application/json' \
--data '{
"model": "tts-1-shimmer",
"input": "这段文本包含 **Markdown** 1、一个链接 https://example.com 和一个表情 😂。",
"cleaning_options": {
"remove_markdown": true,
"remove_urls": true,
"remove_emoji": true,
"remove_citation_numbers": true
}
}' \
--output cleaned.mp3
💡 提示: 在Web界面中使用时,您可以在"高级文本清理"部分配置相应的清理选项。支持所有
cleaning_options 参数。
TTS 语音合成
基于 Microsoft Edge TTS · 兼容 OpenAI 格式
API 配置
高级文本清理
{{ status.message }}