# Unmute

## Docs

- [Welcome to Unmute](https://mintlify.wiki/kyutai-labs/unmute/introduction.md): Transform text LLMs into voice-enabled conversational AI with real-time speech-to-text and text-to-speech
- [Quick Start](https://mintlify.wiki/kyutai-labs/unmute/quickstart.md): Get Unmute running locally in minutes with Docker Compose
- [Requirements](https://mintlify.wiki/kyutai-labs/unmute/requirements.md): Hardware, software, and configuration prerequisites for running Unmute
- [Docker Compose Deployment](https://mintlify.wiki/kyutai-labs/unmute/deployment/docker-compose.md): Deploy Unmute on a single machine using Docker Compose for a simple, reproducible setup
- [Dockerless Deployment](https://mintlify.wiki/kyutai-labs/unmute/deployment/dockerless.md): Run Unmute services manually without Docker for development or custom setups
- [Docker Swarm Deployment](https://mintlify.wiki/kyutai-labs/unmute/deployment/docker-swarm.md): Scale Unmute across multiple machines with Docker Swarm for production deployments
- [Remote Access via SSH](https://mintlify.wiki/kyutai-labs/unmute/deployment/remote-access.md): Access Unmute running on a remote server from your local browser using SSH port forwarding
- [HTTPS Configuration](https://mintlify.wiki/kyutai-labs/unmute/deployment/https.md): Enable HTTPS for Unmute to allow microphone access without SSH tunneling
- [Hugging Face Setup](https://mintlify.wiki/kyutai-labs/unmute/configuration/huggingface-setup.md): Configure Hugging Face Hub access for downloading LLM models
- [GPU Setup](https://mintlify.wiki/kyutai-labs/unmute/configuration/gpu-setup.md): Configure NVIDIA GPU access for running Unmute's AI models
- [Environment Variables](https://mintlify.wiki/kyutai-labs/unmute/configuration/environment-variables.md): Complete reference for configuring Unmute through environment variables
- [Architecture Overview](https://mintlify.wiki/kyutai-labs/unmute/architecture/overview.md): High-level architecture of the Unmute real-time voice conversation system
- [Core Components](https://mintlify.wiki/kyutai-labs/unmute/architecture/components.md): Detailed breakdown of Unmute's core components and their implementations
- [Data Flow & Timing](https://mintlify.wiki/kyutai-labs/unmute/architecture/data-flow.md): Detailed data flow and timing characteristics of the Unmute system
- [Speech-to-Text](https://mintlify.wiki/kyutai-labs/unmute/architecture/speech-to-text.md): Kyutai STT model integration and real-time transcription architecture
- [Text-to-Speech](https://mintlify.wiki/kyutai-labs/unmute/architecture/text-to-speech.md): Kyutai TTS model integration and real-time audio synthesis architecture
- [LLM Integration](https://mintlify.wiki/kyutai-labs/unmute/architecture/llm-integration.md): Language model integration, streaming, and conversation management
- [Backend Architecture](https://mintlify.wiki/kyutai-labs/unmute/architecture/backend.md): Deep dive into the Unmute backend service implementation
- [Frontend Architecture](https://mintlify.wiki/kyutai-labs/unmute/architecture/frontend.md): Next.js frontend implementation and WebSocket client
- [WebSocket Protocol](https://mintlify.wiki/kyutai-labs/unmute/architecture/websocket-protocol.md): Real-time bidirectional communication protocol for audio streaming and conversation management
- [WebRTC & Audio Processing](https://mintlify.wiki/kyutai-labs/unmute/architecture/webrtc.md): Audio streaming, encoding, and real-time processing in the Unmute system
- [Voices and Characters](https://mintlify.wiki/kyutai-labs/unmute/guides/voices-and-characters.md): Customize conversation personalities and voice characteristics in Unmute
- [Using External LLM Servers](https://mintlify.wiki/kyutai-labs/unmute/guides/external-llm.md): Connect Unmute to OpenAI, Ollama, or other OpenAI-compatible LLM providers
- [Building a Custom Frontend](https://mintlify.wiki/kyutai-labs/unmute/guides/custom-frontend.md): Create your own client application using the Unmute WebSocket protocol
- [Tool Calling](https://mintlify.wiki/kyutai-labs/unmute/guides/tool-calling.md): Enable LLM function calling and external tool integration in Unmute
- [Multi-GPU Setup](https://mintlify.wiki/kyutai-labs/unmute/guides/multi-gpu.md): Configure Unmute to use multiple GPUs for improved performance and reduced latency
- [Performance Tuning](https://mintlify.wiki/kyutai-labs/unmute/guides/performance-tuning.md): Optimize Unmute's latency, throughput, and resource utilization for production deployments
- [Monitoring](https://mintlify.wiki/kyutai-labs/unmute/guides/monitoring.md): Track Unmute's performance and health with Prometheus and Grafana
- [Debugging](https://mintlify.wiki/kyutai-labs/unmute/guides/debugging.md): Troubleshoot and debug Unmute issues using built-in tools and diagnostic features
- [WebSocket Overview](https://mintlify.wiki/kyutai-labs/unmute/api/websocket-overview.md): Real-time WebSocket API for voice conversations in Unmute
- [Client Events](https://mintlify.wiki/kyutai-labs/unmute/api/client-events.md): Events sent from client to server via WebSocket
- [Server Events](https://mintlify.wiki/kyutai-labs/unmute/api/server-events.md): Events sent from server to client via WebSocket
- [Session Management](https://mintlify.wiki/kyutai-labs/unmute/api/session-management.md): Configure voice, instructions, and conversation settings
- [UnmuteHandler](https://mintlify.wiki/kyutai-labs/unmute/api/python/unmute-handler.md): Main async stream handler that orchestrates speech-to-text, text-to-speech, and LLM components for real-time voice conversations
- [SpeechToText](https://mintlify.wiki/kyutai-labs/unmute/api/python/speech-to-text.md): WebSocket-based client for real-time speech-to-text transcription with pause detection
- [TextToSpeech](https://mintlify.wiki/kyutai-labs/unmute/api/python/text-to-speech.md): WebSocket-based client for real-time text-to-speech synthesis with voice customization
- [LLM Utils](https://mintlify.wiki/kyutai-labs/unmute/api/python/llm-utils.md): Utilities for streaming LLM completions and preprocessing conversation history
- [Chatbot](https://mintlify.wiki/kyutai-labs/unmute/api/python/chatbot.md): Conversation state management and message history
- [Utilities](https://mintlify.wiki/kyutai-labs/unmute/api/python/utilities.md): Helper classes and functions for Unmute components
- [Health Check](https://mintlify.wiki/kyutai-labs/unmute/api/rest/health.md): Monitor the status of Unmute backend services
- [Voice Cloning](https://mintlify.wiki/kyutai-labs/unmute/api/rest/voice-cloning.md): Clone voices from audio samples and manage voice donations


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.