Reference

Create Agent

Set up a new conversational AI agent with customizable voice and language settings to handle customer interactions, support requests, or lead qualification automatically.

List Agents

Retrieve all your conversational AI agents from ElevenLabs to browse, search, or select for further operations. This helps you manage and organize your AI agents in one place.

Patch Agent Settings

Update specific agent settings without affecting other configurations, allowing you to fine-tune individual parameters like response behavior or processing rules on the fly.

Delete Agent

Permanently removes an agent from ElevenLabs to clean up your AI assistant library and reduce clutter. Use this when you no longer need a specific agent or want to remove outdated versions.

Duplicate Agent

Creates an exact copy of an existing agent including all its settings and configuration, allowing you to reuse a working setup without rebuilding from scratch.

Get agent

Retrieve complete configuration and details for a specific conversational AI agent by its ID, including settings, workflows, and metadata. Use this to audit agent setup, verify configurations, or integrate agent details into your workflows.

Get Agent Shareable Link

Generate a shareable link for your conversational AI agent so you can easily distribute it to clients, team members, or customers without requiring them to create accounts.

Get Agent Summaries

Retrieve concise summaries of multiple agents at once by their IDs, getting quick snapshots of agent performance and status in a single request.

Get Agent Widget Config

Retrieves the configuration settings for your AI agent widget, allowing you to access and manage how the chat interface appears and behaves on your website or application.

List Agent Branches

Retrieve all branches associated with a specific agent to view their organizational structure and branch assignments. This helps you understand how your agent's work is distributed across different branches.

Post Agent Avatar

Upload or update a profile image for your AI agent to give it a visual identity that matches your brand or use case. This helps create a more personalized and professional appearance for your conversational AI assistant.

Generate Composition Plan

Creates a structured musical composition plan based on your text description, automatically organizing it into sections with specified styles and musical direction.

Isolate Audio Stream

Isolate and extract speech or vocals from audio files by removing background noise and music, making it easy to work with just the voice content you need. Ideal for cleaning up recordings and creating focused audio content.

Get Single Use Token

Creates a temporary access token for connecting to ElevenLabs services like text-to-speech or real-time transcription through websocket connections. The token automatically expires after 15 minutes for enhanced security.

Calculate Agent LLM Expected Cost

Estimates how much you'll spend on AI language model costs based on your knowledge base size, prompt length, and retrieval settings, helping you understand operational expenses before deploying an agent.

Calculate Public LLM Expected Cost

Estimate the cost of running AI-powered conversations based on your content size and usage patterns, helping you budget for intelligent customer support or internal automation tools.

Create Batch Call

Submit automated voice calls to multiple recipients using an AI conversational agent, enabling you to reach out to many contacts simultaneously without manual dialing.

Cancel batch call

Stop an active batch calling campaign that's currently running or scheduled, allowing you to halt operations immediately without completing all calls.

Delete Batch Call

Permanently remove a batch call from your Elevenreader account by its ID. Use this when you need to clean up outdated or erroneous batch processing jobs.

Get Batch Call By Id

Retrieve the status and details of a specific batch call you've created, allowing you to monitor progress and access results whenever needed.

Get Workspace Batch Calls

Retrieve all batch calls processed in your workspace with pagination support, allowing you to review and track multiple API requests that were executed together. This helps you monitor the status and results of batched operations across your workspace.

Handle SIP Trunk Outbound Call

Programmatically place outbound calls to phone numbers using an AI conversational agent, enabling automated voice interactions without manual dialing.

Register Twilio Call

Connects incoming or outgoing phone calls through Twilio to an AI conversational agent, enabling automated voice interactions without manual handling.

Retry batch call

Re-attempts a batch call that failed or was cancelled, automatically re-queuing it for processing without manual reconfiguration.

Delete Conversation

Permanently removes a conversation from your Elevenreader workspace. Use this to clean up old discussions and manage your conversation history.

Get conversation history

Retrieve the complete transcript and details of a conversation, including timing and performance metrics to review what was discussed and how the call went. This helps you understand interactions and improve future communications.

Get Conversation Signed Link

Generates a secure URL that allows you to share or access a conversation with an agent without requiring additional login credentials, making it easy to distribute conversation links to clients or team members.

Get Conversations

Retrieves your conversation history from ElevenLabs Conversational AI, allowing you to view, filter, and search past interactions by agent, date, rating, or language. This helps you review customer engagements and track conversation performance.

Run Conversation Simulation

Test how your AI agent responds to different customer questions and conversation scenarios before deploying it to real users. This helps you identify and fix issues with the agent's behavior, tone, and accuracy.

Simulate Conversation (Stream)

Test and demonstrate how your AI agent handles real conversations with streaming responses, letting you preview agent behavior before deployment. This helps you validate conversation quality and configure agent parameters like language and tone without affecting production systems.

Create File Document

Upload a file document to your ElevenLabs knowledge base so your AI agent can access and reference it during conversations. This enables your assistant to provide accurate, consistent information based on your documentation.

Create Text Document

Add written content to your ElevenLabs knowledge base so AI agents can reference and use it during customer interactions.

Create URL Document

Add web content to your ElevenLabs knowledge base by converting a URL into a searchable document that your AI assistant can reference during conversations. This helps your assistant provide accurate, up-to-date information based on your website or external resources.

Update Document

Modify the name or details of an existing document stored in your ElevenLabs knowledge base to keep your content library organized and up-to-date.

Delete Dubbing

Permanently removes a dubbing project from your account when it's no longer needed, freeing up storage and keeping your project library organized.

Get Dubbed File

Download the completed dubbed audio or video file in a specific language from your dubbing project. Use this to retrieve the final output once your media has been processed and dubbed into your target language.

Get Dubbed Transcript

Retrieve the complete transcript from a dubbed audio or video file in your preferred language. This lets you access subtitles or full text versions of your dubbing projects without manually transcribing.

Get Dubbing Metadata

Retrieve detailed information about a dubbing project including its current status, supported languages, and configuration settings. This helps you track progress and verify that your audio localization project is set up correctly.

Get Dubbing Transcripts

Retrieve transcripts and subtitles from your dubbed content in multiple formats, allowing you to repurpose or distribute multilingual video content across different platforms.

List Dubs

Retrieve all your dubbing projects from ElevenLabs to view their details and current status. Use this to find and manage your audio dubbing projects across different languages and stages of completion.

Create Folder

Organize your ElevenLabs knowledge base by creating folders to group related documents and maintain a structured library for easier retrieval and management.

List MCP Servers

Retrieve a complete list of all MCP server configurations available in your workspace, including their settings and dependencies. Use this to understand what servers are set up and how your agents are using them.

List WhatsApp Accounts

Retrieve all WhatsApp accounts connected to your ElevenLabs ConvAI workspace so you can manage and assign them to your AI agents.

Add Documentation To Knowledge Base

Upload or link documentation to your AI agent so it can reference and answer questions based on your specific materials. This helps train your conversational assistant to provide accurate, business-specific information.

List Knowledge Bases

Retrieve all knowledge base documents available in ElevenLabs to browse, search, or select documents for further processing. This helps you quickly locate and manage your stored knowledge base content.

Bulk Move Knowledge Base Entities

Organize your knowledge base by moving multiple documents or folders to a specific location, helping you maintain a clean and logical structure as your content library grows.

Delete Knowledge Base Document

Permanently removes a document from your knowledge base, freeing up space and keeping your reference materials current. Use this when documentation becomes outdated or is no longer relevant to your business.

Get Agent Knowledge Base Size

Retrieves the total size or number of pages stored in your AI agent's knowledge base to help you understand how much training data your agent has access to. This helps you assess whether your agent has sufficient information to handle customer inquiries effectively.

Get Documentation From Knowledge Base

Retrieves specific documents from your knowledge base to access stored information, content, and metadata about business resources. This is useful when you need to quickly pull up details about a particular document your AI agent has learned from.

Get Knowledge Base Content

Retrieves the full text content of a knowledge base document so you can access and work with the actual information stored in your knowledge base entries.

Get Knowledge Base Dependent Agents

Retrieve which AI agents are using a specific knowledge base document to understand dependencies before making changes. This helps you safely manage your knowledge base without breaking agent functionality.

Get Knowledge Base Source File URL

Retrieves a download link for the original source file of any document stored in your knowledge base, allowing you to access the raw file whenever needed.

Get Knowledge Base Summaries

Retrieve concise summaries of multiple knowledge base documents at once to quickly review document content without reading full texts. Ideal for getting an overview of your stored information resources.

Move Knowledge Base Entity

Reorganize your knowledge base by moving documents or folders to different locations, helping you maintain a clean and logical information structure. This operation keeps your documentation organized as your business content grows.

Get Models

Retrieve the list of available ElevenLabs text-to-speech models to discover which voices and capabilities are accessible for your projects.

Get Live Count

Retrieves the current number of active conversations happening in real-time, helping you monitor engagement and activity levels.

Delete Phone Number

Permanently remove a phone number from your ElevenLabs ConvAI system when it's no longer needed for incoming conversations. This helps keep your communication channels clean and organized.

Get phone number

Retrieve detailed information about a specific phone number including its configuration, provider settings, and assigned agent details. Use this to understand how your phone numbers are configured and managed in your system.

Import Phone Number

Connect your existing phone number to ElevenLabs ConvAI to enable your conversational AI agents to make and receive calls directly through your current phone infrastructure.

List Phone Numbers

Retrieve all phone numbers configured in your ElevenLabs ConvAI workspace to see which phone lines are available for your AI agents to use.

Update Phone Number

Modify your phone number's settings in ElevenLabs ConvAI, including its label, assigned AI agent, and SIP trunk configuration to match your business needs.

Create Audio Native Project

Convert text or HTML content into an embeddable audio player with customizable voice and styling options, making your content accessible to audio listeners.

Get Audio Native Project Settings

Retrieve the configuration settings and details for an audio project in ElevenLabs, including enabled status, project metadata, and visual customizations. Use this to understand how your project is currently configured before making updates or publishing.

Update Audio Native Project Content

Replace or update the text or HTML content in an existing audio project without recreating the entire project from scratch.

Add Pronunciation Dictionary From File

Upload a pronunciation dictionary file to customize how specific words are pronounced in text-to-speech output, ensuring consistent and accurate audio rendering of specialized terminology or brand names.

Add Pronunciation Dictionary From Rules

Create custom pronunciation rules to ensure text-to-speech reads specific words, names, or terms exactly as you want them pronounced in your audio content.

Add Pronunciation Dictionary Rules

Customize how specific words or phrases sound when converted to speech by adding pronunciation rules to your ElevenLabs dictionary. This ensures brand names, technical terms, and proper nouns are pronounced exactly as you intend.

Get Pronunciation Dictionaries

Retrieve a list of available pronunciation dictionaries with their metadata to help you select the right dictionary for text-to-speech customization and accurate audio generation.

Get Pronunciation Dictionary Metadata

Retrieves detailed information about a pronunciation dictionary including its version, number of rules, and creation dates. Use this to understand the composition and status of your pronunciation dictionaries before applying them to text-to-speech projects.

Get Pronunciation Dictionary Version PLS

Retrieve the pronunciation dictionary version in PLS XML format to access the specific pronunciation rules your text-to-speech system uses. This ensures your audio content matches the exact pronunciation guidelines applied to your generated speech.

Remove Pronunciation Dictionary Rules

Delete specific pronunciation rules from your dictionary to correct outdated or incorrect pronunciations that affect text-to-speech output quality.

Update Pronunciation Dictionary

Modify pronunciation dictionary settings such as renaming it or changing its archive status to keep your voice content library organized and up-to-date.

Compute RAG Index

Generates embeddings for your documents to enable intelligent semantic search and retrieval within your knowledge base. This prepares your content for AI-powered discovery so users can find answers based on meaning rather than just keyword matching.

Delete RAG Index

Permanently remove a RAG index from your knowledge base to free up storage and clean up outdated or unnecessary document embeddings.

Get Or Create RAG Indexes

Automatically generates or retrieves searchable indexes for your documents, enabling you to find and retrieve specific information from your knowledge base quickly and accurately.

Get RAG Index Overview

Retrieve a summary of your knowledge base index including storage usage and capacity limits for your AI-powered search system. This helps you monitor how much of your available space is being used by your embedded documents and files.

Get RAG Indexes

Retrieve the RAG indexes associated with a knowledge base document to check embedding status and access document analysis details. This helps you verify that your documents have been properly processed for AI-powered search and retrieval.

Get Resource Metadata

Retrieves detailed information and sharing permissions for a workspace resource, allowing you to see who has access and manage collaborative settings. Use this to understand your resource's current access levels and sharing configuration.

Create Convai Workspace Secret

Securely store API keys, tokens, and other sensitive credentials within your ElevenLabs workspace so your AI agents can safely access external services without exposing secrets in your code.

Delete Convai Workspace Secret

Permanently remove a workspace secret from your Convai configuration, helping you maintain clean and secure credential management. Use this when you need to revoke access or clean up outdated API keys and tokens.

Get ConvAI workspace secrets

Retrieve all stored API keys and credentials for your ConvAI workspace, enabling you to manage and audit secrets used by your agents and integrations.

Update Convai Workspace Secret

Modify an existing workspace secret's name or value to keep your Convai integration credentials and configuration data current and secure.

Get ConvAI dashboard settings

Retrieve your ConvAI dashboard configuration to view which charts and metrics are currently enabled and how your dashboard is organized.

Get ConvAI workspace settings

Retrieve your ConvAI workspace configuration to view current settings for your AI assistant stack, including server access, LiveKit configuration, and webhook integrations.

Update ConvAI dashboard settings

Customize your ConvAI dashboard by configuring which charts and data visualizations appear, allowing you to monitor the metrics that matter most to your business.

Update ConvAI Settings

Modify your ElevenLabs ConvAI workspace configuration to control server access, LiveKit preferences, data retention, and webhook integrations for your AI conversations. This helps you customize how your conversational AI system operates and connects with other tools.

Get Speech History

Retrieve a list of all speech files you've previously generated with ElevenLabs, allowing you to review, manage, and reuse your audio content history.

Delete Speech History Item

Permanently removes a specific speech history item from your ElevenLabs account, helping you clean up old or unwanted audio records. This is useful for maintaining a organized library and protecting privacy by removing sensitive content.

Download Speech History Items

Export previously generated audio files from your ElevenLabs account as individual files or a consolidated zip archive. This allows you to backup, repurpose, or share audio content you've created.

Get Audio From History Item

Retrieve and download the audio file that was previously generated from a text-to-speech conversion, allowing you to access and use your created audio content.

Get speech history item by ID

Retrieve detailed information about a previously generated audio file, including the original text, voice settings, and generation metadata. Use this to review, audit, or repurpose past text-to-speech conversions.

Get User Subscription Info

Retrieve your subscription details including your current tier, character usage, voice limits, and billing status. Use this to monitor your account's capabilities and understand your usage limits.

Create Agent Response Test

Create test scenarios to validate how your AI agent responds to different inputs and interactions, ensuring reliable performance before deployment. This helps you catch issues and refine conversational behavior without affecting live users.

Delete Agent Response Test

Removes a saved agent response test from your system when you no longer need to validate that specific interaction. This helps you clean up your testing suite and keep your agent configurations organized.

Get Agent Response Test

Retrieves the configuration and parameters for a specific agent response test, allowing you to review test settings and validate agent behavior.

Get Agent Response Tests Summaries

Retrieve summary results and performance metrics for specific agent response tests to evaluate how well your AI agents are performing. This helps you quickly assess test outcomes without reviewing full detailed reports.

Get Test Invocation

Retrieves detailed results and status information for a specific test run, allowing you to check whether tests passed or failed and review any error details.

List Agent Response Tests

Retrieve all available response tests for your ElevenLabs conversational AI agent to monitor and verify how your agent performs across different scenarios.

List Test Invocations

Retrieve the history of test runs for your conversational AI agent, including which tests passed or failed and when they were executed. This helps you track the reliability and performance of your chatbot over time.

Resubmit Tests

Quickly re-run failed or specific tests from a previous test session without rebuilding your entire test suite, helping you verify bug fixes and validate code changes efficiently.

Run Agent Test Suite

Validates your AI agent's performance by running automated tests to ensure it responds correctly and handles customer interactions properly.

Update Agent Response Test

Modify test parameters and chat history for your AI agent to ensure it responds correctly to different scenarios and customer interactions.

Add Tool

Create a new conversational AI tool in ElevenLabs ConvAI that your agents can use during customer interactions. Supports multiple tool types including webhooks, client-side integrations, system tools, and MCP protocols.

Delete Tool

Permanently removes a conversational AI tool from ElevenLabs when it's no longer needed, freeing up your account and keeping your tool library organized.

Get ConvAI Tools

Retrieve a list of available AI tools in your workspace with pagination support, allowing you to browse and discover what tools are available for your projects.

Get tool

Retrieve detailed information about a specific AI tool including its configuration, settings, and usage statistics. This helps you understand how your conversational AI tools are set up and performing.

Get Tool Dependent Agents

Retrieve all conversational AI agents that depend on a specific tool, helping you understand which agents will be affected before making changes to that tool.

Update Tool

Modify your AI assistant's tool settings including its name, description, and API schema to keep configurations current and aligned with your business needs.

Delete Transcript By Id

Permanently removes a speech-to-text transcript from your Elevenreader account. Use this when you want to delete transcripts that are no longer needed to keep your account organized and reduce clutter.

Get Transcript By ID

Retrieve a previously transcribed audio file's full text, word timings, and language details using its unique ID. This lets you access transcription results without reprocessing the audio.

Get Characters Usage Metrics

Retrieve detailed metrics on how many characters you've used in ElevenLabs to monitor your text-to-speech consumption and plan your usage accordingly.

Get User Info

Retrieves your account details including subscription status, available character limits, and voice generation quotas so you can monitor your usage and plan accordingly.

Add Shared Voice

Add a publicly shared voice from another user's library to your own voice collection. This lets you leverage high-quality voices created by the ElevenLabs community without building them from scratch.

Edit Voice

Update your existing voice in ElevenLabs by modifying its name, description, labels, or adding new audio samples to improve voice quality and customization.

Edit Voice Settings

Customize voice characteristics for text-to-speech output by adjusting parameters like stability, speed, and speaker emphasis to match your brand voice and content needs.

Get Default Voice Settings

Retrieves the default configuration values for voice synthesis settings including stability, similarity, speed, and style. Use this to understand your starting voice parameters before customizing them for your content.

Get Generate Voice Parameters

Retrieves the available voice generation options and technical constraints (such as character limits and voice characteristics) from ElevenLabs, helping you understand what's possible before creating custom voices.

Get Library Voices

Retrieve available voices from the ElevenLabs library to find the perfect voice for your text-to-speech projects. This helps you explore and select from professional voice options before generating audio content.

Get Similar Library Voices

Discover voices from the ElevenLabs library that match a specific audio sample or voice characteristic you provide. This helps you find the perfect voice for your content without manually auditioning hundreds of options.

Get User Voices V2

Retrieve and browse available voices from ElevenLabs with advanced filtering options to find the perfect voice for your audio content needs.

Get Voice by ID

Retrieve detailed information about a specific voice, including its characteristics, category, and settings. Use this to understand voice properties before implementing it in your audio content or applications.

Get Voice Settings

Retrieve the current configuration settings for a specific voice, including parameters like stability, similarity boost, speed, and speaker boost. This helps you understand and audit how your voices are currently configured.

List Workspace Webhooks

View all webhooks configured in your ElevenLabs workspace to monitor active integrations and their current status. This helps you manage connections between ElevenLabs and your other business tools.

Get Workspace Service Accounts

Retrieves all service accounts configured in your workspace, allowing you to see which automated accounts or integrations are currently active for API access and management.