Add a pronunciation dictionary from file
Adds a new pronunciation dictionary from a lexicon file to improve speech synthesis accuracy.
Create natural AI voices instantly in any language - perfect for video creators, developers, and businesses.
Adds a new pronunciation dictionary from a lexicon file to improve speech synthesis accuracy.
Adds a custom voice by uploading audio samples for voice cloning. Requires a name and at least one audio file. Recommended: 1-2 minutes of clear audio without background noise. Supported formats: mp3, wav, ogg. Returns a voice_id that can be used for text-to-speech after processing completes.
Use to create a new ElevenLabs project for text-to-speech synthesis (e.g., audiobooks); a project `name` is required by the API for creation, and content can be initialized using `from_url` or `from_document`.
Tool to import/register a Twilio phone number or SIP trunk into ElevenLabs Agents Platform. Use when you need to provision a phone number for outbound calls and ELEVENLABS_GET_AGENT_DETAILS returns empty phone_numbers. This does NOT purchase a new number; it imports an existing provider configuration into your ElevenLabs workspace.
Tool to create a new pronunciation dictionary from provided rules for ElevenLabs text-to-speech. Use when you need to define custom pronunciations for specific words or phrases to improve speech accuracy. Supports both alias rules (simple text replacements) and phoneme rules (IPA phonetic notation).
Adds one or more custom pronunciation rules (alias or phoneme) to an existing pronunciation dictionary.
Adds an existing, shareable voice to a specified user's ElevenLabs account library under a new custom name, requiring the user's public ID and the voice ID.
Tool to add documentation to ElevenLabs Conversational AI knowledge base by uploading a file or referencing a webpage URL. Use when you need to provide reference materials or documentation that agents can access during conversations. Exactly one of 'file' or 'url' must be specified.
Archives an existing project snapshot by its ID, creating a permanent, immutable, and typically irreversible copy of its state.
Tool to assign or unassign an existing imported phone number to an agent by updating the phone number's assigned agent. Use when you need to programmatically route inbound calls to a specific agent or change agent assignment for a phone number.
Tool to calculate expected number of LLM tokens needed for a conversational AI agent. Use when estimating costs for an agent based on knowledge base size, prompt length, and RAG configuration.
Tool to calculate expected LLM usage costs for conversational AI agents. Use when you need to estimate pricing for different LLM models based on prompt length, knowledge base size, and RAG configuration.
Tool to cancel a running batch call and set all recipients to cancelled status. Use when you need to stop an ongoing batch calling campaign.
Converts an existing ElevenLabs Studio project, including all its chapters and using its configured settings and voices, into speech.
Converts the textual content of a chapter, identified by `chapter_id` within a `project_id`, into audio format.
Finalizes the creation of a voice using its `generated_voice_id` from a previous generation step by assigning a name, description, and optional labels.
Creates an ElevenLabs AudioNative project, generating an embeddable audio player from a provided content file using text-to-speech, allowing customization of player appearance, audio settings, and conversion options.
Tool to create a knowledge base document from an uploaded file for ElevenLabs Conversational AI agents. Use when you need to provide documentation or reference material that agents can access during conversations. The uploaded file content will be indexed and made available to agents for answering user queries.
Tool to create a folder in the ElevenLabs ConvAI knowledge base for organizing documents. Use when you need to group related documents together in a hierarchical structure.
Tool to compute or retrieve RAG indexes for multiple knowledge base documents in batch. Use when you need to enable semantic search on multiple knowledge base documents for conversational AI agents. This endpoint creates embeddings if missing or returns existing indexes, supporting up to 100 documents per request.
Tool to create a new secret for the ElevenLabs ConvAI workspace. Use when you need to securely store API keys, tokens, or other sensitive values that your conversational AI agents can reference.
Tool to create a new ElevenLabs Conversational AI agent with specified configuration. Use when you need to programmatically set up an agent with custom prompts, voice settings, and behavior. After creating the agent, you can chain other tools to attach phone numbers or configure additional settings.
Tool to create a new ElevenLabs Conversational AI agent response test. Use when you need to set up automated testing for agent responses, tool calls, or conversation simulations. Supports three test types: 'llm' for response validation, 'tool_call' for tool execution verification, and 'simulation' for full conversation testing.
Tool to create a new conversational AI tool in ElevenLabs workspace. Use when adding custom tools for agents to execute during conversations. Supports webhook (external HTTP APIs), client (client-side execution), system (built-in), and MCP (Model Context Protocol) tool types.
Tool to create a knowledge base document with text content in ElevenLabs Conversational AI. Use when you need to add text-based information to the knowledge base for agent reference.
Tool to create a knowledge base document by scraping the given webpage. Use when you need to add a web page as a knowledge source for a conversational AI agent.
Tool to generate a time-limited single-use token with embedded authentication for frontend clients. Use when you need secure, temporary access tokens for WebSocket connections or real-time services.
Tool to create a new webhook for the workspace with specified authentication type. Use when you need to configure a webhook endpoint to receive notifications from ElevenLabs. The webhook_secret returned should be stored securely for verifying webhook authenticity.
Permanently deletes a dubbing project by its ID; this action is irreversible and the project cannot be recovered.
Tool to delete an agent response test by ID. Use when you need to remove a test result or clean up test data.
Tool to permanently delete a batch call and all associated recipient records. Conversations remain in history. Use when cleaning up completed or cancelled batch calls.
Irreversibly deletes a specific, existing chapter from an existing project, typically to remove unwanted or obsolete content.
Tool to delete RAG index for a knowledge base document. Use when you need to remove semantic search indexing from a document to free up resources or when the document no longer needs to be indexed.
Tool to delete a particular Conversational AI conversation by ID. Use when you need to remove a conversation from the system for cleanup, compliance, or data management purposes.
Tool to permanently delete a Conversational AI agent by its unique identifier. Use when you need to remove an agent configuration from the ElevenLabs workspace.
Tool to delete a conversational AI tool from the workspace by ID. Use when you need to remove a tool configuration that is no longer needed or to clean up outdated tool definitions.
Permanently deletes a specific history item (including its audio file and metadata) using its `history_item_id`; this operation is irreversible and should be used with caution.
Tool to delete a document or folder from the knowledge base. Use when you need to remove a knowledge base document or folder that is no longer needed.
Tool to delete a specific MCP server configuration from the workspace. Use when you need to remove an MCP server that is no longer needed or to clean up outdated configurations.
Tool to delete an imported phone number from the ElevenLabs workspace by ID. Use when you need to remove a phone number configuration for cleanup or to avoid stale configurations in automated environments.
Use to irreversibly delete a specific project by its `project_id`; the project must exist and be accessible, and this action cannot be undone.
Permanently and irreversibly deletes a specific custom voice using its `voice_id`; the voice must exist and the authenticated user must have permission to delete it.
Permanently deletes a specific voice sample for a given voice ID; this action is irreversible.
Tool to delete a workspace secret if it's not in use. Use when you need to remove unused secrets from the conversational AI workspace for security or cleanup purposes.
Tool to delete a specified workspace webhook by its ID. Use when you need to remove a webhook configuration that is no longer needed or to clean up webhook integrations.
Downloads audio clips from history by ID(s), returning a single file or a ZIP archive, with an optional output format (e.g., 'wav'); provides only audio content, no metadata.
Dub a video or audio file into a specified target language, requiring 'file' or 'source_url', 'target_lang', and 'csv_file' if 'mode' is 'manual'.
Tool to create a new agent by duplicating an existing one. Use when you need to clone an agent's configuration. The new agent will inherit all settings from the original agent but can be given a new name.
Updates the name, audio files, description, or labels for an existing voice model. The voice_id must be for a voice owned by you (cloned voices). Premade/default voices cannot be edited. The 'name' field is required for all edit operations. This endpoint uses multipart/form-data format for the request body.
Edits key voice settings (e.g., stability, similarity enhancement, style exaggeration, speaker boost) for an existing voice, affecting all future audio generated with that voice ID.
Generates a unique, random ElevenLabs text-to-speech voice based on input text and specified voice characteristics.
Tool to generate a music composition plan from a text prompt using ElevenLabs Music API. Use when you need to create a structured plan for music generation with defined styles, sections, and durations. The generated plan can be used as input for actual music generation or as a template for variations.
Tool to retrieve available Conversational AI agents and outbound-capable Twilio phone numbers. Use when selecting an agent and phone number for outbound calls. Always reference agents by agent_id (stable identifier), not agent_name (mutable). Returns basic metadata only — conversation_config and webhook settings require a separate ConvAI agent API call. Pass agent_id and agent_phone_number_id directly to ELEVENLABS_OUTBOUND_CALL; IDs must be current and owned by the authenticated account.
Tool to retrieve the number of pages in a conversational AI agent's knowledge base. Use when you need to check the size of an agent's knowledge base content.
Tool to get the current shareable link for a Conversational AI agent. Use when you need to retrieve the link URL for sharing the agent with others.
Tool to retrieve an ElevenLabs Conversational AI agent response test by its ID. Use when you need to fetch details of a specific test including its configuration, type, and test parameters.
Tool to retrieve multiple agent response test summaries by their IDs. Use when you need to fetch summary information for multiple tests in a single request. Returns a dictionary mapping test IDs to their summary details including name, type, and timestamps.
Tool to retrieve the widget configuration for a Conversational AI agent. Use when you need to fetch display settings, colors, text content, and behavior options for an agent's embedded widget.
Retrieves the content of the official ElevenLabs API documentation page hosted on Mintlify.
Retrieves the audio content for a specific history item from ElevenLabs, using a `history_item_id` that must correspond to a previously generated audio.
Tool to retrieve player settings for a specific Audio Native project. Use when you need to check the current configuration of an audio-native project, including display settings, colors, and status.
Tool to get detailed information about a batch call including all recipients. Use when you need to check the status, progress, or results of a previously submitted batch calling job.
Tool to retrieve all batch calls for the current workspace. Use when you need to list all batch calling campaigns, check their status, or find specific batch calls by name or agent.
Fetches comprehensive details for a specific chapter within a given project, including its metadata (name, ID), conversion status, progress, download availability, and content statistics.
Retrieves all saved version snapshots for a specific chapter within a given project, enabling review of its history or reversion to prior states.
Retrieves a list of all chapters, their details, and conversion status for a project, useful for managing content or tracking progress.
Tool to retrieve summaries for specified Conversational AI agents. Use when you need to fetch metadata such as name, tags, creation time, access level, and archival status for one or more agents.
Tool to retrieve Convai dashboard settings for the workspace. Use when you need to inspect configured dashboard charts for monitoring conversational AI performance.
Tool to retrieve a list of available knowledge base documents. Use when you need to browse, search, or filter knowledge base documents by name, type, folder, or ownership. Supports pagination via cursor for large result sets.
Tool to retrieve all RAG indexes for a specified knowledge base document. Use when you need to view the indexing status, models used, and usage statistics for a document's semantic search capabilities.
Tool to retrieve a specific MCP server configuration from the workspace. Use when you need to inspect details of an existing MCP server including its URL, transport type, approval policies, and dependent agents.
Tool to retrieve all tools available for a specific MCP server configuration. Use when you need to inspect what tools an MCP server provides or verify tool availability before using them.
Tool to retrieve all MCP (Model Context Protocol) server configurations available in the workspace. Use when you need to list all registered MCP servers or check which servers are available for conversational AI agents.
Tool to retrieve Convai settings for the workspace. Use when you need to inspect webhook configurations, RAG retention settings, or MCP server capabilities.
Tool to retrieve all available tools in the workspace. Use when you need to list, search, or discover tools that can be used with Conversational AI agents.
Tool to retrieve all workspace secrets for the user. Use when you need to list stored secrets that can be used for authentication and integration with conversational AI agents. Supports pagination.
Tool to fetch full details for a single Conversational AI conversation by ID. Use when you need transcript-level analysis, metadata, or audio status flags for a specific conversation.
Tool to get a signed URL to start a conversation with an agent that requires authorization. Use when you need to obtain a secure WebSocket URL for initiating a conversation session.
Tool to retrieve the complete configuration for a specific Conversational AI agent by ID. Use when you need to inspect or audit an agent's settings, workflow, conversation config, or assigned channels.
Tool to retrieve the live count of active ongoing Conversational AI conversations. Use when monitoring real-time conversation activity or checking current load.
Tool to retrieve all conversations of agents that user owns. Use when you need to list conversations, optionally filtered by agent, time range, duration, rating, or other criteria. Supports pagination via cursor.
Tool to retrieve the complete configuration for a specific conversational AI tool by ID. Use when you need to inspect a tool's settings, type, or usage statistics from the workspace.
Retrieves the ElevenLabs text-to-speech service's default voice settings (stability, similarity boost, style, speaker boost) that are applied when no voice-specific or request-specific settings are provided.
Retrieves an existing dubbed audio file for a specific `dubbing_id` and `language_code`.
Retrieves metadata and status for a specific dubbing project by its ID.
Retrieves the textual transcript for a specified dubbing project and language, if one exists for that language in the project.
Retrieves the transcript for a specific dubbing project and language in the requested format (SRT, WebVTT, or JSON). Use this when you need subtitles or detailed transcript data with timing information for a dubbed video or audio.
Retrieves metadata for a list of generated audio items from history, supporting pagination and optional filtering by voice ID.
Retrieves detailed information (excluding the audio file) for a specific audio generation history item from ElevenLabs, using its unique ID.
Tool to retrieve a list of agents depending on a specific knowledge base document. Use when you need to identify which agents are using a particular document, either directly or transitively.
Tool to retrieve the entire content of a document from the knowledge base. Use when you need to access or read the full text content of a knowledge base document.
Tool to get details about a specific documentation making up the agent's knowledge base. Use when you need to retrieve information about a knowledge base document, including its content, type, and metadata.
Tool to retrieve RAG index overview including total size and usage information. Use when you need to check storage limits, monitor usage, or understand which embedding models are consuming space in knowledge base documents.
Tool to get a signed URL to download the original source file of a file-type document from the knowledge base. Use when you need to download the original file that was uploaded to create a knowledge base document.
Tool to retrieve knowledge base document summaries by their IDs. Use when you need to get summaries for multiple knowledge base documents in a single request.
Tool to retrieve configuration overrides for a specific MCP tool within an MCP server. Use when you need to inspect the custom execution settings for individual tools.
Retrieves a detailed list of all available ElevenLabs text-to-speech (TTS) models and their capabilities.
Tool to retrieve detailed configuration for a specific phone number by ID. Use when you need to inspect a phone number's provider details, capabilities, agent assignments, or SIP trunk configuration.
Use to retrieve all details for a specific project, including its chapters and their conversion statuses, by providing the project's unique ID.
Retrieves all available snapshots (saved states or versions) for an existing project, enabling history tracking, version comparison, or accessing specific states for playback/processing, particularly in text-to-speech workflows.
Fetches a list of all projects and their details associated with the user's ElevenLabs account; this is a read-only operation.
Retrieves a paginated list of pronunciation dictionaries, used to customize how specific words or phrases are pronounced by the text-to-speech (TTS) engine.
Retrieves metadata for a specific, existing pronunciation dictionary from ElevenLabs using its ID.
Downloads the Pronunciation Lexicon Specification (PLS) file for an existing version of a pronunciation dictionary from ElevenLabs, used to customize TTS pronunciation.
Retrieves the audio for a given `sample_id` that must belong to the specified `voice_id`.
Tool to list all service accounts in the workspace. Use when you need to view service accounts, their associated API keys, or manage workspace access.
Retrieves a paginated and filterable list of shared voices from the ElevenLabs Voice Library.
Returns a list of shared voices similar to the provided audio sample. Use when you need to find voice matches based on audio characteristics. If neither similarity_threshold nor top_k is provided, default values will be applied.
Retrieves the SSO provider configuration for a specified workspace, typically for review purposes, and will indicate if no configuration exists.
Tool to retrieve a list of agents depending on a specific tool. Use when you need to identify which agents are using a particular tool in their configuration.
Tool to retrieve usage metrics for the current user or entire workspace. Returns time-series data with configurable aggregation intervals and breakdown types. Use when analyzing character usage patterns, tracking consumption by voice, user, or other dimensions over time.
Retrieves detailed information about the authenticated ElevenLabs user's account, including subscription, usage, API key, and status.
Retrieves the profile information for the authenticated ElevenLabs user (identified by API key).
Retrieves detailed subscription information for the currently authenticated ElevenLabs user.
Retrieves comprehensive details for a specific, existing voice by its `voice_id`, optionally including its settings.
Retrieves the stability, similarity, style, and speaker boost settings for a specific, existing ElevenLabs voice using its `voice_id`.
Retrieves a list of all available voices along with their detailed attributes and settings.
Tool to get metadata of a workspace resource by ID and type. Use when you need access control information, creator details, or sharing options for a specific resource.
Tool to list all webhooks configured for the workspace. Use when you need to view existing webhook configurations or verify webhook settings.
Tool to list all agent response tests with pagination support and optional search filtering. Use when you need to retrieve available tests, search tests by name, or paginate through large test collections.
Tool to list dubbing projects you have access to. Use when you need to retrieve dubs, check their status, or paginate through available dubbing projects.
Tool to list all imported phone numbers in the workspace. Use when you need to find available phone numbers, check their capabilities (inbound/outbound), or verify which agent is assigned to a number.
Tool to list all test invocations for a specific conversational AI agent with pagination support. Use when you need to retrieve test invocation history, check test results, or paginate through large sets of test runs.
Tool to list all WhatsApp accounts in the workspace. Use when you need to view available WhatsApp Business accounts, check which agents are assigned to WhatsApp numbers, or retrieve WhatsApp phone number details.
Tool to move multiple documents or folders from one folder to another in the knowledge base. Use when you need to reorganize multiple knowledge base items at once by moving them to a different folder or to the root level.
Tool to move a knowledge base document or folder to a different folder. Use when you need to reorganize your knowledge base by moving entities between folders or to the root level.
Tool to place an outbound call via SIP trunk. Use when you need to initiate a voice call through an ElevenLabs agent after obtaining required IDs. Prerequisites: - The API key must have Conversational AI (convai) permissions enabled. For write operations like initiating calls, ensure your API key has the appropriate convai write scope. - A valid SIP trunk phone number must be configured for outbound calls in ElevenLabs. - The SIP trunk must have valid outbound configuration with proper address and credentials. - The agent must be properly configured in the Conversational AI platform.
Tool to register a Twilio call and return TwiML to connect the call to an ElevenLabs Conversational AI agent. Use when you need to integrate ElevenLabs agents with your own Twilio infrastructure for inbound or outbound calls.
Permanently removes exact-match pronunciation rules from a specified ElevenLabs pronunciation dictionary using a list of rule strings; non-matching rule strings are ignored and this action cannot add or modify rules.
Tool to resubmit specific test runs from a test invocation for a conversational AI agent. Use when you need to re-run failed tests or specific test cases from a previous test invocation.
Tool to retry a batch call, calling failed and no-response recipients again. Use when you need to retry unsuccessful calls from a previous batch calling campaign.
Tool to run selected tests on a conversational AI agent with optional configuration overrides. Use when you need to execute automated tests on an agent to validate responses, tool calls, or conversation flows. Supports running up to 200 tests in a single invocation with optional branch-specific or configuration override testing.
Tool to set or update the avatar image for a Conversational AI agent displayed in the widget. Use when you need to customize the visual appearance of an agent by uploading a profile image.
Tool to run a simulated conversation between an agent and an AI user. Use when testing agent behavior with specific scenarios or evaluating conversation flow. Returns full transcript with analysis including success metrics and conversation summary.
Converts an input audio file to speech using a specified voice; if a `model_id` is provided, it must support speech-to-speech conversion.
Converts an input audio stream to a different voice output stream in real-time, using a specified speech-to-speech model.
Tool to remove background noise from audio and stream the isolated result. Use when you need to clean up audio recordings by isolating vocals/speech and removing unwanted background noise. The audio file must be at least 4.6 seconds long.
Streams the audio for a specified chapter snapshot from an ElevenLabs project, optionally converting the output to MPEG format.
Tool to run a simulated conversation between an agent and a simulated user, streaming back the response. Response is streamed as partial lists of messages that should be concatenated, with a final message containing conversation analysis once complete.
Streams audio from a specific project snapshot, optionally converting it to MPEG format.
Tool to submit a batch call. Use when you need to initiate multiple calls (voice or WhatsApp) at once. Triggers real outbound calls immediately (if no scheduled_time_unix is set) or at the scheduled time — always confirm recipient list and call count with the user before executing.
Converts text to speech using a specified ElevenLabs voice and model, returning a downloadable audio file (use ELEVENLABS_TEXT_TO_SPEECH_STREAM for streaming instead). Audio URL is nested at `data.file.s3url` in the response. Keep `voice_id`, `model_id`, and `output_format` consistent across all chunks to avoid audible artifacts when concatenating. Some voice/model/format combinations require specific subscription tiers; test with a short sample before full runs. HTTP 429 on burst batches; respect `Retry-After` headers.
Converts text to a spoken audio stream (no saved file or history entry); use the non-streaming text-to-speech tool when a persistent audio URL is needed. Allows latency optimization, specific output formats (some tier-dependent), and custom pronunciations; ensure the chosen model supports text-to-speech and text is preferably under 5000 characters. Keep voice_id, model_id, and output_format consistent across multi-chunk sessions to avoid audio artifacts.
Tool to update an existing ElevenLabs Conversational AI agent response test by ID. Use when you need to modify test configuration, chat history, success conditions, or other test parameters.
Tool to update content for an Audio Native project by uploading a text or HTML file. Use when you need to refresh or change the content of an existing Audio Native project. Optionally auto-convert to audio and auto-publish the new snapshot.
Tool to update Convai dashboard settings for the workspace. Use when you need to configure dashboard charts for monitoring conversational AI performance.
Tool to update Convai settings for the workspace. Use when you need to modify webhook configurations, RAG retention settings, MCP server capabilities, or Livekit stack preferences.
Tool to update an existing secret in the ElevenLabs ConvAI workspace. Use when you need to modify the name or value of an existing API key, token, or other sensitive value stored in the workspace.
Tool to update an existing ElevenLabs Conversational AI agent's settings. Use when you need to modify an agent's configuration, such as changing its name, conversation settings, workflow, or platform settings.
Tool to update an existing conversational AI tool in ElevenLabs workspace. Use when modifying tool settings, descriptions, API endpoints, or behavior configurations. Requires the complete tool_config object with all required fields for the tool type.
Tool to update the name of a knowledge base document in ElevenLabs Conversational AI. Use when you need to rename an existing knowledge base document.
Updates a project's pronunciation dictionaries on ElevenLabs to improve text-to-speech accuracy for specialized terms; note that while multiple dictionaries can be applied, the UI only displays the first.
Partially updates a pronunciation dictionary's metadata (name or archived status) without changing its version. Use when you need to rename or archive/unarchive a dictionary.
Tool to update a specified workspace webhook by its ID. Use when you need to modify webhook settings such as the display name or enable/disable status.
Fetches configurable parameters for ElevenLabs voice generation, used to determine available settings (e.g., accents, character limits) prior to audio synthesis; returns metadata only, not audio.