Home - travisvn/chatterbox-tts-api GitHub Wiki
Chatterbox TTS API Wiki
Welcome to the official documentation for the Chatterbox TTS API!
Chatterbox TTS API is a local, OpenAI-compatible text-to-speech service built with FastAPI. It enables you to generate high-quality, voice-cloned speech from text, with real-time streaming, voice library management, and rich configuration options. Use it anywhere OpenAI's TTS API is supported—locally, privately, and with your own voices.
🚀 Quick Navigation
- Getting Started
- API Reference
- Deployment & Docker
- Voice Upload & Library
- Streaming & Advanced Usage
- Migration & Upgrades
- Troubleshooting & FAQ
- Contributing
💡 Why Chatterbox TTS API?
- OpenAI-Compatible: Drop-in for TTS endpoints, works with Open WebUI, AnythingLLM, and more.
- Voice Cloning: Use your own samples for custom voices.
- Real-Time Streaming: Get speech audio as it’s generated for fast feedback.
- Persistent Voice Library: Upload, manage, and select voices by name.
- FastAPI & Async: Modern Python stack, automatic documentation, and high concurrency.
- Docker & Native: Run anywhere, GPU/CPU auto-detection, optimized builds.
- Open Source, Local, and Private: No cloud required, your voices stay yours.
📖 What’s in This Wiki?
This wiki is organized so you can find the right info fast—whether you’re a user, developer, or contributor.
1. Getting Started
Install, configure, and launch the API in minutes. Tips for both pip and Docker.
2. API Reference
All endpoints, parameters, request/response formats, and example calls.
3. Deployment & Docker
Compose files, GPU/CPU variants, and advanced deployment strategies.
4. Voice Upload & Library
How to upload, manage, persist, and use custom voices.
5. Streaming & Advanced Usage
Real-time streaming, chunking strategies, endpoint aliasing, and performance tuning.
6. Migration & Upgrades
Guides for moving from Flask to FastAPI, pip to uv, and keeping dependencies up-to-date.
7. Troubleshooting & FAQ
Solutions to common problems, error explanations, and where to get help.
8. Contributing
How to get involved, code style, and submitting PRs or issues.
🔗 Resources
For anything missing or unclear, open an issue or suggest a wiki edit.