TTS Server API接口文档及使用教程
TTS Server API 接口文档及使用教程
本文档详细描述了 TTS Server API 的接口规范和使用方法，旨在帮助开发者快速集成和使用 TTS 服务，将文本转换为自然流畅的语音。
1. API 概述
TTS Server 提供 RESTful API 接口，支持多种语言和语音，可以根据用户需求定制发音、语速、音调等参数。API 使用 JSON 格式进行数据交换，方便开发者进行集成。
2. 接口认证
为了保证 API 的安全性，所有请求都需要进行身份验证。目前支持 API Key 认证方式。
- API Key 认证: 用户需要在平台上申请 API Key，并在每个请求的 Header 中添加
Authorization: Bearer <API_KEY>。
3. 接口说明
3.1 语音合成接口 /synthesize
该接口用于将文本转换为语音。
请求方法: POST
请求参数:
| 参数名 | 类型 | 必填 | 描述 |
|---|---|---|---|
| text | String | 是 | 需要转换的文本内容，支持 UTF-8 编码。 |
| voice | String | 否 | 指定使用的语音，例如 "zh-CN-Standard-A"。默认使用系统默认语音。 |
| language | String | 否 | 指定语言，例如 "zh-CN"。如果未指定，则根据 voice 参数自动识别。 |
| speed | Float | 否 | 语速，取值范围 0.5 - 2.0，默认值为 1.0。 |
| pitch | Float | 否 | 音调，取值范围 -10.0 - 10.0，默认值为 0.0。 |
| volume | Float | 否 | 音量，取值范围 0.0 - 1.0，默认值为 1.0。 |
| format | String | 否 | 输出音频格式，支持 "mp3", "wav", "pcm" 等，默认值为 "mp3"。 |
| sample_rate | Integer | 否 | 采样率，例如 8000, 16000, 22050, 44100 等。 |
请求示例:
json
{
"text": "你好，世界！",
"voice": "zh-CN-Standard-A",
"speed": 1.2,
"format": "mp3"
}
响应参数:
| 参数名 | 类型 | 描述 |
|---|---|---|
| audio | String | Base64 编码的音频数据。 |
| format | String | 音频格式。 |
响应示例:
json
{
"audio": "data:audio/mp3;base64,/9j/4AAQSkZJRgABAQAAAQABAAD...",
"format": "mp3"
}
3.2 获取支持的语音列表接口 /voices
该接口用于获取 TTS Server 支持的语音列表。
请求方法: GET
请求参数: 无
响应参数:
| 参数名 | 类型 | 描述 |
|---|---|---|
| voices | Array | 语音列表。 |
响应示例:
json
{
"voices": [
{
"name": "zh-CN-Standard-A",
"language": "zh-CN",
"gender": "female",
"sample_rate": 16000
},
{
"name": "en-US-Standard-B",
"language": "en-US",
"gender": "male",
"sample_rate": 22050
}
]
}
4. 使用教程
以下示例演示如何使用 Python 调用 TTS Server API。
```python
import requests
import base64
API_KEY = "YOUR_API_KEY"
API_ENDPOINT = "https://tts-server.example.com/api/v1"
def synthesize_speech(text, voice="zh-CN-Standard-A", format="mp3"):
headers = {
"Authorization": f"Bearer {API_KEY}",
"Content-Type": "application/json"
}
data = {
"text": text,
"voice": voice,
"format": format
}
response = requests.post(f"{API_ENDPOINT}/synthesize", headers=headers, json=data)
if response.status_code == 200:
audio_data = response.json()["audio"]
audio_bytes = base64.b64decode(audio_data.split(",")[1])
with open("output.mp3", "wb") as f:
f.write(audio_bytes)
print("语音合成成功，音频文件保存为 output.mp3")
else:
print(f"语音合成失败: {response.status_code} - {response.text}")
synthesize_speech("这是一段测试文本。")
```
5. 错误码
| 错误码 | 描述 |
|---|---|
| 400 | 请求参数错误。 |
| 401 | 认证失败。 |
| 404 | 接口不存在。 |
| 500 | 服务器内部错误。 |
6. 最佳实践和注意事项
- 合理设置请求参数，根据实际需求选择合适的语音、语速、音调等。
- 处理 API 返回的错误码，并进行相应的错误处理。
- 对于长文本，可以将其分割成多个短文本进行合成，以提高效率和稳定性。
- 关注 API 使用限制，例如请求频率、并发数等。
7. 未来展望
TTS Server API 将持续更新和改进，未来将支持更多语言和语音，并提供更丰富的功能，例如：
- 支持 SSML 标记语言，实现更精细的语音控制。
- 提供异步合成接口，支持大批量文本的转换。
- 提供实时语音合成接口，支持低延迟的语音输出。
- 集成更多语音合成引擎，提供更优质的语音效果。
我们致力于为开发者提供更加便捷、高效、稳定的 TTS 服务，帮助开发者构建更具吸引力的语音应用。
希望本篇文章能帮助您更好地理解和使用 TTS Server API。 如果您有任何疑问或建议，请联系我们。