# VoicEra

- [Welcome to VoicEra](https://voicera.mintlify.app/docs/guides/index.md): Open-source, self-hosted voice AI platform for real-time telephony agents in multiple languages.
- [Introduction](https://voicera.mintlify.app/docs/guides/introduction/index.md): What VoicEra is, how it works, and what people build with it.
- [What is VoicEra](https://voicera.mintlify.app/docs/guides/introduction/what-is-voicera.md): A plain-language overview of what VoicEra does and who it is for.
- [How it works](https://voicera.mintlify.app/docs/guides/introduction/how-it-works.md): What happens, end to end, when a call reaches a VoicEra agent.
- [Use cases](https://voicera.mintlify.app/docs/guides/introduction/use-cases.md): What people build with VoicEra, and what each one takes to configure.
- [Quickstart](https://voicera.mintlify.app/docs/guides/quickstart/index.md): From an empty machine to a working voice agent, in order.
- [Prerequisites](https://voicera.mintlify.app/docs/guides/quickstart/prerequisites.md): Hardware, software, and accounts you need before installing VoicEra.
- [Install and run](https://voicera.mintlify.app/docs/guides/quickstart/install-and-run.md): Clone the repository, start the Docker stack, and verify every service is healthy.
- [Generated secrets and defaults](https://voicera.mintlify.app/docs/guides/quickstart/secrets-and-defaults.md): The secrets VoicEra generates, the defaults it ships, and what you must change.
- [Using the dashboard](https://voicera.mintlify.app/docs/guides/dashboard/index.md): Run VoicEra from your browser — no terminal, no code.
- [Sign up and get set up](https://voicera.mintlify.app/docs/guides/dashboard/sign-up.md): Create your account and connect the AI services your agent will use.
- [Create your first agent](https://voicera.mintlify.app/docs/guides/dashboard/create-an-agent.md): Build a phone agent step by step, no config files.
- [Test and call with your agent](https://voicera.mintlify.app/docs/guides/dashboard/make-a-call.md): Talk to your agent from your browser, then give it a real phone number.
- [Run a calling campaign](https://voicera.mintlify.app/docs/guides/dashboard/run-a-campaign.md): Upload a list of phone numbers and have your agent call all of them.
- [Everyday tasks](https://voicera.mintlify.app/docs/guides/dashboard/everyday-tasks.md): Upload documents, check call history, and manage your team.
- [Core concepts](https://voicera.mintlify.app/docs/guides/concepts/index.md): How VoicEra works — the ideas behind the code, in dependency order.
- [Architecture](https://voicera.mintlify.app/docs/guides/concepts/architecture.md): High-level architecture of VoicEra, explained with the C4 model.
- [Voice pipeline](https://voicera.mintlify.app/docs/guides/concepts/voice-pipeline.md): How Pipecat assembles STT, LLM, and TTS into a real-time conversation.
- [Data flow](https://voicera.mintlify.app/docs/guides/concepts/data-flow.md): Where every piece of data lives and how it moves between services.
- [Agents and agent categories](https://voicera.mintlify.app/docs/guides/concepts/agents.md): Agents, the two agent categories, and what the API provisions for you.
- [Campaigns](https://voicera.mintlify.app/docs/guides/concepts/campaigns.md): How outbound campaigns are scheduled, dispatched, retried, and halted.
- [Calls and call artifacts](https://voicera.mintlify.app/docs/guides/concepts/calls.md): Call logs, call types and statuses, and where transcripts and recordings live.
- [Telephony model](https://voicera.mintlify.app/docs/guides/concepts/telephony-model.md): How VoicEra stays provider-agnostic across Vobiz and Plivo.
- [Knowledge base (RAG)](https://voicera.mintlify.app/docs/guides/concepts/knowledge-base-rag.md): Grounding an agent's answers in your own documents.
- [Glossary](https://voicera.mintlify.app/docs/guides/concepts/glossary.md): Definitions of the terms used throughout the VoicEra documentation.
- [Running a campaign](https://voicera.mintlify.app/docs/guides/operator/running-a-campaign.md): Upload contacts, start a campaign, watch it run, and read the report.
- [Managing knowledge documents](https://voicera.mintlify.app/docs/guides/operator/managing-knowledge.md): Upload, list, and delete knowledge documents.
- [Daily operations](https://voicera.mintlify.app/docs/guides/operator/operations.md): Health checks, logs, backups, and capacity.
- [FAQ](https://voicera.mintlify.app/docs/guides/operator/faq.md): Common questions about running VoicEra.
- [Docker Compose](https://voicera.mintlify.app/docs/guides/deployment/docker-compose.md): The reference Compose stack, service by service.
- [Production deployment](https://voicera.mintlify.app/docs/guides/deployment/production.md): What to change before running VoicEra anywhere that matters.
- [Public voice URLs](https://voicera.mintlify.app/docs/guides/deployment/public-voice-urls.md): Exposing the runtime so telephony providers can reach it.
- [Self-hosted models](https://voicera.mintlify.app/docs/guides/deployment/self-hosted-models.md): Pointing VoicEra at your own model server instead of cloud providers.
- [Security hardening](https://voicera.mintlify.app/docs/guides/deployment/security-hardening.md): What to change before exposing a VoicEra deployment.
- [Troubleshooting](https://voicera.mintlify.app/docs/guides/troubleshooting/index.md): Symptom-first index — find your error message, get the fix.
- [Common issues](https://voicera.mintlify.app/docs/guides/troubleshooting/common-issues.md): The failures people hit most often when starting or running VoicEra.
- [Voice and audio](https://voicera.mintlify.app/docs/guides/troubleshooting/voice-and-audio.md): Diagnosing silence, one-way audio, distortion, and interruption problems.
- [Telephony](https://voicera.mintlify.app/docs/guides/troubleshooting/telephony.md): Diagnosing webhooks, Stream XML, number linking, and recording retrieval.
- [Campaigns](https://voicera.mintlify.app/docs/guides/troubleshooting/campaigns.md): Diagnosing stuck campaigns, tripped breakers, and workers that are not picking up jobs.
- [Deployment](https://voicera.mintlify.app/docs/guides/troubleshooting/deployment.md): Container, proxy, volume, and image problems in a deployed stack.
- [Legal](https://voicera.mintlify.app/docs/guides/legal/index.md): Licence, code of conduct, and how to report a vulnerability.
- [License](https://voicera.mintlify.app/docs/guides/legal/license-info.md): VoicEra is distributed under the Apache License 2.0.
- [Code of conduct](https://voicera.mintlify.app/docs/guides/legal/code-of-conduct.md): The standards expected of everyone participating in the VoicEra project.
- [Security policy](https://voicera.mintlify.app/docs/guides/legal/security.md): How to report a security vulnerability in VoicEra.
- [Developer](https://voicera.mintlify.app/docs/developer/index.md): Build on VoicEra, extend it, or run it on your own infrastructure.
- [Overview](https://voicera.mintlify.app/docs/developer/services/index.md): The deployable units of VoicEra and which Python package each one runs.
- [API (apps/api)](https://voicera.mintlify.app/docs/developer/services/api.md): The FastAPI backend — routers, service layer, and persistence.
- [Runtime (apps/runtime)](https://voicera.mintlify.app/docs/developer/services/runtime.md): The voice runtime — answer webhook, WebSocket transport, and the Pipecat pipeline.
- [Providers (apps/providers)](https://voicera.mintlify.app/docs/developer/services/providers.md): The providers package — layout, public API, and dependency model.
- [Telephony (apps/telephony)](https://voicera.mintlify.app/docs/developer/services/telephony.md): The telephony package — clients, XML, serializers, and webhooks.
- [Workers and orchestrator](https://voicera.mintlify.app/docs/developer/services/workers.md): The ARQ worker and the campaign orchestrator.
- [Model server](https://voicera.mintlify.app/docs/developer/model-server/index.md): Run STT, TTS, and LLM on your own GPUs behind one gateway.
- [Overview](https://voicera.mintlify.app/docs/developer/model-server/overview.md): Every self-hosted model in one place, behind one gateway.
- [Slots and models](https://voicera.mintlify.app/docs/developer/model-server/slots-and-models.md): Slots are fixed, models are folders, and swapping one is a one-line edit.
- [Adding a model](https://voicera.mintlify.app/docs/developer/model-server/adding-a-model.md): Add a model folder and a catalogue entry — nothing else changes.
- [STT models](https://voicera.mintlify.app/docs/developer/model-server/stt-models.md): Speech-to-text models and how partial transcripts actually work.
- [TTS models](https://voicera.mintlify.app/docs/developer/model-server/tts-models.md): Text-to-speech models, voices, and audio format negotiation.
- [LLM models](https://voicera.mintlify.app/docs/developer/model-server/llm-models.md): The LLM slot and the model that fills it.
- [Gateway API](https://voicera.mintlify.app/docs/developer/model-server/gateway-api.md): Gateway endpoints and their OpenAI compatibility.
- [Running on GPUs](https://voicera.mintlify.app/docs/developer/model-server/gpu-operations.md): Running the model server on GPUs.
- [Connecting a client](https://voicera.mintlify.app/docs/developer/clients/index.md): The surfaces a client can use to connect to VoicEra.
- [Browser WebSocket agents](https://voicera.mintlify.app/docs/developer/clients/browser-websocket.md): Connecting a browser to a websocket agent with the Pipecat JS client.
- [Telephony agents](https://voicera.mintlify.app/docs/developer/clients/telephony.md): How a telephony provider becomes a client of the runtime.
- [Local setup](https://voicera.mintlify.app/docs/developer/guides/local-setup.md): Run VoicEra from source for development.
- [Repository layout](https://voicera.mintlify.app/docs/developer/guides/repository-layout.md): A map of the VoicEra monorepo.
- [Adding an AI provider](https://voicera.mintlify.app/docs/developer/guides/adding-a-provider.md): Add an STT, TTS, or LLM vendor in six steps.
- [Adding a telephony provider](https://voicera.mintlify.app/docs/developer/guides/adding-a-telephony-provider.md): Add a telephony vendor alongside Vobiz and Plivo.
- [Testing](https://voicera.mintlify.app/docs/developer/guides/testing.md): Running the VoicEra test suites.
- [Contributing](https://voicera.mintlify.app/docs/developer/guides/contributing-guide.md): How to propose changes to VoicEra.
- [Environment variables](https://voicera.mintlify.app/docs/developer/reference/environment-variables.md): Canonical reference for every VoicEra environment variable.
- [Ports and defaults](https://voicera.mintlify.app/docs/developer/reference/ports-and-defaults.md): Every port VoicEra uses, its default, and how to change it.
- [Data model](https://voicera.mintlify.app/docs/developer/reference/data-model.md): VoicEra collections, their documents, and the enumerations that constrain them.
- [Agent configuration](https://voicera.mintlify.app/docs/developer/reference/agent-configuration.md): Every field of an agent's configuration blob.
- [Data store](https://voicera.mintlify.app/docs/developer/reference/data-store.md): Why VoicEra speaks the MongoDB wire protocol to a PostgreSQL database.
- [Multi-tenancy and roles](https://voicera.mintlify.app/docs/developer/reference/multi-tenancy.md): Organisations, memberships, roles, and how every request gets scoped.
- [Provider registry](https://voicera.mintlify.app/docs/developer/reference/provider-registry.md): How VoicEra discovers AI providers and describes them to clients without a hard-coded list.
- [Provider credentials (ProviderAuth)](https://voicera.mintlify.app/docs/developer/reference/provider-auth.md): How organisation credentials are stored, encrypted, and handed to the runtime.
- [Call concurrency and rate limiting](https://voicera.mintlify.app/docs/developer/reference/call-concurrency.md): How VoicEra caps simultaneous calls per organisation and per campaign.
- [Dashboard](https://voicera.mintlify.app/docs/developer/frontend/index.md): The Next.js dashboard — the web console for VoicEra.
- [Overview](https://voicera.mintlify.app/docs/developer/frontend/overview.md): The VoicEra dashboard — the web console for agents, campaigns, and calls.
- [Running the dashboard](https://voicera.mintlify.app/docs/developer/frontend/running.md): Run the dashboard against a local VoicEra stack.
- [Agent creation wizard](https://voicera.mintlify.app/docs/developer/frontend/agent-wizard.md): The multi-step agent creation wizard.
- [Dashboard tour](https://voicera.mintlify.app/docs/developer/frontend/dashboard-tour.md): A tour of the dashboard's pages.
- [Browser test calls](https://voicera.mintlify.app/docs/developer/frontend/test-calls.md): Placing a browser test call from the dashboard.
- [API Reference](https://voicera.mintlify.app/docs/api-reference/index.md): Every HTTP and WebSocket surface VoicEra exposes.
- [API overview](https://voicera.mintlify.app/docs/api-reference/overview.md): Base URL, versioning, request and response conventions.
- [Authentication](https://voicera.mintlify.app/docs/api-reference/authentication.md): Tokens, headers, roles, and organisation scoping.
- [Errors](https://voicera.mintlify.app/docs/api-reference/errors.md): Status codes, error shapes, and what each one means.
- [Endpoints cheatsheet](https://voicera.mintlify.app/docs/api-reference/endpoints-cheatsheet.md): Every VoicEra endpoint on one page, grouped by service.
- [Recipes](https://voicera.mintlify.app/docs/api-reference/recipes.md): End-to-end curl workflows for operating VoicEra, built on the endpoints in this reference.
- [Agents](https://voicera.mintlify.app/docs/api-reference/agents.md): Create, read, update, and delete voice agents.
- [Calls](https://voicera.mintlify.app/docs/api-reference/calls.md): Place calls, register them, and fetch recordings and transcripts.
- [Campaigns](https://voicera.mintlify.app/docs/api-reference/campaigns.md): CSV-driven outbound campaigns: upload, schedule, run, report.
- [Phone numbers](https://voicera.mintlify.app/docs/api-reference/phone-numbers.md): Organisation number inventory, and attaching numbers to agents.
- [Knowledge and RAG](https://voicera.mintlify.app/docs/api-reference/knowledge-and-rag.md): Upload documents and retrieve grounded context.
- [Configuration catalogs](https://voicera.mintlify.app/docs/api-reference/configuration.md): Discover which providers exist and what each one accepts.
- [Provider credentials](https://voicera.mintlify.app/docs/api-reference/provider-auth.md): Store and retrieve encrypted provider API keys.
- [Users and organisations](https://voicera.mintlify.app/docs/api-reference/users-and-orgs.md): Signup, login, membership, roles, and bot tokens.
- [WebSocket API](https://voicera.mintlify.app/docs/api-reference/websocket-api.md): The runtime WebSocket endpoints and their two modes.