OpenAI-Compatible Edge-TTS API 使用教程

OpenAI-Compatible Edge-TTS API 使用教程

openai-edge-tts Free, high-quality text-to-speech API endpoint to replace OpenAI, Azure, or ElevenLabs 项目地址: https://gitcode.com/gh_mirrors/op/openai-edge-tts

1. 项目介绍

本项目提供了一个本地化的、与OpenAI兼容的文本转语音（TTS）API，使用edge-tts技术实现。它模拟了OpenAI的TTS端点（/v1/audio/speech），允许用户从文本生成语音，支持多种语音选项和播放速度，与OpenAI API类似。由于edge-tts使用了微软Edge浏览器的在线文本转语音服务，因此完全免费。

2. 项目快速启动

环境准备

• Docker（推荐）：用于容器化设置。
• Python（可选）：本地开发时，需要安装requirements.txt中的依赖。
• ffmpeg（可选）：如果需要音频格式转换，则需要安装ffmpeg。如果只使用mp3格式，则为可选。

克隆仓库

git clone https://github.com/travisvn/openai-edge-tts.git
cd openai-edge-tts

配置环境变量

在项目根目录创建一个.env文件，并设置以下变量：

API_KEY=your_api_key_here
PORT=5050
DEFAULT_VOICE=en-US-AvaNeural
DEFAULT_RESPONSE_FORMAT=mp3
DEFAULT_SPEED=1.0
DEFAULT_LANGUAGE=en-US
REQUIRE_API_KEY=True
REMOVE_FILTER=False
EXPAND_API=True

或者，可以直接复制默认的.env.example文件：

cp .env.example .env

使用Docker启动

推荐使用Docker Compose启动：

docker compose up --build

如果要后台运行Docker Compose，可以添加-d参数：

docker compose up -d

或者，直接使用Docker启动：

docker build -t openai-edge-tts .
docker run -p 5050:5050 --env-file .env openai-edge-tts

如果要后台运行Docker容器，可以添加-d参数：

docker run -d -p 5050:5050 --env-file .env openai-edge-tts

启动后，API服务器将通过http://localhost:5050访问。

使用Python启动

如果希望直接使用Python启动项目，可以按照以下步骤操作：

1. 设置虚拟环境：

   对于macOS/Linux：

   python3 -m venv venv
   source venv/bin/activate
   

   对于Windows：

   python -m venv venv
   venv\Scripts\activate
   

2. 安装依赖：

   pip install -r requirements.txt
   

3. 运行服务器：

   python app/server.py
   

服务器启动后，可以通过http://localhost:5050访问。

3. 应用案例和最佳实践

以下是一个使用curl命令生成语音并保存为mp3文件的例子：

curl -X POST http://localhost:5050/v1/audio/speech \
-H "Content-Type: application/json" \
-H "Authorization: Bearer your_api_key_here" \
-d '{
    "input": "你好，我是一个AI助手！告诉我如何帮助你实现你的想法。",
    "voice": "echo",
    "response_format": "mp3",
    "speed": 1.1
}' \
--output speech.mp3

4. 典型生态项目

本项目的开源生态中没有特别提及的典型项目，但可以与各种需要语音合成的应用或服务集成，例如智能助手、教育软件、语音播报系统等。通过将本项目集成到这些应用中，可以在不需要支付额外费用的情况下提供高质量的文本转语音功能。

openai-edge-tts Free, high-quality text-to-speech API endpoint to replace OpenAI, Azure, or ElevenLabs 项目地址: https://gitcode.com/gh_mirrors/op/openai-edge-tts