# Ringee Documentation - [Introduction](https://docs.ringee.io/introduction.md): Welcome to the Ringee documentation - [How it works](https://docs.ringee.io/howitworks.md): Learn the architecture of Ringee - [Quickstart](https://docs.ringee.io/quickstart.md): Get started with Ringee installation - [Ways to build on Ringee](https://docs.ringee.io/build-on-ringee.md): Choose the right integration surface for what you are building - [Docker Compose](https://docs.ringee.io/installation/docker-compose.md): Deploy Ringee with Docker Compose (recommended) - [Docker (Standalone)](https://docs.ringee.io/installation/docker.md): Run Ringee with standalone Docker containers - [Development Environment](https://docs.ringee.io/installation/development.md): Set up Ringee for local development - [Configuration Reference](https://docs.ringee.io/configuration/reference.md): Environment variables reference for Ringee - [Docker Compose Configuration](https://docs.ringee.io/configuration/docker-compose.md): Docker-specific configuration and overrides - [Email Configuration](https://docs.ringee.io/configuration/email.md): Set up transactional email with Resend - [R2 Configuration](https://docs.ringee.io/configuration/r2.md): Set up Cloudflare R2 for file storage - [Stripe Configuration](https://docs.ringee.io/configuration/stripe.md): Set up Stripe for billing and payments - [Clerk Configuration](https://docs.ringee.io/configuration/clerk.md): Set up Clerk for authentication - [Provider Overview](https://docs.ringee.io/providers/overview.md): How telephony providers work in Ringee - [How to Add a New Provider](https://docs.ringee.io/providers/add-provider.md): Guide for integrating a new telephony provider into Ringee - [Telnyx](https://docs.ringee.io/providers/telnyx.md): Set up Telnyx as your telephony provider - [Public API overview](https://docs.ringee.io/api/overview.md): Sync CRM data and run AI Voice Agents with a Custom Integration API key - [Authentication](https://docs.ringee.io/api/authentication.md): Create a Custom Integration and authenticate your requests - [Inbound events](https://docs.ringee.io/api/inbound-events.md): Push contacts and companies from your CRM into Ringee - [Click-to-call](https://docs.ringee.io/api/click-to-call.md): Open a secure Ringee dialer for a contact from your CRM - [Outbound webhooks](https://docs.ringee.io/api/outbound-webhooks.md): Receive Ringee activity in your application, verified and idempotent - [Event reference](https://docs.ringee.io/api/events-reference.md): Every event Ringee sends to your application - [Build an integration](https://docs.ringee.io/api/build-an-integration.md): An end-to-end blueprint for connecting a CRM to Ringee - [Logs and errors](https://docs.ringee.io/api/logs-and-errors.md): Debug inbound events and outbound deliveries - [MCP overview](https://docs.ringee.io/mcp/overview.md): Let AI assistants operate Ringee through the Model Context Protocol - [Connect a client](https://docs.ringee.io/mcp/connect.md): Get your Ringee MCP URL and wire it into Claude, ChatGPT or Cursor - [Tool reference](https://docs.ringee.io/mcp/tools.md): Every tool the Ringee MCP server exposes - [Workspaces](https://docs.ringee.io/mcp/workspaces.md): How personal and organization scoping works over MCP - [Safety and confirmations](https://docs.ringee.io/mcp/safety.md): How Ringee guards destructive and credit-spending tools - [Apps and skills](https://docs.ringee.io/mcp/apps.md): Ringee inside Claude Code, claude.ai and ChatGPT - [CLI overview](https://docs.ringee.io/cli/overview.md): Operate Ringee from the terminal - [Configuration](https://docs.ringee.io/cli/configuration.md): Point the ringee CLI at your workspace - [Command reference](https://docs.ringee.io/cli/commands.md): Every ringee CLI command, argument and flag - [Use it from an agent](https://docs.ringee.io/cli/agents.md): Give any shell-capable agent access to Ringee - [AI Voice Agents](https://docs.ringee.io/voice-agents/overview.md): Build voice agents that place real calls, hold conversations and return structured results - [AI Voice Agents quickstart](https://docs.ringee.io/voice-agents/quickstart.md): Create an AI voice agent, test it and place the first real call - [Configure an agent](https://docs.ringee.io/voice-agents/configuration.md): Choose an agent type, model, voice, caller number and conversation behavior - [Knowledge and analysis](https://docs.ringee.io/voice-agents/knowledge-analysis.md): Ground an AI Voice Agent and define the structured result it produces - [Calls and results](https://docs.ringee.io/voice-agents/calls.md): Start AI voice agent calls safely and interpret their asynchronous results - [AI Voice Agents API](https://docs.ringee.io/voice-agents/api-reference.md): Public API endpoints for listing AI Voice Agents, starting calls and reading results - [AI Voice Agents over MCP](https://docs.ringee.io/voice-agents/mcp.md): List agents, start a real call and read its result from any MCP client - [AI Voice Agents from the CLI](https://docs.ringee.io/voice-agents/cli.md): Run AI voice agent calls from a terminal or shell-capable agent - [Self-host AI Voice Agents](https://docs.ringee.io/voice-agents/self-hosting.md): Configure provider callbacks, models, limits, storage and background reconciliation - [Dialer SDK overview](https://docs.ringee.io/dialer-sdk/overview.md): Embed a real Ringee dialer inside your own web app - [Quickstart](https://docs.ringee.io/dialer-sdk/quickstart.md): Place your first call from your own web app - [Publishable keys](https://docs.ringee.io/dialer-sdk/publishable-keys.md): Create and scope the pk_live key that authorizes your installation - [Floating](https://docs.ringee.io/dialer-sdk/floating.md): A launcher in the page corner that opens a complete dialer panel - [Inline bar](https://docs.ringee.io/dialer-sdk/bar.md): Render the dialer inside an element of your own layout - [Headless](https://docs.ringee.io/dialer-sdk/headless.md): Authentication, calls, devices and events with no UI at all - [React and Next.js](https://docs.ringee.io/dialer-sdk/react.md): Mount the browser SDK safely in a component tree - [CRM contacts](https://docs.ringee.io/dialer-sdk/contacts.md): Attach the record your app has on screen - [Theming and copy](https://docs.ringee.io/dialer-sdk/theming.md): Match the dialer to your product - [API reference](https://docs.ringee.io/dialer-sdk/reference.md): Options, controllers, methods, states and events - [Errors](https://docs.ringee.io/dialer-sdk/errors.md): Every RingeeError code and how to react to it - [Security and self-hosting](https://docs.ringee.io/dialer-sdk/security.md): Why pk_live is safe in the browser, plus CSP, iframes and custom API hosts - [Troubleshooting](https://docs.ringee.io/dialer-sdk/troubleshooting.md): Symptom-first fixes for the Dialer SDK ## OpenAPI Specs - [openapi](/api/openapi.json) ## Optional - [GitHub](https://github.com/ringee-io/ringee-app) - [YouTube](https://youtube.com/@RingeeOfficial)