docs/README.md

Chatterbox TTS API Documentation

This directory contains detailed documentation for the Chatterbox TTS FastAPI.

📚 Documentation Index

Core Documentation

• API_README.md - Complete FastAPI reference, configuration, and usage examples
• DOCKER_README.md - Docker deployment guide, troubleshooting, and optimization
• STREAMING_API.md - Comprehensive streaming API guide with advanced features

Specialized Features

• STATUS_API.md - Real-time status monitoring and progress tracking
• VOICE_UPLOAD_SUMMARY.md - Voice file upload implementation summary

Technical Guides

• ENDPOINT_ALIASING.md - FastAPI endpoint aliasing system explanation

Migration & Upgrades

• UV_MIGRATION.md - Guide for migrating from pip to uv for better performance and compatibility

🚀 Quick Links

Getting Started

• Quick Start Guide - Main README with installation options
• API Usage Examples - Basic API calls and parameters
• Docker Quick Start - Container deployment

New FastAPI Features

• Interactive API Documentation - Swagger UI and ReDoc
• Type Safety & Validation - Pydantic models and validation
• Async Performance - FastAPI performance benefits
• Streaming TTS - Real-time audio streaming with advanced controls

Common Tasks

• Configuration Options - Environment variables and settings
• Voice Cloning Setup - How to use custom voice samples
• Real-time Status Monitoring - Track TTS processing progress
• Troubleshooting - Common issues and solutions

Advanced Topics

• Performance Tuning - Optimization for different environments
• Security Considerations - Production security setup
• uv Migration Benefits - Why and how to upgrade to uv
• FastAPI Development - Development tools and features
• Streaming Strategies - Optimize streaming for different use cases

🆕 FastAPI Migration Highlights

This project has been migrated from Flask to FastAPI with the following improvements:

• ⚡ 25-40% better performance for JSON responses
• 📚 Automatic API documentation at /docs and /redoc
• 🔒 Type safety with Pydantic validation
• 🚀 Async support for better concurrency
• 🎵 Real-time streaming with advanced chunking strategies
• 🔧 Better developer experience with interactive testing

All existing API endpoints remain fully compatible!

🆘 Need Help?

• 🐛 Issues: GitHub Issues
• 💬 Discord: Project Discord
• 📖 Main README: Back to main documentation
• 📚 API Docs: Interactive documentation (when running locally)

---

💡 Tip: If you're new to the project, start with the main README and then dive into the specific guides based on your deployment method. Don't forget to check out the interactive API documentation at /docs once you have the server running!