# VoiceGateway

## Docs

- [Dashboard api](https://docs.voicegateway.dev/api/dashboard-api.md)
- [Http api](https://docs.voicegateway.dev/api/http-api.md)
- [Api](https://docs.voicegateway.dev/api/index.md)
- [Python sdk](https://docs.voicegateway.dev/api/python-sdk.md)
- [Config layers](https://docs.voicegateway.dev/architecture/config-layers.md)
- [Cost tracking](https://docs.voicegateway.dev/architecture/cost-tracking.md)
- [Gateway core](https://docs.voicegateway.dev/architecture/gateway-core.md)
- [Architecture](https://docs.voicegateway.dev/architecture/index.md)
- [Middleware](https://docs.voicegateway.dev/architecture/middleware.md)
- [Provider abstraction](https://docs.voicegateway.dev/architecture/provider-abstraction.md)
- [Security](https://docs.voicegateway.dev/architecture/security.md)
- [Storage](https://docs.voicegateway.dev/architecture/storage.md)
- [voicegw costs](https://docs.voicegateway.dev/cli/costs.md): Display cost summaries from the gateway's request log, broken down by provider and model.
- [voicegw dashboard](https://docs.voicegateway.dev/cli/dashboard.md): Open the VoiceGateway dashboard in your browser. The daemon already serves it; this command just launches the URL.
- [voicegw export-costs](https://docs.voicegateway.dev/cli/export-costs.md): Export per-request cost line items for a date window in CSV or JSON.
- [CLI reference](https://docs.voicegateway.dev/cli/index.md): Every voicegw command, what it does, and where to read more.
- [voicegw init](https://docs.voicegateway.dev/cli/init.md): Scaffold a voicegw.yaml configuration file from the bundled template.
- [voicegw logs](https://docs.voicegateway.dev/cli/logs.md): Show recent request logs from the gateway's SQLite database.
- [voicegw mcp](https://docs.voicegateway.dev/cli/mcp.md): Start the VoiceGateway MCP (Model Context Protocol) server so coding agents can inspect and manage the gateway.
- [voicegw onboard](https://docs.voicegateway.dev/cli/onboard.md): Five-question wizard that writes voicegw.yaml, registers the daemon with your OS service manager, and starts it.
- [voicegw projects / voicegw project](https://docs.voicegateway.dev/cli/projects.md): List all configured projects or show details for a single project.
- [voicegw reconcile](https://docs.voicegateway.dev/cli/reconcile.md): Diff VoiceGateway's recorded costs against a provider's usage export.
- [voicegw replay](https://docs.voicegateway.dev/cli/replay.md): Print the dashboard Replay page URL for a recorded session.
- [voicegw serve / start / stop / restart](https://docs.voicegateway.dev/cli/serve.md): Run the VoiceGateway daemon. serve runs in the foreground; start, stop, restart, daemon-logs, and uninstall-daemon manage the OS-installed service.
- [voicegw smoke-test](https://docs.voicegateway.dev/cli/smoke-test.md): Validate the inference pipeline end-to-end without spinning up a LiveKit server.
- [voicegw status](https://docs.voicegateway.dev/cli/status.md): Show provider configuration status. Useful for verifying setup after editing voicegw.yaml or adding providers via the API.
- [voicegw tui](https://docs.voicegateway.dev/cli/tui.md): Launch the four-tab terminal UI for live monitoring of sessions, costs, logs, and providers.
- [Environment variables](https://docs.voicegateway.dev/configuration/environment-variables.md): Every environment variable VoiceGateway reads (config path, database path, daemon bind, Fernet keys, MCP token) and how ${VAR_NAME} substitution works in voicegw.yaml.
- [Models](https://docs.voicegateway.dev/configuration/models.md): How VoiceGateway identifies every model with a provider/model string, including language and voice suffixes, custom aliases, and example STT, LLM, and TTS model IDs.
- [Observability](https://docs.voicegateway.dev/configuration/observability.md): VoiceGateway's three built-in observability features (latency tracking, cost tracking, and request logging) that run as middleware around every provider call, and how to toggle each one.
- [Projects](https://docs.voicegateway.dev/configuration/projects.md): Per-project cost tracking, budget enforcement, guardrails, and organizational grouping for attributing VoiceGateway costs to specific agents, teams, or customers.
- [Providers](https://docs.voicegateway.dev/configuration/providers.md): All 11 providers VoiceGateway supports, with modality coverage, recommended models, and per-provider config notes.
- [Stacks](https://docs.voicegateway.dev/configuration/stacks.md): Named YAML bundles that map a single name to one STT, one LLM, and one TTS model, used as a documentation and dashboard hint for VoiceGateway projects.
- [voicegw.yaml reference](https://docs.voicegateway.dev/configuration/voicegw-yaml.md): Every top-level section and key in the VoiceGateway config file. Validated with pydantic extra=forbid so typos fail fast at startup.
- [Adding a provider](https://docs.voicegateway.dev/contributing/adding-a-provider.md)
- [Code style](https://docs.voicegateway.dev/contributing/code-style.md)
- [Refreshing pricing](https://docs.voicegateway.dev/contributing/refreshing-pricing.md)
- [Testing](https://docs.voicegateway.dev/contributing/testing.md)
- [Deploy to Fly.io](https://docs.voicegateway.dev/deployment/fly.md): Run the VoiceGateway fleet collector on Fly.io with managed Postgres, automatic HTTPS, and multi-region placement.
- [Deployment](https://docs.voicegateway.dev/deployment/index.md): Self-host the VoiceGateway fleet collector on a VPS, Railway, or Fly.io: Postgres-backed, HTTPS ingest, dashboard.
- [Deploy to Railway](https://docs.voicegateway.dev/deployment/railway.md): Run the VoiceGateway fleet collector on Railway with managed Postgres and automatic HTTPS.
- [Deploy to a VPS](https://docs.voicegateway.dev/deployment/vps.md): Run the VoiceGateway fleet collector on your own server with Docker Compose and Caddy for automatic HTTPS.
- [Basic voice agent](https://docs.voicegateway.dev/examples/basic-voice-agent.md)
- [Budget enforcement](https://docs.voicegateway.dev/examples/budget-enforcement.md)
- [Claude code integration](https://docs.voicegateway.dev/examples/claude-code-integration.md)
- [Docker deployment](https://docs.voicegateway.dev/examples/docker-deployment.md)
- [Fallback chains](https://docs.voicegateway.dev/examples/fallback-chains.md)
- [Examples](https://docs.voicegateway.dev/examples/index.md)
- [Livekit fallback adapter](https://docs.voicegateway.dev/examples/livekit-fallback-adapter.md)
- [Local only](https://docs.voicegateway.dev/examples/local-only.md)
- [Multi project](https://docs.voicegateway.dev/examples/multi-project.md)
- [Openrtc multi agent](https://docs.voicegateway.dev/examples/openrtc-multi-agent.md)
- [Get started](https://docs.voicegateway.dev/get-started.md): Install VoiceGateway, run the onboarding wizard, see your first provider call land in the dashboard. 60 seconds, excluding the time it takes to fetch your provider API key.
- [Agency quickstart](https://docs.voicegateway.dev/guide/agency-quickstart.md): Provision a downstream customer project end-to-end with cross-modality routing and per-project white-label branding.
- [Core Concepts](https://docs.voicegateway.dev/guide/core-concepts.md): Definitions of the key abstractions in VoiceGateway, from the inference module to providers, modalities, projects, and middleware.
- [Cost Reconciliation](https://docs.voicegateway.dev/guide/cost-reconciliation.md): How to compare VoiceGateway's recorded costs against your provider invoices using voicegw reconcile.
- [Is VoiceGateway right for you?](https://docs.voicegateway.dev/guide/decision-tree.md): A short matrix to help you pick the right tool for your workload before you invest time integrating.
- [First agent](https://docs.voicegateway.dev/guide/first-agent.md): Build a working LiveKit voice agent that routes STT / LLM / TTS through VoiceGateway. Costs and latency land in the dashboard automatically.
- [Voice-specific guardrails](https://docs.voicegateway.dev/guide/guardrails.md): Project-scoped, LLM-side guardrails for voice agents, injected through the inference.LLM(...) drop-in path.
- [Installation](https://docs.voicegateway.dev/guide/installation.md): Every install path for VoiceGateway. curl-bash recommended for first-run; pipx / uv / Docker for everything else.
- [Multi-tenant quickstart](https://docs.voicegateway.dev/guide/multi-tenant-quickstart.md): Tag voice sessions with a tenant id, issue scoped virtual API keys, and view or export per-tenant costs from a single deployment.
- [Quick start](https://docs.voicegateway.dev/guide/quick-start.md): Get VoiceGateway running in 5 minutes. Daemon up, dashboard open, one Python script proves the inference factories resolve correctly.
- [What is VoiceGateway?](https://docs.voicegateway.dev/guide/what-is-voicegateway.md): A thin routing layer for LiveKit voice agents with first-class cost tracking and reconciliation across cloud and local providers.
- [](https://docs.voicegateway.dev/index.md)
- [Authentication](https://docs.voicegateway.dev/mcp/authentication.md)
- [Mcp](https://docs.voicegateway.dev/mcp/index.md)
- [Setup](https://docs.voicegateway.dev/mcp/setup.md)
- [Models](https://docs.voicegateway.dev/mcp/tools/models.md)
- [Observability](https://docs.voicegateway.dev/mcp/tools/observability.md)
- [Projects](https://docs.voicegateway.dev/mcp/tools/projects.md)
- [Providers](https://docs.voicegateway.dev/mcp/tools/providers.md)
- [Transports](https://docs.voicegateway.dev/mcp/transports.md)
- [Frequently Asked Questions](https://docs.voicegateway.dev/reference/faq.md): Common questions about VoiceGateway covering production readiness, agent-framework integration, performance overhead, Kubernetes and metrics, S2S, MCP, custom voices, backups, and key rotation.
- [Guardrail prompt reference](https://docs.voicegateway.dev/reference/guardrail-prompts.md): The curated guardrail prompt assets VoiceGateway ships, the runtime wrapper the composer renders active categories into, the per-category instructions, and the reserved report_guardrail_action tool schema.
- [Reconcile File Formats](https://docs.voicegateway.dev/reference/reconcile-formats.md): Schemas the voicegw reconcile command expects when reading provider usage exports.
- [Troubleshooting](https://docs.voicegateway.dev/reference/troubleshooting.md): Common VoiceGateway issues and their fixes, covering missing config, unconfigured providers, budget limits, Ollama connections, decryption errors, Docker dashboard crashes, MCP tooling, asyncio loops, missing plugins, config validation, rate limits, and database locks.
- [Replay storage costs](https://docs.voicegateway.dev/storage/replay-storage-costs.md)

## OpenAPI Specs

- [openapi](https://docs.voicegateway.dev/api-reference/openapi.json)