Retellai

Add a community voice from ElevenLabs to your Retell voice library. Use when you need to import a shared community voice for use in your agents.

This endpoint allows purchasing a new phone number with a specified area code and binding it to designated agents for inbound and outbound calls. It requires JSON with agent IDs and area code. Responses indicate the creation status or errors.

Initiate an outbound call by POST to '/v2/create-phone-call'. Requires 'from_number' and 'to_number' in E.164 format. Optional overrides and metadata supported. On success, returns call details including type, status, and IDs.

The /v2/create-web-call endpoint creates a web call with a unique agent ID, returning call details like type, token, call ID, and status in JSON format, with a 201 response. Optional metadata and variables can be included.

Create a new chat agent with specified configuration. Use when you need to set up a chat-based AI agent with custom response engine and behavior settings.

Create a new Conversation Flow that can be attached to an agent for response generation. Requires start_speaker, model_choice, and nodes. Returns conversation_flow_id and full configuration.

Creates a new shared conversation flow component at POST '/create-conversation-flow-component'. Requires 'name' and 'nodes' array. Optional: tools, mcps, start_node_id, begin_tag_display_position. Returns component ID, timestamp, and the full component definition.

Tool to create a new knowledge base in Retell AI with texts, files, and URLs. Use when you need to create a knowledge base for an AI agent. At least one of knowledge_base_texts, knowledge_base_files, or knowledge_base_urls should be provided.

Create a new Retell LLM Response Engine that can be attached to an agent. Use when you need to configure a new LLM-powered response system with custom prompts, tools, and conversation flows.

Deletes an existing agent by its unique identifier. Returns 204 No Content on successful deletion.

Delete an existing chat agent by its unique identifier. Use when you need to permanently remove a chat agent from the system.

Delete a conversation flow and all its versions. Use when you need to permanently remove a conversation flow from the system.

Delete a shared conversation flow component. When deleting a shared component, creates local copies for all linked conversation flows.

Tool to delete an existing phone number from Retell AI. Use when you need to remove a phone number that is no longer needed. The phone number must be in E.164 format (e.g., +14159998888).

Delete an existing Retell LLM Response Engine by its unique identifier. Use when you need to permanently remove a Retell LLM from the system.

Retrieve details of a specific agent by its unique identifier. Use when you need to access agent configuration details.

Tool to retrieve all versions of a specific agent. Use when you need to view version history or access previous configurations of an agent.

Retrieve details of a specific chat agent by its unique identifier. Use when you need to access chat agent configuration details.

Retrieve all versions of a specific chat agent by its unique identifier. Use when you need to access version history of a chat agent.

Retrieves the current concurrency and concurrency limits for the organization. Use when you need to check concurrent call capacity and availability.

Retrieve details of a specific Conversation Flow by its ID. Use when you need to fetch conversation flow configuration including nodes, version, and settings.

Retrieves a shared conversation flow component by its unique identifier. Use when you need to fetch details of a specific conversation flow component.

Retrieve details of a specific knowledge base by its unique identifier. Use when you need to access knowledge base configuration including name, status, sources, and refresh settings.

Retrieve details of a specific Retell LLM Response Engine by its unique identifier. Use when you need to access LLM configuration including model settings, prompts, tools, states, and knowledge base configurations.

Tool to import a phone number from custom telephony and bind agents to it. Use when you need to integrate an existing phone number with Retell AI's system for handling inbound and outbound calls.

Retrieves a list of all agents associated with the account.

Tool to retrieve a list of all chats associated with the account. Use when you need to view chat history or analyze past conversations.

Retrieves a list of all phone numbers associated with the account.

Retrieves a list of all shared conversation flow components. Use when you need to access reusable conversation flow building blocks that can be referenced across multiple conversation flows.

Tool to list all conversation flows that can be attached to an agent. Use when you need to retrieve available conversation flows for agent configuration.

Tool to retrieve all knowledge bases associated with the account. Use when you need to list or view all available knowledge bases with their details including IDs, names, statuses, sources, and refresh settings.

Tool to list all Retell LLM Response Engines that can be attached to an agent. Use when you need to retrieve available LLM configurations including their IDs, models, prompts, tools, and other settings.

List all voices available to the user. Returns voice details including voice_id, name, provider, accent, gender, age, and preview audio URL.

Publishes the latest version of the agent and creates a new draft agent with a newer version. Use when you need to deploy an agent to production.

Publishes the latest version of the chat agent and creates a new draft chat agent with a newer version. Use when you need to deploy a chat agent to production.

Tool to retrieve call details with filtering options. Use when you need to fetch call records, analyze call history, or monitor call performance.

Retrieve call details by ID for web/phone calls, including type, agent ID, status, timestamps, and web access token; covering responses from success to server errors.

Tool to retrieve details of a specific phone number from Retell AI. Use when you need to get information about a phone number including its type, timestamps, SIP configuration, and SMS settings. The phone number should be provided in E.164 format.

Tool to retrieve details of a specific voice by its voice_id. Use when you need information about a specific voice including its name, provider, accent, gender, age, and preview audio URL.

Search for community voices from voice providers. Use when you need to find voices by name, description, or ID, optionally filtering by provider.

Update an existing agent's latest draft version. Use when modifying agent configuration, voice settings, or behavior parameters for a Retell AI agent.

Update an existing chat agent configuration. Use when modifying chat agent settings, response engine, or behavior parameters.

Update an existing conversation flow configuration. Use when modifying conversation flow settings such as model parameters, nodes, tools, or prompt templates.

Update an existing shared conversation flow component by its ID. Use when you need to modify component properties like name, nodes, tools, or MCP configurations.

Update agent bound to a purchased phone number. Use when you need to change the agent configuration, nickname, webhook URLs, or SIP settings for an existing phone number.

Update an existing Retell LLM Response Engine by its unique identifier. Use when you need to modify LLM configuration, prompts, tools, conversation flows, or model settings for an existing response engine.