# Ringg AI

> Developer docs for Ringg AI

- [Ringg AI Developer Docs](https://docs.ringg.ai/get-started/overview/ringg-ai.md): Integrate Ringg AI voice agents into your product with REST APIs, web calls, campaigns, and webhooks.
- [Platform](https://docs.ringg.ai/get-started/overview/platform.md): A high-level look at Ringg AI's capabilities, architecture, and supported use cases.
- [Dashboard](https://docs.ringg.ai/get-started/overview/dashboard.md): Learn how to navigate the Ringg AI dashboard.
- [Assistants](https://docs.ringg.ai/get-started/key-concepts/assistants.md): Understand Ringg AI assistants and how teams use them.
- [Campaigns](https://docs.ringg.ai/get-started/key-concepts/campaigns.md): Understand outbound calling campaigns in Ringg AI.
- [Knowledge Base](https://docs.ringg.ai/get-started/key-concepts/knowledge-base.md): Understand knowledge bases and when to use them.
- [Numbers](https://docs.ringg.ai/get-started/key-concepts/numbers.md): Understand caller numbers and how assistants use them.
- [Create an Assistant](https://docs.ringg.ai/get-started/guides/create-assistant.md): Create a Ringg AI voice assistant from the dashboard.
- [Configure an Assistant](https://docs.ringg.ai/get-started/guides/configure-assistant.md): Set up an assistant's script, voice, documents, call settings, and developer handoff.
- [Create a Campaign](https://docs.ringg.ai/get-started/guides/create-campaign.md): Run outbound calls to a contact list from the Ringg AI dashboard.
- [Create a Knowledge Base](https://docs.ringg.ai/get-started/guides/create-knowledge-base.md): Upload approved documents that assistants can use during calls.
- [Manage Numbers](https://docs.ringg.ai/get-started/guides/manage-numbers.md): Buy, connect, assign, and remove phone numbers in Ringg AI.
- [View Call History](https://docs.ringg.ai/get-started/guides/view-call-history.md): Find call logs, recordings, transcripts, and call details.
- [Analytics](https://docs.ringg.ai/get-started/guides/analytics.md): Review call performance, connection rates, costs, and assistant results.
- [Workspace Settings](https://docs.ringg.ai/get-started/guides/workspace-settings.md): Manage workspace members, API keys, telephony, and app integrations.
- [Embedding Widget](https://docs.ringg.ai/get-started/guides/embedding-widget.md): Embed a Ringg AI voice or chat assistant on your website.
- [Embedding Widget Configuration](https://docs.ringg.ai/get-started/guides/embedding-widget-configuration.md): Reference for Ringg AI web widget load options, positioning, styling, variables, and feedback screens.
- [Widget Lifecycle Events](https://docs.ringg.ai/get-started/guides/embedding-widget-events.md): Listen for browser events the Ringg AI widget emits about its own state: open/close, conversation start/end, and feedback.
- [Embedding Widget Chat](https://docs.ringg.ai/get-started/guides/embedding-widget-chat-widgets.md): Configure chat mode, chat-only embeds, chat assistant prompts, and the legacy calendar and form widgets.
- [Chat Components](https://docs.ringg.ai/get-started/guides/embedding-widget-components.md): Build interactive cards, forms and pickers your agent shows in conversation, then adjust every block by hand.
- [Component Data](https://docs.ringg.ai/get-started/guides/embedding-widget-components-data.md): Fetch from your API before a component renders, send data when a button is tapped, and exchange events with your own page.
- [Chat Use Cases](https://docs.ringg.ai/get-started/guides/embedding-widget-components-use-cases.md): Worked recipes for chat components: lead capture, live pricing, slot booking, brochure downloads and on-page actions.
- [Widget Customization](https://docs.ringg.ai/get-started/guides/embedding-widget-customization.md): Restyle and script the Ringg AI web widget using stable data-ringg attributes.
- [Embedding Widget Production QA and Security](https://docs.ringg.ai/get-started/guides/embedding-widget-production-qa-security.md): Security and launch checklist for deploying the Ringg AI web widget.
- [React Native Widget](https://docs.ringg.ai/get-started/guides/widget-react-native.md): Add the Ringg AI chat and voice widget to a React Native or Expo app with @ringg/react-native.
- [React Native Widget Configuration](https://docs.ringg.ai/get-started/guides/widget-react-native-configuration.md): Full reference for the RinggWidgetConfig options accepted by the Ringg AI React Native widget.
- [React Native Widget Events and Control](https://docs.ringg.ai/get-started/guides/widget-react-native-events.md): Lifecycle events, controller methods, state hooks and agent-triggered app actions for the Ringg AI React Native widget.
- [Flutter Widget](https://docs.ringg.ai/get-started/guides/widget-flutter.md): Add the Ringg AI chat and voice widget to a Flutter app with the ringg_flutter package.
- [Flutter Widget Configuration](https://docs.ringg.ai/get-started/guides/widget-flutter-configuration.md): Full reference for the RinggWidgetConfig options accepted by the Ringg AI Flutter widget.
- [Flutter Widget Events and Control](https://docs.ringg.ai/get-started/guides/widget-flutter-events.md): Lifecycle events, controller methods, state bindings and agent-triggered app actions for the Ringg AI Flutter widget.
- [Voice Call Optimization](https://docs.ringg.ai/get-started/best-practices/voice-call-optimization.md): Follow these best practices to optimize your voice calls for better performance and user experience
- [Web Call Integration](https://docs.ringg.ai/get-started/best-practices/web-call-integration.md): Follow these best practices to optimize your Web Call integration for better user experience and performance
- [Security Guidelines](https://docs.ringg.ai/get-started/best-practices/security-guidelines.md): Follow these security best practices to protect your Ringg AI integration and user data
- [WhatsApp Agents](https://docs.ringg.ai/whatsapp/overview.md): Run Ringg AI assistants on your own WhatsApp Business numbers, with templates, tools, webhooks and full chat logs.
- [Connect WhatsApp Business](https://docs.ringg.ai/whatsapp/onboarding.md): Connect a WhatsApp Business account, add and register numbers, manage message templates, and add WhatsApp send tools to an assistant.
- [WhatsApp On-call Tools](https://docs.ringg.ai/whatsapp/on-call-tools.md): Let an assistant send a WhatsApp template or text message while a call or chat is still live.
- [WhatsApp Post-call Tools](https://docs.ringg.ai/whatsapp/post-call-tools.md): Send a WhatsApp template automatically after every call or chat ends, such as a summary, a link or the next steps.
- [Create a WhatsApp Agent](https://docs.ringg.ai/whatsapp/create-agent.md): Create an assistant of type WhatsApp, attach a WhatsApp number, write a prompt for chat, and test it from your phone.
- [Start a WhatsApp Conversation by API](https://docs.ringg.ai/whatsapp/start-conversation-api.md): Send the first WhatsApp message to a customer with an approved template, and let your WhatsApp agent take over when they reply.
- [WhatsApp Events and Webhooks](https://docs.ringg.ai/whatsapp/events.md): Subscribe your endpoint to chat events from a WhatsApp agent: chat completed, analysis done, and all processing done.
- [WhatsApp Chat History](https://docs.ringg.ai/whatsapp/chat-history.md): Find WhatsApp conversations in Logs, read transcripts and analysis, export a CSV by email, or fetch chats through the API.
- [WhatsApp Relay](https://docs.ringg.ai/whatsapp/relay/overview.md): Run a Ringg AI agent on a WhatsApp Business number you keep and operate yourself. You forward customer messages to Ringg, and Ringg sends back ready-to-send replies.
- [What's Supported in WhatsApp Relay](https://docs.ringg.ai/whatsapp/relay/supported.md): Message types, conversation features and limits for WhatsApp Relay, and what is not supported yet.
- [What We Need From You](https://docs.ringg.ai/whatsapp/relay/client-requirements.md): The details to share with Ringg to set up WhatsApp Relay, and what your WhatsApp service has to implement.
- [What Ringg Provides](https://docs.ringg.ai/whatsapp/relay/ringg-provides.md): The credentials, AI agent, delivery behaviour and dashboard visibility Ringg provides for each WhatsApp Relay number.
- [WhatsApp Relay Integration Guide](https://docs.ringg.ai/whatsapp/relay/integration-guide.md): Authentication, the five relay endpoints, the events Ringg posts to your webhook, and error codes.
- [Hand Over From a Human Agent](https://docs.ringg.ai/whatsapp/relay/handover.md): Pass a WhatsApp conversation from your human agent to the Ringg AI agent with the history so far, take it back, and hand it over again.
- [WhatsApp Relay Troubleshooting](https://docs.ringg.ai/whatsapp/relay/troubleshooting.md): Find and fix the common WhatsApp Relay problems: rejected requests, missing or late replies, acks, handover history and closed chats.
- [WhatsApp Relay FAQ](https://docs.ringg.ai/whatsapp/relay/faq.md): Short answers to common questions about WhatsApp Relay: credentials, delivery, handover, media, templates and environments.
- [Quick Start Guide](https://docs.ringg.ai/api-reference/quick-start/guide.md): Make your first Ringg AI outbound call from your backend and understand the minimum production flow.
- [Authentication](https://docs.ringg.ai/api-reference/quick-start/authentication.md): Authenticate Ringg AI API requests with workspace API keys and keep keys secure in production.
- [API Overview](https://docs.ringg.ai/api-reference/quick-start/api-overview.md): Understand the structure, versioning, and usage patterns of the Ringg AI API
- [Voice Calling](https://docs.ringg.ai/api-reference/tutorials/voice-calling.md): Manage and initiate AI-powered voice calls with Ringg AI's Voice API.
- [Making Your First Call](https://docs.ringg.ai/api-reference/tutorials/making-your-first-call.md): Make one outbound call with Ringg AI, then verify the result through call history or webhooks.
- [Setting Up Bulk Calls](https://docs.ringg.ai/api-reference/tutorials/setting-up-bulk-calls.md): Upload a campaign CSV, map variables, start outbound calls, and monitor campaign results.
- [Get Workspace Info](https://docs.ringg.ai/api-reference/endpoint/workspace/get-workspace-info.md): Retrieves information about your current workspace.
- [List Workspace Users](https://docs.ringg.ai/api-reference/endpoint/workspace/list-workspace-users.md): Retrieves a list of all users in your current workspace.
- [Get All User Workspaces](https://docs.ringg.ai/api-reference/endpoint/workspace/get-all-user-workspaces.md): Retrieves a list of all workspaces accessible to the current user.
- [Ringg Spaces](https://docs.ringg.ai/api-reference/endpoint/sub-workspace/overview.md): Run a family of workspaces from one primary: create Ringg Spaces for clients or teams, and allocate concurrency, credit limits, or balances to them over the API.
- [Create Ringg Space](https://docs.ringg.ai/api-reference/endpoint/sub-workspace/create-sub-workspace.md): Creates a new Ringg Space under the primary workspace that owns the API key. The Ringg Space is a full workspace (own assistants, numbers, campaigns, call history, members) that starts with zero balance or credit limit and zero concurrency; allocate to it afterwards. Every member of the primary is g…
- [Get Ringg Spaces](https://docs.ringg.ai/api-reference/endpoint/sub-workspace/get-sub-workspaces.md): Returns the whole family in one call: the primary's summary, one row per active Ringg Space with its allocation, members and month-to-date usage, and the family totals. Works on a primary that has no Ringg Spaces yet (empty list).
- [List Family Members](https://docs.ringg.ai/api-reference/endpoint/sub-workspace/list-family-members.md): Lists every person with access anywhere in the family and where that access comes from: members of the primary (who inherit access to every Ringg Space) and people added directly to one or more Ringg Spaces.
- [Allocate Concurrency to a Ringg Space](https://docs.ringg.ai/api-reference/endpoint/sub-workspace/allocate-concurrency.md): Sets how many concurrent calls one Ringg Space may run, taken from the family's capacity (bought on the primary). Allocations across all Ringg Spaces cannot exceed the capacity. In an individual-billing family the allocation is also the Ringg Space's hard ceiling; in a common-billing family the ceil…
- [Reallocate Credit Limits](https://docs.ringg.ai/api-reference/endpoint/sub-workspace/reallocate-credit-limits.md): Postpaid, individual-billing families only. Sets every active Ringg Space's credit limit in one call and optionally the family total. The map must name every active Ringg Space exactly once; a slice cannot drop below what that Ringg Space has already used this month, the slices cannot exceed the fam…
- [Reallocate Credit Balances](https://docs.ringg.ai/api-reference/endpoint/sub-workspace/reallocate-credit-balances.md): Prepaid, individual-billing families only. Sets every active Ringg Space's wallet to an absolute balance; the net difference moves from or to the primary's unallocated pot, which must be able to cover it. Top up on the primary first, then allocate. Not applicable to common-billing families, where th…
- [Get Assistant Voices](https://docs.ringg.ai/api-reference/endpoint/assistant/get-assistant-voices.md): Retrieves a list of available voices for assistants, optionally filtered by language.
- [Get Assistants](https://docs.ringg.ai/api-reference/endpoint/assistant/get-assistants.md): Retrieves a list of all available assistants in your workspace.
- [Get Assistant By ID](https://docs.ringg.ai/api-reference/endpoint/assistant/get-assistant-by-id.md): Retrieves detailed information about a specific assistant by its ID.
- [Edit Assistant](https://docs.ringg.ai/api-reference/endpoint/assistant/edit-assistant.md): Updates an existing assistant with new configuration settings. Each operation requires specific fields to be provided.
- [Create Agent](https://docs.ringg.ai/api-reference/endpoint/assistant/create-agent.md): Creates a new AI agent with the specified configuration. The agent will be created with a single prompt-based flow.
- [Create Knowledge Base](https://docs.ringg.ai/api-reference/endpoint/kb/create-knowledge-base.md): Creates a new non-deterministic knowledge base. Rate limit: 10 requests per hour per workspace. File size limit: 2 MB per file, 5 MB total. Maximum 10 files and 20 URLs per request.
- [Edit Knowledge Base](https://docs.ringg.ai/api-reference/endpoint/kb/edit-knowledge-base.md): Edits an existing knowledge base by adding or removing files, URLs, and FAQs. Rate limit: 20 requests per hour per workspace. File size limit: 2 MB per file, 5 MB total.
- [Get All Knowledge Bases](https://docs.ringg.ai/api-reference/endpoint/kb/get-all-knowledge-bases.md): Retrieves all knowledge bases for the current workspace. Rate limit: 60 requests per hour per workspace.
- [Get Knowledge Base by ID](https://docs.ringg.ai/api-reference/endpoint/kb/get-knowledge-base-by-id.md): Retrieves a specific knowledge base by its ID. Rate limit: 60 requests per hour per workspace.
- [Delete Knowledge Base](https://docs.ringg.ai/api-reference/endpoint/kb/delete-knowledge-base.md): Deletes a knowledge base by its ID. Rate limit: 10 requests per minute per workspace.
- [Get Workspace Numbers](https://docs.ringg.ai/api-reference/endpoint/numbers/get-workspace-numbers.md): Retrieves a list of available phone numbers in your workspace.
- [Initiate Individual Call](https://docs.ringg.ai/api-reference/endpoint/calling/initiate-individual-call.md): Starts one outbound call to a recipient. **Exactly one caller-number option is required: from_number_id or from_number.**
- [Initiate Individual Call (Number Pool)](https://docs.ringg.ai/api-reference/endpoint/calling/initiate-individual-call-v2.md): Starts one outbound call to a recipient using a managed number pool or an explicit caller number.
- [Upload Campaign Contact List](https://docs.ringg.ai/api-reference/endpoint/campaign/upload-campaign-contact-list.md): Uploads a contact list for a campaign. Accepts a CSV file and campaign configuration as form data.
- [Start Campaign](https://docs.ringg.ai/api-reference/endpoint/campaign/start-campaign.md): Initiates a new campaign with the specified configuration.
- [Start Campaign (Number Pool)](https://docs.ringg.ai/api-reference/endpoint/campaign/start-campaign-v2.md): Initiates a new campaign using a managed number pool for outbound calls. Numbers are resolved automatically from the pool (rotation, spam skipping, auto-purchase).
- [Get All Campaigns](https://docs.ringg.ai/api-reference/endpoint/campaign/get-all-campaigns.md): Retrieves a paginated list of campaigns for the current user with optional call count information.
- [Upload large campaign CSV (Beta)](https://docs.ringg.ai/api-reference/endpoint/campaign/upload-large-campaign-csv.md): Upload a 5,000+ row campaign CSV for asynchronous processing.
- [Get large campaign upload status (Beta)](https://docs.ringg.ai/api-reference/endpoint/campaign/get-large-campaign-upload-status.md): Poll asynchronous CSV processing status for a beta large campaign.
- [Check large campaign balance (Beta)](https://docs.ringg.ai/api-reference/endpoint/campaign/check-large-campaign-balance.md): Confirm workspace balance before starting beta large-campaign calls.
- [Make large campaign calls async (Beta)](https://docs.ringg.ai/api-reference/endpoint/campaign/make-large-campaign-calls-async.md): Start outbound calls for a beta large campaign after upload processing and balance checks.
- [Get Call History](https://docs.ringg.ai/api-reference/endpoint/history/get-call-history.md): Retrieves the history of calls made through the Ringg AI platform with optional filtering and pagination.
- [Download Call History](https://docs.ringg.ai/api-reference/endpoint/history/download-call-history.md): Downloads call history data in CSV format. Supports bulk download of call records with optional filtering. Use 'include_analysis=true' to include call analysis data (platform_analysis and client_analysis) in the export.
- [Get Call Details](https://docs.ringg.ai/api-reference/endpoint/history/get-call-details.md): Retrieves detailed information about a specific call using its unique identifier. Use the send_analysis parameter to include analysis data in the response.
- [Terminate All Calls by Agent ID](https://docs.ringg.ai/api-reference/terminate/agent.md): Stop queued and retry calls for a specific assistant.
- [Terminate Calls by Call IDs](https://docs.ringg.ai/api-reference/terminate/call-ids.md): Stop specific queued or retry calls by call ID.
- [Terminate Calls by Campaign ID](https://docs.ringg.ai/api-reference/terminate/campaign.md): Stop queued and retry calls for a campaign.
- [Terminate Calls by Campaign Numbers](https://docs.ringg.ai/api-reference/terminate/campaign-numbers.md): Stop calls to specific numbers within one campaign.
- [Terminate Calls by Numbers](https://docs.ringg.ai/api-reference/terminate/numbers.md): Stop queued and retry calls to specific numbers across campaigns.
- [Get Platform Analytics](https://docs.ringg.ai/api-reference/endpoint/analytics/get-platform-analytics.md): Retrieves comprehensive platform analytics including performance metrics and summaries.
- [Get Drill-Down Analytics](https://docs.ringg.ai/api-reference/endpoint/analytics/get-drill-down-analytics.md): Retrieves detailed analytics for a specific bulk list/campaign with drill-down capabilities.
- [Get Number Analytics](https://docs.ringg.ai/api-reference/endpoint/analytics/get-number-analytics.md): Retrieves analytics broken down by phone numbers.
- [Get Duration Distribution](https://docs.ringg.ai/api-reference/endpoint/analytics/get-duration-distribution.md): Retrieves call duration distribution analytics.
- [Get Classification Analytics](https://docs.ringg.ai/api-reference/endpoint/analytics/get-classification-analytics.md): Retrieves call classification analytics data.
- [Initial Setup](https://docs.ringg.ai/webhooks/initial-setup.md): Configure webhook event subscriptions for assistants and receive real-time call, recording, and analysis events.
- [Webhook Payloads](https://docs.ringg.ai/webhooks/payloads.md): Detailed examples of webhook request and response payloads for all event types
- [Error Handling](https://docs.ringg.ai/webhooks/error-handling.md): Learn how to handle webhook errors, implement retry logic, and troubleshoot common issues
- [Bring Your Own Telephony (BYOT)](https://docs.ringg.ai/telephony/byot-overview.md): Integrate your existing telephony provider with Ringg API for seamless voice calling
- [New Telephony Provider Requirements](https://docs.ringg.ai/telephony/new-provider-requirements.md): Complete requirements for integrating a new telephony provider with Ringg
- [SIP Integration](https://docs.ringg.ai/telephony/sip-integration.md): Connect your SIP trunk, PBX, or contact centre platform directly to Ringg for inbound and outbound AI voice calls
- [Plivo Integration](https://docs.ringg.ai/telephony/plivo-integration.md): Configure Plivo as your telephony provider for Ringg API - Complete setup guide for inbound and outbound calls
- [Exotel Integration](https://docs.ringg.ai/telephony/exotel-integration.md): Configure Exotel as your Ringg telephony provider for inbound and outbound calls
- [Twilio Integration](https://docs.ringg.ai/telephony/twilio-integration.md): Configure Twilio as your telephony provider for Ringg API - Complete setup guide for inbound and outbound calls
- [Ameyo Integration](https://docs.ringg.ai/telephony/ameyo-integration.md): Connect Ameyo to Ringg over SIP and configure call transfer to human agents
- [Ozonetel Integration](https://docs.ringg.ai/telephony/ozonetel-integration.md): URLs to configure in Ozonetel for inbound, outbound, and status callbacks
- [Number Management](https://docs.ringg.ai/telephony/number-management.md): Import existing phone numbers from your telephony provider or purchase new numbers through Ringg dashboard
- [Ringg AI MCP Server](https://docs.ringg.ai/mcp/overview.md): Use Ringg AI from Claude, ChatGPT, Cursor, Claude Code or any MCP client: place calls, manage assistants and read transcripts in plain language.
- [Connect a Client](https://docs.ringg.ai/mcp/connect.md): Add the Ringg AI MCP server to Claude, ChatGPT, Claude Code, Cursor or any other MCP client.
- [Tools, Resources & Prompts](https://docs.ringg.ai/mcp/tools.md): Reference for every tool, resource and prompt exposed by the Ringg AI MCP server.
- [Security & FAQ](https://docs.ringg.ai/mcp/security.md): How sign-in to the Ringg AI MCP server works, what is stored, and how to revoke access.
- [Parrot STT](https://docs.ringg.ai/parrot-stt/python-sdk.md): Transcribe audio files or stream live audio in Hindi and English with the Parrot STT Python SDK. Sync and async clients included.
- [TrueFoundry Integration](https://docs.ringg.ai/external-integrations/truefoundry-integration.md): Add and configure Ringg.AI Parrot Speech-to-Text (STT) in TrueFoundry's AI Gateway using Custom Endpoints.
- [Security and Compliance](https://docs.ringg.ai/privacy-and-compliance/security-overview.md)

## OpenAPI Specs

- [openapi](/api-reference/openapi.json)


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