# Ringg AI

## Docs

- [Get Classification Analytics](https://docs.ringg.ai/api-reference/endpoint/analytics/get-classification-analytics.md): Retrieves call classification analytics data.
- [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 Duration Distribution](https://docs.ringg.ai/api-reference/endpoint/analytics/get-duration-distribution.md): Retrieves call duration distribution analytics.
- [Get Number Analytics](https://docs.ringg.ai/api-reference/endpoint/analytics/get-number-analytics.md): Retrieves analytics broken down by phone numbers.
- [Get Platform Analytics](https://docs.ringg.ai/api-reference/endpoint/analytics/get-platform-analytics.md): Retrieves comprehensive platform analytics including performance metrics and summaries.
- [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.
- [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.
- [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.
- [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.
- [Initiate Individual Call](https://docs.ringg.ai/api-reference/endpoint/calling/initiate-individual-call.md): Starts a new individual outbound call to a specified recipient. The from_number field is required and should be a valid phone number with country code.
- [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.
- [Start Campaign](https://docs.ringg.ai/api-reference/endpoint/campaign/start-campaign.md): Initiates a new campaign with the specified configuration.
- [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.
- [Delete Contact List](https://docs.ringg.ai/api-reference/endpoint/contact/delete-contact-list.md): Deletes a contact list and all associated contacts by list ID.
- [Get contact list](https://docs.ringg.ai/api-reference/endpoint/contact/get-contact-list.md)
- [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.
- [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.
- [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.
- [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.
- [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.
- [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.
- [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.
- [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.
- [Regenerate API Key](https://docs.ringg.ai/api-reference/endpoint/workspace/regenerate-api-key.md): Regenerates a new API key for the current workspace.
- [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
- [Authentication](https://docs.ringg.ai/api-reference/quick-start/authentication.md): How to authenticate with Ringg AI's API using API keys
- [Guide](https://docs.ringg.ai/api-reference/quick-start/guide.md): Get started with Ringg AI's voice capabilities in minutes. This guide will help you make your first AI-powered call using our API.
- [Terminate All Calls by Agent ID](https://docs.ringg.ai/api-reference/terminate/agent.md)
- [Terminate Calls by Call IDs](https://docs.ringg.ai/api-reference/terminate/call-ids.md)
- [Terminate Calls by Campaign ID](https://docs.ringg.ai/api-reference/terminate/campaign.md)
- [Terminate Calls by Campaign Numbers](https://docs.ringg.ai/api-reference/terminate/campaign-numbers.md)
- [Terminate Calls by Numbers](https://docs.ringg.ai/api-reference/terminate/numbers.md)
- [Making Your First Call](https://docs.ringg.ai/api-reference/tutorials/making-your-first-call.md): This tutorial will guide you through the process of making your first outbound call using Ringg AI's Voice API
- [Managing Contacts](https://docs.ringg.ai/api-reference/tutorials/managing-contacts.md): This tutorial will guide you through the process of managing contact lists for bulk calling campaigns
- [Setting Up Bulk Calls](https://docs.ringg.ai/api-reference/tutorials/setting-up-bulk-calls.md): This tutorial will guide you through the process of setting up and initiating bulk calls to multiple recipients
- [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.
- [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
- [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
- [Analytics](https://docs.ringg.ai/get-started/guides/analytics.md): Monitor call performance, connectivity, and agent efficiency.
- [Configure an Assistant](https://docs.ringg.ai/get-started/guides/configure-assistant.md): Set up your assistant's prompt, voice, call behaviour, and advanced options.
- [Create an Assistant](https://docs.ringg.ai/get-started/guides/create-assistant.md): Step-by-step guide to creating a new AI voice assistant in Ringg AI.
- [Create a Campaign](https://docs.ringg.ai/get-started/guides/create-campaign.md): Run bulk outbound calls using an assistant and a contact list.
- [Create a Knowledge Base](https://docs.ringg.ai/get-started/guides/create-knowledge-base.md): Create Deterministic and Non-Deterministic Knowledge Bases for your assistants.
- [Embedding Widget](https://docs.ringg.ai/get-started/guides/embedding-widget.md): This guide will walk you through embedding a Ringg AI voice or chat assistant on your website, including widget customization, chat agents, interactive widgets, and tools
- [Manage Numbers](https://docs.ringg.ai/get-started/guides/manage-numbers.md): Buy numbers, bring your own telephony, and manage your existing phone lines.
- [View Call History](https://docs.ringg.ai/get-started/guides/view-call-history.md): Browse call logs, listen to recordings, and read transcripts.
- [View Call History](https://docs.ringg.ai/get-started/guides/view-history.md): Browse call logs, listen to recordings, and read transcripts.
- [Workspace Settings](https://docs.ringg.ai/get-started/guides/workspace-settings.md): Manage workspace members, API keys, and integrations.
- [Assistants](https://docs.ringg.ai/get-started/key-concepts/assistants.md): Understand the core building block of Ringg AI — AI-powered voice agents that conduct phone conversations on your behalf.
- [Campaigns](https://docs.ringg.ai/get-started/key-concepts/campaigns.md): Learn about campaigns — scheduled batches of outbound calls made by your AI assistants.
- [Knowledge Base](https://docs.ringg.ai/get-started/key-concepts/knowledge-base.md): Learn about Knowledge Bases — document collections your assistants can search during live calls.
- [Numbers](https://docs.ringg.ai/get-started/key-concepts/numbers.md): Learn about telephony numbers — the phone lines your assistants use to make and receive calls.
- [Dashboard](https://docs.ringg.ai/get-started/overview/dashboard.md): Learn how to navigate the Ringg AI dashboard and workspace.
- [Dashboard](https://docs.ringg.ai/get-started/overview/dashboard-overview.md): Learn how to navigate the Ringg AI dashboard and workspace.
- [Platform](https://docs.ringg.ai/get-started/overview/platform.md): A high-level look at Ringg AI's capabilities, architecture, and supported use cases.
- [Platform](https://docs.ringg.ai/get-started/overview/platform-overview.md): A high-level look at Ringg AI's capabilities, architecture, and supported use cases.
- [Ringg AI](https://docs.ringg.ai/get-started/overview/ringg-ai.md): Ringg AI is an AI voice agent platform built for businesses that need to automate phone-based interactions at scale.
- [Ringg AI](https://docs.ringg.ai/get-started/overview/ringg-overview.md): Ringg AI is an AI voice agent platform built for businesses that need to automate phone-based interactions at scale.
- [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
- [Exotel Integration](https://docs.ringg.ai/telephony/exotel-integration.md): Configure Exotel as your telephony provider for Ringg API - Inbound and Outbound call setup
- [New Telephony Provider Requirements](https://docs.ringg.ai/telephony/new-provider-requirements.md): Complete requirements for integrating a new telephony provider with Ringg
- [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
- [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
- [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
- [Error Handling](https://docs.ringg.ai/webhooks/error-handling.md): Learn how to handle webhook errors, implement retry logic, and troubleshoot common issues
- [Initial Setup](https://docs.ringg.ai/webhooks/initial-setup.md): Learn how to configure webhook subscriptions for your AI agents to receive real-time event notifications
- [Webhook Payloads](https://docs.ringg.ai/webhooks/payloads.md): Detailed examples of webhook request and response payloads for all event types

## OpenAPI Specs

- [openapi](https://docs.ringg.ai/api-reference/openapi.json)