# RevRing AI Documentation

## Docs

- [Add Phone Number](https://docs.revring.ai/api-reference/agents/add-phone-number.md): Assign a phone number to an agent
- [Create Agent](https://docs.revring.ai/api-reference/agents/create.md): Create a new AI voice agent with specified configuration
- [Create Custom Tool](https://docs.revring.ai/api-reference/agents/create-custom-tool.md): Add a custom tool that the agent can invoke via function calling
- [Delete Agent](https://docs.revring.ai/api-reference/agents/delete.md): Delete an agent
- [Delete Custom Tool](https://docs.revring.ai/api-reference/agents/delete-custom-tool.md): Remove a custom tool from an agent
- [Get Agent](https://docs.revring.ai/api-reference/agents/get.md): Retrieve specific agent by ID
- [Link Knowledge Base](https://docs.revring.ai/api-reference/agents/link-knowledge-base.md): Link a knowledge base to an agent. The agent will use the knowledge base for retrieval-augmented generation during calls.
- [List Agents](https://docs.revring.ai/api-reference/agents/list.md): Retrieve all AI voice agents for your organization
- [List Custom Tools](https://docs.revring.ai/api-reference/agents/list-custom-tools.md): Get custom tools configured for an agent
- [List Agent Knowledge Bases](https://docs.revring.ai/api-reference/agents/list-knowledge-bases.md): List knowledge bases linked to an agent
- [List Agent Phone Numbers](https://docs.revring.ai/api-reference/agents/list-phone-numbers.md): Get phone numbers assigned to an agent for inbound calls
- [Remove Phone Number](https://docs.revring.ai/api-reference/agents/remove-phone-number.md): Remove a phone number from an agent
- [Unlink Knowledge Base](https://docs.revring.ai/api-reference/agents/unlink-knowledge-base.md): Remove a knowledge base from an agent
- [Update Agent](https://docs.revring.ai/api-reference/agents/update.md): Update agent configuration
- [Update Custom Tool](https://docs.revring.ai/api-reference/agents/update-custom-tool.md): Update custom tool configuration
- [Get Active Calls Count](https://docs.revring.ai/api-reference/analytics/active.md): Get the current number of active (ongoing) calls. Not affected by date filters.
- [Get Analytics Overview](https://docs.revring.ai/api-reference/analytics/overview.md): Get analytics overview with time-series data and summary cards
- [Cancel Call](https://docs.revring.ai/api-reference/calls/cancel.md): Cancel a queued call. Only calls with status `QUEUED` can be cancelled.
- [Get Call](https://docs.revring.ai/api-reference/calls/get.md): Retrieve call details by ID
- [List Calls](https://docs.revring.ai/api-reference/calls/list.md): List calls with filtering, sorting, and pagination
- [Send Call](https://docs.revring.ai/api-reference/calls/send.md): Initiate an outbound call with an agent
- [Introduction](https://docs.revring.ai/api-reference/introduction.md): How to access and use the RevRing API
- [Add Source](https://docs.revring.ai/api-reference/knowledge-bases/add-source.md): Add a source to a knowledge base. Supports three source types: - **Text**: Send JSON with `sourceType: "text"`, `displayName`, and `content` - **URL**: Send JSON with `sourceType: "url"` and `originalUrl` - **File**: Send `multipart/form-data` with a `file` field (max 20MB)
- [Create Knowledge Base](https://docs.revring.ai/api-reference/knowledge-bases/create.md): Create a new knowledge base. After creation, add sources (text, URL, or file) to populate it.
- [Delete Knowledge Base](https://docs.revring.ai/api-reference/knowledge-bases/delete.md): Delete a knowledge base and all its sources. This also removes all agent links.
- [Delete Source](https://docs.revring.ai/api-reference/knowledge-bases/delete-source.md): Remove a source from a knowledge base
- [Get Knowledge Base](https://docs.revring.ai/api-reference/knowledge-bases/get.md): Retrieve a knowledge base by ID, including its sources
- [Get Source](https://docs.revring.ai/api-reference/knowledge-bases/get-source.md): Get a specific source and its processing status
- [List Knowledge Bases](https://docs.revring.ai/api-reference/knowledge-bases/list.md): List all knowledge bases for your organization
- [Update Knowledge Base](https://docs.revring.ai/api-reference/knowledge-bases/update.md): Update knowledge base name or description
- [Create SIP Trunk](https://docs.revring.ai/api-reference/sip-trunks/create.md): Create a new SIP trunk. Provide phone numbers that will route through this trunk.
- [Delete SIP Trunk](https://docs.revring.ai/api-reference/sip-trunks/delete.md): Delete a SIP trunk. Cannot delete if agents are using it.
- [Get SIP Trunk](https://docs.revring.ai/api-reference/sip-trunks/get.md): Retrieve a specific SIP trunk by ID
- [List SIP Trunks](https://docs.revring.ai/api-reference/sip-trunks/list.md): Retrieve all SIP trunks for your organization. SIP trunks connect your AI agents to the phone network.
- [Update SIP Trunk](https://docs.revring.ai/api-reference/sip-trunks/update.md): Update SIP trunk configuration including phone numbers
- [Cancel Test Run](https://docs.revring.ai/api-reference/test-suites/cancel-run.md): Cancel a running or queued test run. Already completed or cancelled runs cannot be cancelled.
- [Create Test Suite](https://docs.revring.ai/api-reference/test-suites/create.md): Create a new test suite targeting a specific agent
- [Create Test Case](https://docs.revring.ai/api-reference/test-suites/create-test.md): Add a test case to a test suite. Each test case includes a script for the tester to follow and a scoring rubric for evaluation.
- [Delete Test Suite](https://docs.revring.ai/api-reference/test-suites/delete.md): Delete a test suite and all its test cases and runs
- [Delete Test Case](https://docs.revring.ai/api-reference/test-suites/delete-test.md): Remove a test case from a test suite
- [Generate Test Cases](https://docs.revring.ai/api-reference/test-suites/generate-tests.md): Use AI to generate test case suggestions based on a natural language prompt. Generated tests are returned as suggestions and are not automatically added to the suite.
- [Get Test Suite](https://docs.revring.ai/api-reference/test-suites/get.md): Retrieve a test suite by ID
- [Get Test Run](https://docs.revring.ai/api-reference/test-suites/get-run.md): Retrieve a specific test run with its results
- [Get Test Case](https://docs.revring.ai/api-reference/test-suites/get-test.md): Retrieve a specific test case
- [List Test Suites](https://docs.revring.ai/api-reference/test-suites/list.md): List all test suites for your organization with pagination
- [List Test Runs](https://docs.revring.ai/api-reference/test-suites/list-runs.md): List test runs for a test suite with pagination
- [List Test Cases](https://docs.revring.ai/api-reference/test-suites/list-tests.md): List all test cases in a test suite
- [Start Test Run](https://docs.revring.ai/api-reference/test-suites/start-run.md): Start a new test run. This initiates real phone calls between a tester and the target agent for each test case. The suite must have at least one test case.
- [Update Test Suite](https://docs.revring.ai/api-reference/test-suites/update.md): Update test suite configuration
- [Update Test Case](https://docs.revring.ai/api-reference/test-suites/update-test.md): Update a test case's script, rubric, or configuration
- [Post-Call Webhook](https://docs.revring.ai/api-reference/webhooks/post-call.md): Called after a call ends with complete call details including transcript, recording, and summary.
- [Pre-Call Webhook](https://docs.revring.ai/api-reference/webhooks/pre-call.md): Called before an inbound call is answered. Return variables to be merged with the agent's default variables for this call.
- [Introduction](https://docs.revring.ai/index.md): Welcome to the RevRing AI documentation website
- [MCP Server](https://docs.revring.ai/mcp-server.md): Connect RevRing documentation to AI coding tools like Cursor, VS Code, Claude, and more
- [Conversation Flows](https://docs.revring.ai/platform/conversation-flows.md): Build structured conversation flows with the RevRing flow JSON format
- [Inbound Calls](https://docs.revring.ai/platform/inbound.md): Configure agents to handle incoming phone calls
- [Knowledge Bases](https://docs.revring.ai/platform/knowledge-bases.md): Give your agents access to your documents, URLs, and text content for grounded, accurate answers
- [Multilingual](https://docs.revring.ai/platform/multilingual.md): Build AI voice agents that speak multiple languages
- [Outbound Calls](https://docs.revring.ai/platform/outbound.md): Send outbound calls through your AI agents
- [Prompting & Variables](https://docs.revring.ai/platform/prompting-variables.md): Personalize agent conversations with dynamic variables
- [Telephony Setup](https://docs.revring.ai/platform/telephony.md): Connect SIP trunks from Twilio, Telnyx, and other providers
- [Test Suites](https://docs.revring.ai/platform/test-suites.md): Automatically test your AI agents with scripted conversations and AI-powered scoring
- [Agent Tools](https://docs.revring.ai/platform/tools.md): Configure system and custom tools for your agents
- [Webhooks](https://docs.revring.ai/platform/webhooks.md): Integrate RevRing with your systems using webhooks
- [WebRTC](https://docs.revring.ai/platform/webrtc.md): Add voice AI agents to web browsers and mobile apps
- [Quickstart](https://docs.revring.ai/quickstart.md): Get your first RevRing AI agent up and running in minutes

## OpenAPI Specs

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