# ElevenLabs Create natural AI voices instantly in any language - perfect for video creators, developers, and businesses. - **Category:** artificial intelligence - **Auth:** API_KEY - **Composio Managed App Available?** N/A - **Tools:** 155 - **Triggers:** 0 - **Slug:** `ELEVENLABS` - **Version:** 20260316_00 ## Tools ### Add a pronunciation dictionary from file **Slug:** `ELEVENLABS_ADD_A_PRONUNCIATION_DICTIONARY` Adds a new pronunciation dictionary from a lexicon file to improve speech synthesis accuracy. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `file` | object | No | A lexicon file (typically .pls XML) containing pronunciation rules. | | `name` | string | No | A descriptive name for the pronunciation dictionary. | | `description` | string | No | Optional detailed description of the pronunciation dictionary and its purpose. | | `workspace_access` | string ("admin" | "editor" | "viewer") | No | Access level for the pronunciation dictionary within the workspace (admin, editor, or viewer). | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Add outbound phone number **Slug:** `ELEVENLABS_ADD_OUTBOUND_PHONE_NUMBER` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `sid` | string | No | Twilio Account SID (required when provider is 'twilio') | | `label` | string | Yes | Descriptive label for the phone number | | `token` | string | No | Twilio Auth Token (required when provider is 'twilio') | | `provider` | string | Yes | Provider type: 'twilio' or 'sip_trunk' | | `phone_number` | string | Yes | Phone number to import in E.164 format | | `region_config` | object | No | Region configuration for Twilio phone number. | | `supports_inbound` | boolean | No | Enable inbound call capability for this number | | `supports_outbound` | boolean | No | Enable outbound call capability for this number | | `inbound_trunk_config` | object | No | Inbound configuration for SIP trunk. | | `outbound_trunk_config` | object | No | Outbound configuration for SIP trunk. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Add new project with attributes **Slug:** `ELEVENLABS_ADD_PROJECT` 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`. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `name` | string | No | A unique name for the project, crucial for its identification and management. | | `title` | string | No | Optional title for the project, distinct from `name` (e.g., for a book title). | | `author` | string | No | Optional author for the project (e.g., for a book). | | `from_url` | string | No | URL to extract content for initializing the project. Use instead of `from_document`. | | `isbn_number` | string | No | Optional ISBN for the project, typically for audiobooks. | | `callback_url` | string | No | Optional URL for a POST request with project conversion status updates. | | `from_document` | object | No | Document file (e.g..txt.epub.pdf) to upload for initializing project content. Use instead of `from_url`. | | `quality_preset` | string ("standard" | "high" | "ultra" | "ultra_lossless") | No | Output quality of generated audio. | | `default_model_id` | string | No | Model ID for synthesis (e.g., 'eleven_multilingual_v2'; see GET /v1/models); uses default model if unspecified. | | `volume_normalization` | boolean | No | Apply general volume normalization to audio output. | | `default_title_voice_id` | string | No | Voice ID for titles (see GET /v1/voices); uses ElevenLabs default if unspecified. | | `acx_volume_normalization` | boolean | No | Apply ACX (Audiobook Creation Exchange) volume normalization to audio output. | | `default_paragraph_voice_id` | string | No | Voice ID for paragraphs (see GET /v1/voices); uses ElevenLabs default if unspecified. | | `pronunciation_dictionary_locators` | array | No | List of pronunciation dictionary locators (format: 'dictionary_id@version_id') for custom pronunciations. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Add pronunciation dictionary from rules **Slug:** `ELEVENLABS_ADD_PRONUNCIATION_DICTIONARY_FROM_RULES` 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). #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `name` | string | Yes | The name of the pronunciation dictionary, used for identification only | | `rules` | array | Yes | List of pronunciation rules defining text replacements. Each rule can be either an alias rule (simple text replacement) or a phoneme rule (phonetic pronunciation using IPA or other alphabet). Minimum 1 rule required. | | `description` | string | No | A description of the pronunciation dictionary, used for identification only | | `workspace_access` | string ("admin" | "editor" | "viewer") | No | Valid workspace access levels for pronunciation dictionaries. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Add rules to the pronunciation dictionary **Slug:** `ELEVENLABS_ADD_RULES_TO_THE_PRONUNCIATION_DICTIONARY` Adds one or more custom pronunciation rules (alias or phoneme) to an existing pronunciation dictionary. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `rules` | array | Yes | List of pronunciation rule objects, each defining an 'alias' or 'phoneme' transformation for a specific string. - **Alias Rule**: Use `type: "alias"`, `string_to_replace`, and `alias` (replacement text). Example: `{"type": "alias", "string_to_replace": "ASAP", "alias": "as soon as possible"}`. - **Phoneme Rule**: Use `type: "phoneme"`, `string_to_replace`, `phoneme` (phonetic transcription), and `alphabet` (e.g., 'ipa'). Example: `{"type": "phoneme", "string_to_replace": "gnocchi", "phoneme": "ˈɲɔkki", "alphabet": "ipa"}`. | | `pronunciation_dictionary_id` | string | Yes | Identifier of an existing pronunciation dictionary to which rules will be added. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Add sharing voice **Slug:** `ELEVENLABS_ADD_SHARING_VOICE` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `new_name` | string | Yes | Name to assign the shared voice in the user's library, displayed on the ElevenLabs website. | | `voice_id` | string | Yes | Unique identifier of the shared voice to be added. | | `public_user_id` | string | Yes | Public user ID of the ElevenLabs user to whom the shared voice will be added. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Add a voice **Slug:** `ELEVENLABS_ADD_VOICE` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `name` | string | Yes | Name for the new voice, used as its identifier in the platform. | | `files` | array | Yes | List of audio files for voice cloning. Each file should be a Supported formats: mp3, wav, ogg. At least one file is required, and 1-2 minutes of clear audio without background noise is recommended. | | `labels` | string | No | Optional stringified JSON object of key-value pairs for categorizing the voice. Example: {"accent": "American", "style": "narration"} | | `description` | string | No | Optional description for the voice, detailing its characteristics or intended use cases. | | `remove_background_noise` | boolean | No | If set to true, will remove background noise from voice samples using the audio isolation model. Only use if samples contain background noise; using it on clean audio can reduce quality. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Attach phone number to agent **Slug:** `ELEVENLABS_ATTACH_PHONE_NUMBER_TO_AGENT` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `label` | string | No | Descriptive label for the phone number | | `agent_id` | string | No | ID of the agent to assign to the phone number. Set to null to unassign the phone number from any agent. | | `livekit_stack` | string ("standard" | "static") | No | Type of LiveKit stack to use | | `phone_number_id` | string | Yes | The unique identifier of the phone number to update | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Calculate ConvAI Agent LLM Usage **Slug:** `ELEVENLABS_CALCULATE_CONVAI_AGENT_LLM_USAGE` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `agent_id` | string | Yes | Unique identifier for the agent | | `rag_enabled` | boolean | No | Whether RAG is enabled | | `prompt_length` | integer | No | Length of the prompt in characters | | `number_of_pages` | integer | No | Pages of content in pdf documents OR urls in agent's Knowledge Base | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Calculate ConvAI LLM Usage **Slug:** `ELEVENLABS_CALCULATE_CONVAI_LLM_USAGE` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `rag_enabled` | boolean | Yes | Whether RAG (Retrieval-Augmented Generation) is enabled. | | `prompt_length` | integer | Yes | Length of the prompt in characters. | | `number_of_pages` | integer | Yes | Pages of content in PDF documents or URLs in the agent's knowledge base. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Cancel Batch Call **Slug:** `ELEVENLABS_CANCEL_CONVAI_BATCH_CALL` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `batch_id` | string | Yes | Unique identifier of the batch call to cancel | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Convert chapter to audio **Slug:** `ELEVENLABS_CONVERT_CHAPTER` Converts the textual content of a chapter, identified by `chapter_id` within a `project_id`, into audio format. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `chapter_id` | string | Yes | Identifier of the chapter to be converted. | | `project_id` | string | Yes | Identifier of the project containing the chapter to be converted. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Convert a project **Slug:** `ELEVENLABS_CONVERT_PROJECT` Converts an existing ElevenLabs Studio project, including all its chapters and using its configured settings and voices, into speech. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `project_id` | string | Yes | Identifier of the project to convert; find available IDs via the GET /v1/studio/projects endpoint. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create a previously generated voice **Slug:** `ELEVENLABS_CREATE_A_PREVIOUSLY_GENERATED_VOICE` Finalizes the creation of a voice using its `generated_voice_id` from a previous generation step by assigning a name, description, and optional labels. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `labels` | object | No | Key-value metadata to associate with the voice. | | `voice_name` | string | Yes | Name for the newly created voice. | | `voice_description` | string | Yes | Detailed description for the newly created voice, its characteristics, or intended use. | | `generated_voice_id` | string | Yes | Identifier of a previously generated voice (e.g., from POST /v1/voice-generation/generate-voice), used to finalize its creation. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create Conversational AI Agent Test **Slug:** `ELEVENLABS_CREATE_CONVAI_AGENT_TESTING` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `name` | string | Yes | Name for the test case to identify it later | | `type` | string ("llm" | "tool" | "simulation") | Yes | Type of test to create: 'llm' for response testing, 'tool' for tool execution testing, or 'simulation' for conversation simulation testing | | `chat_history` | array | No | Array of messages representing the conversation history to test against. Each message must include role ('user' or 'agent'), time_in_call_secs (float), and optional message text content. | | `failure_examples` | array | No | Examples of failed or incorrect agent responses for LLM tests | | `success_examples` | array | No | Examples of successful agent responses for LLM tests | | `dynamic_variables` | object | No | Key-value pairs of variables to be dynamically injected into the test context | | `success_condition` | string | No | Required for 'llm' and 'simulation' types. Natural language description of what constitutes a successful agent response | | `simulation_scenario` | string | No | Required for 'simulation' type. Natural language description of the scenario to simulate in the conversation | | `simulation_max_turns` | integer | No | For 'simulation' type tests: Maximum number of conversation turns to simulate | | `tool_call_parameters` | string | No | For 'tool_call' type tests: Expected parameters for the tool that should be called by the agent | | `check_any_tool_matches` | string | No | For 'tool_call' type tests: Whether to check if any tool matches the expected call pattern | | `from_conversation_metadata` | string | No | Metadata from a previous conversation to use as context for this test | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Add to ConvAI Knowledge Base **Slug:** `ELEVENLABS_CREATE_CONVAI_KNOWLEDGE_BASE` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `url` | string | No | URL to a documentation webpage that the agent will have access to. Either 'file' or 'url' must be provided, but not both. | | `file` | object | No | Documentation file to upload. Supported formats: PDF, TXT, DOC, DOCX. Either 'file' or 'url' must be provided, but not both. | | `name` | string | No | Custom, human-readable name for the document in the knowledge base | | `agent_id` | string | No | Specific agent ID to associate this knowledge base document with | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create ConvAI Knowledge Base File **Slug:** `ELEVENLABS_CREATE_CONVAI_KNOWLEDGE_BASE_FILE` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `file` | object | Yes | Documentation file that the agent will have access to for interacting with users. | | `name` | string | No | A custom, human-readable name for the document. If not provided, the filename will be used. | | `parent_folder_id` | string | No | If set, the created document will be placed inside the given folder. Leave empty to place in root. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create ConvAI Knowledge Base Folder **Slug:** `ELEVENLABS_CREATE_CONVAI_KNOWLEDGE_BASE_FOLDER` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `name` | string | Yes | A custom, human-readable name for the folder | | `parent_folder_id` | string | No | If set, the created folder will be placed inside the given parent folder. Leave empty to create at root level. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create ConvAI Knowledge Base RAG Index **Slug:** `ELEVENLABS_CREATE_CONVAI_KNOWLEDGE_BASE_RAG_INDEX` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `items` | array | Yes | List of requested RAG indexes to create or retrieve (1-100 items) | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create Knowledge Base Text Document **Slug:** `ELEVENLABS_CREATE_CONVAI_KNOWLEDGE_BASE_TEXT` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `name` | string | No | A custom, human-readable name for the document. | | `text` | string | Yes | Text content to be added to the knowledge base. | | `parent_folder_id` | string | No | If set, the created document will be placed inside the given folder. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create Knowledge Base URL Document **Slug:** `ELEVENLABS_CREATE_CONVAI_KNOWLEDGE_BASE_URL` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `url` | string | Yes | URL to a page of documentation that the agent will have access to in order to interact with users | | `name` | string | No | A custom, human-readable name for the document | | `parent_folder_id` | string | No | If set, the created document or folder will be placed inside the given folder | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create ConvAI Workspace Secret **Slug:** `ELEVENLABS_CREATE_CONVAI_SECRET` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `name` | string | Yes | Name identifier for the secret. Must be unique within the workspace. | | `type` | string ("new") | Yes | Type of secret to create. Currently only 'new' is supported by the API. | | `value` | string | Yes | The secret value to store securely in the workspace. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create Conversational AI Tool **Slug:** `ELEVENLABS_CREATE_CONVAI_TOOL` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `name` | string | Yes | Tool name. Must match pattern ^[a-zA-Z0-9_-]{1,64}$ (alphanumeric, hyphens, underscores only, no spaces, 1-64 characters) | | `params` | object | No | System tool parameters (required for system tools) | | `tool_type` | string ("webhook" | "client" | "system" | "mcp") | Yes | Type of tool to create: 'webhook' for HTTP endpoints, 'client' for client-side execution, 'system' for built-in tools, or 'mcp' for MCP integration | | `api_schema` | object | No | API schema configuration (required for webhook tools). Should include endpoint URL and HTTP method details | | `parameters` | object | No | Tool parameters schema (for client and MCP tools) | | `assignments` | array | No | Tool assignments for routing to specific conversations | | `description` | string | Yes | Tool description explaining what it does | | `mcp_server_id` | string | No | MCP server ID (required for MCP tools) | | `mcp_tool_name` | string | No | MCP tool name (required for MCP tools) | | `execution_mode` | string ("immediate" | "post_tool_speech" | "async") | No | Execution mode for the tool. | | `approval_policy` | string ("always" | "never" | "ask") | No | MCP approval policy. | | `mcp_server_name` | string | No | MCP server name (required for MCP tools) | | `tool_call_sound` | string | No | Sound to play during tool call | | `expects_response` | boolean | No | Whether the client tool expects a response (for client tools) | | `integration_type` | string ("mcp") | No | Integration type for MCP tools. | | `mcp_input_schema` | object | No | MCP input schema (for MCP tools) | | `dynamic_variables` | object | No | Dynamic variables configuration (for webhook and client tools) | | `mcp_tool_description` | string | No | MCP tool description (required for MCP tools) | | `disable_interruptions` | boolean | No | Whether to disable interruptions during tool execution | | `force_pre_tool_speech` | boolean | No | Force speech before tool execution | | `response_timeout_secs` | integer | No | Response timeout in seconds | | `tool_call_sound_behavior` | string ("auto" | "always") | No | Sound behavior during tool calls. | | `tool_error_handling_mode` | string ("auto" | "summarized" | "passthrough" | "hide") | No | How to handle tool execution errors. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create Conversational AI Agent **Slug:** `ELEVENLABS_CREATE_CONVERSATIONAL_AGENT` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `name` | string | No | Human-readable name for the agent | | `tags` | array | No | List of tags to organize and categorize the agent | | `workflow` | object | No | Workflow configuration defining conditional logic, tool execution modes, and conversation flow patterns for the agent | | `platform_settings` | string | No | Platform-specific settings including evaluation criteria, widget configuration, data collection schemas, auth requirements, call limits, and privacy settings. For widget.variant, valid values are: 'tiny', 'compact', 'full', or 'expandable'. | | `conversation_config` | object | Yes | Configuration object defining the agent's conversational behavior. Must include agent settings (prompt, llm, language, first_message), and can optionally include asr, tts, turn, conversation, and vad settings. Example: {'agent': {'prompt': {'prompt': 'You are a helpful assistant', 'llm': 'gpt-4o'}}} | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Generate Music Composition Plan **Slug:** `ELEVENLABS_CREATE_MUSIC_PLAN` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `prompt` | string | Yes | A simple text prompt to compose a plan from. Describe the musical style, mood, instruments, or other characteristics you want in the composition. | | `model_id` | string ("music_v1") | No | The model to use for the generation. | | `music_length_ms` | integer | No | The length of the composition plan to generate in milliseconds. Must be between 3000ms (3 seconds) and 600000ms (10 minutes). If not provided, the model will choose a length based on the prompt. | | `source_composition_plan` | object | No | Optional source composition plan for generating variations. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create an AudioNative enabled project **Slug:** `ELEVENLABS_CREATES_AUDIONATIVE_ENABLED_PROJECT` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `file` | object | No | Content file (e.g., TXT, HTML) to be converted into audio. | | `name` | string | No | User-defined name for the AudioNative project. | | `image` | string | No | URL for an image in the AudioNative player; a default or no image is used if omitted. | | `small` | boolean | No | Set to `True` for a compact player; `False` (default) for standard size. | | `title` | string | No | Title of the content, for display in the AudioNative player. | | `author` | string | No | Author of the content, for display in the AudioNative player. | | `model_id` | string | No | Identifier for the ElevenLabs TTS model. Allowed models for AudioNative: 'eleven_multilingual_v2', 'eleven_turbo_v2_5', 'eleven_turbo_v2', 'eleven_monolingual_v1', 'eleven_multilingual_v1'. A default is used if omitted. | | `voice_id` | string | No | Identifier for the ElevenLabs voice; a default is used if omitted. See '/v1/voices' for available IDs. | | `text_color` | string | No | Hex color code for player text (must start with '#', e.g., '#FFFFFF' for white, '#000000' for black). | | `auto_convert` | boolean | No | If `True`, automatically converts content to audio after project creation; `False` (default). | | `sessionization` | integer | No | Interval in days for automatic audio reconversion; `0` (default) disables it (e.g., `1` daily, `7` weekly). | | `background_color` | string | No | Hex color code for player background (must start with '#', e.g., '#000000' for black, '#FFFFFF' for white). | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get similar library voices **Slug:** `ELEVENLABS_CREATE_SIMILAR_VOICES` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `top_k` | integer | No | Number of most similar voices to return. If similarity_threshold is provided, fewer voices may be returned. Values range from 1 to 100. Default values will be applied if not specified. | | `audio_file` | object | Yes | Audio file to find similar voices for. Supported formats: mp3, wav, ogg. | | `similarity_threshold` | number | No | Threshold for voice similarity between provided sample and library voices. Values range from 0 to 2. The smaller the value, the more similar voices will be returned. Default values will be applied if not specified. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create Single Use Token **Slug:** `ELEVENLABS_CREATE_SINGLE_USE_TOKEN` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `token_type` | string ("realtime_scribe" | "tts_websocket") | Yes | Type of single-use token to generate. Options: 'realtime_scribe' for real-time transcription, 'tts_websocket' for text-to-speech WebSocket connections. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create Workspace Webhook **Slug:** `ELEVENLABS_CREATE_WORKSPACE_WEBHOOK` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `settings` | object | Yes | Webhook configuration settings including auth_type, name, and webhook_url | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete chapter from project **Slug:** `ELEVENLABS_DELETE_CHAPTER` Irreversibly deletes a specific, existing chapter from an existing project, typically to remove unwanted or obsolete content. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `chapter_id` | string | Yes | Identifier of the chapter to be deleted. To find available `chapter_id`s for a project, you can query GET `https://api.elevenlabs.io/v1/studio/projects/{project_id}/chapters`. | | `project_id` | string | Yes | Identifier of the project. To find available `project_id`s, you can query GET `https://api.elevenlabs.io/v1/studio/projects`. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete Conversational AI Agent **Slug:** `ELEVENLABS_DELETE_CONVAI_AGENT` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `agent_id` | string | Yes | The unique identifier of the agent to delete. This is returned on agent creation. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete agent response test **Slug:** `ELEVENLABS_DELETE_CONVAI_AGENT_TESTING` Tool to delete an agent response test by ID. Use when you need to remove a test result or clean up test data. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `test_id` | string | Yes | The id of a chat response test. This is returned on test creation. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete batch call **Slug:** `ELEVENLABS_DELETE_CONVAI_BATCH_CALLING` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `batch_id` | string | Yes | The unique identifier of the batch call to permanently delete. Format: btcal_ | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete conversation by ID **Slug:** `ELEVENLABS_DELETE_CONVAI_CONVERSATION` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `conversation_id` | string | Yes | The unique identifier of the conversation to delete. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete Knowledge Base Document or Folder **Slug:** `ELEVENLABS_DELETE_CONVAI_KNOWLEDGE_BASE` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `force` | boolean | No | If set to true, the document or folder will be deleted regardless of whether it is used by any agents and it will be removed from the dependent agents. For non-empty folders, this will also delete all child documents and folders. | | `documentation_id` | string | Yes | The id of a document from the knowledge base. This is returned on document addition. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete ConvAI Knowledge Base RAG Index **Slug:** `ELEVENLABS_DELETE_CONVAI_KNOWLEDGE_BASE_RAG_INDEX` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `rag_index_id` | string | Yes | The id of RAG index of document from the knowledge base. | | `documentation_id` | string | Yes | The id of a document from the knowledge base. This is returned on document addition. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete workspace secret **Slug:** `ELEVENLABS_DELETE_CONVAI_SECRET` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `secret_id` | string | Yes | The unique identifier of the workspace secret to delete. This ID is returned when creating or listing secrets. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete conversational AI tool **Slug:** `ELEVENLABS_DELETE_CONVAI_TOOL` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `tool_id` | string | Yes | ID of the requested tool. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete a dubbing project **Slug:** `ELEVENLABS_DELETE_DUBBING_PROJECT` Permanently deletes a dubbing project by its ID; this action is irreversible and the project cannot be recovered. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `dubbing_id` | string | Yes | The unique identifier for the dubbing project to be deleted. This ID is typically obtained when the dubbing project is created or listed. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete history item **Slug:** `ELEVENLABS_DELETE_HISTORY_ITEM` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `history_item_id` | string | Yes | Unique identifier of the history item to be deleted. This ID is obtainable by listing history items, for example, via the GET `/v1/history` endpoint. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete MCP server **Slug:** `ELEVENLABS_DELETE_MCP_SERVER` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `mcp_server_id` | string | Yes | ID of the MCP Server to delete from the workspace. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete phone number by id **Slug:** `ELEVENLABS_DELETE_PHONE_NUMBER` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `phone_number_id` | string | Yes | The ID of the phone number to delete. This is returned on phone number creation. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete project by id **Slug:** `ELEVENLABS_DELETE_PROJECT` Use to irreversibly delete a specific project by its `project_id`; the project must exist and be accessible, and this action cannot be undone. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `project_id` | string | Yes | Identifier of the project to delete. Obtain by listing projects (e.g., via GET /v1/studio/projects). | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete voice sample **Slug:** `ELEVENLABS_DELETE_SAMPLE` Permanently deletes a specific voice sample for a given voice ID; this action is irreversible. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `voice_id` | string | Yes | Voice ID to be used, you can use https://api.elevenlabs.io/v1/voices to list all the available voices. | | `sample_id` | string | Yes | Sample ID to be used, you can use GET https://api.elevenlabs.io/v1/voices/{voice_id} to list all the available samples for a voice. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete voice by id **Slug:** `ELEVENLABS_DELETE_VOICE` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `voice_id` | string | Yes | The unique identifier of the voice to be deleted. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete workspace webhook **Slug:** `ELEVENLABS_DELETE_WORKSPACE_WEBHOOK` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `webhook_id` | string | Yes | The unique ID for the webhook | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Download history items **Slug:** `ELEVENLABS_DOWNLOAD_HISTORY_ITEMS` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `output_format` | string | No | Optional. Specifies the desired output audio format. Accepts 'wav' to convert the audio to WAV format. If omitted, the audio is returned in its original synthesized format (e.g., mp3). This formatting applies to each audio file, even when multiple files are downloaded and returned as a ZIP archive. | | `history_item_ids` | array | Yes | A list of unique string identifiers for the history items to be downloaded. These IDs can be obtained using the `GET /v1/history` endpoint. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Dub a video or an audio file **Slug:** `ELEVENLABS_DUB_A_VIDEO_OR_AN_AUDIO_FILE` 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'. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `file` | object | No | Video or audio file to dub. Required if 'source_url' is not provided. | | `mode` | string | No | Specifies dubbing mode: 'automatic' for AI-driven dubbing, or 'manual' using a .csv file for timestamped transcriptions. API defaults to 'automatic' if unspecified. | | `name` | string | No | Name for the dubbing project. | | `csv_file` | object | No | CSV file with guidance for 'manual' mode dubbing. Required if 'mode' is 'manual'. | | `end_time` | integer | No | End time (seconds) for the audio portion to dub. API defaults to audio end if unspecified. | | `watermark` | boolean | No | Include a watermark in the dubbed audio. | | `source_url` | string | No | URL of the video or audio file to dub. Required if 'file' is not provided. | | `start_time` | integer | No | Start time (seconds) for the audio portion to dub. API defaults to audio start if unspecified. | | `source_lang` | string | No | Language of the original audio. Use 'auto' for automatic detection or provide a language code (e.g., 'en', 'es'). | | `target_lang` | string | No | Required target language code for dubbing (e.g., 'en', 'es'). | | `num_speakers` | integer | No | Number of speakers in the audio. Use 0 for automatic detection; otherwise, model attempts to differentiate this many speakers. | | `dubbing_studio` | boolean | No | Enable Dubbing Studio features for advanced editing capabilities, if available. | | `highest_resolution` | boolean | No | Process dubbing at highest possible resolution; may increase processing time. | | `background_audio_file` | object | No | Background audio track for 'manual' mode with a CSV file. | | `foreground_audio_file` | object | No | Foreground audio track for 'manual' mode with a CSV file. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Duplicate Conversational AI Agent **Slug:** `ELEVENLABS_DUPLICATE_CONVAI_AGENT` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `name` | string | No | A name to make the agent easier to find | | `agent_id` | string | Yes | The id of an agent. This is returned on agent creation. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Edit voice **Slug:** `ELEVENLABS_EDIT_VOICE` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `name` | string | Yes | Name for the voice model. This is a required field. | | `files` | array | No | Optional list of audio files to add to the voice model. Each file should be a Supported formats: mp3, wav, ogg. | | `labels` | string | No | JSON string of key-value pairs for categorization; new labels overwrite existing ones. Example: {"accent": "American", "gender": "male"} | | `voice_id` | string | Yes | Identifier of the voice to be edited; retrieve available IDs via the `/v1/voices` endpoint. Only voices owned by you can be edited. | | `description` | string | No | New description for the voice model. | | `remove_background_noise` | boolean | No | If set to true, will remove background noise from voice samples. Only use if samples contain background noise; using it on clean audio can reduce quality. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Edit voice settings **Slug:** `ELEVENLABS_EDIT_VOICE_SETTINGS` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `speed` | number | No | Controls the speech rate and pacing of the generated audio. Value typically between 0.25 and 4.0. | | `style` | number | No | Adjusts the style exaggeration and expressiveness of the voice. Value between 0.0 and 1.0. Available for V2+ models. Generally recommended to keep at 0. | | `voice_id` | string | Yes | Identifier of the voice whose settings are to be modified. Obtain available voice IDs via the GET /v1/voices endpoint. | | `stability` | number | No | Controls voice consistency and randomness between generations. Value between 0.0 and 1.0. Lower values introduce broader emotional range, higher values result in more monotonous voice. | | `similarity_boost` | number | No | Determines how closely the AI should adhere to the original voice when attempting to replicate it. Value between 0.0 and 1.0. | | `use_speaker_boost` | boolean | No | Boosts the similarity to the original speaker. The differences are generally subtle. Not available for Eleven v3 model. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Generate a random voice **Slug:** `ELEVENLABS_GENERATE_A_RANDOM_VOICE` Generates a unique, random ElevenLabs text-to-speech voice based on input text and specified voice characteristics. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `age` | string ("middle_aged" | "old" | "young") | Yes | Specifies the age category of the generated voice. Possible values are 'young', 'middle_aged', or 'old'. | | `text` | string | Yes | The text to be synthesized into speech. The length of the text must be between 100 and 1000 characters, inclusive. | | `accent` | string | Yes | Specifies the accent of the generated voice. Accepted values include 'american', 'british', 'african', 'australian', 'indian'. | | `gender` | string ("female" | "male") | Yes | Specifies the gender of the generated voice. Possible values are 'female' or 'male'. | | `accent_strength` | number | Yes | Controls the strength of the accent for the generated voice. Must be a numeric value between 0.3 and 2.0, inclusive. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get agent details **Slug:** `ELEVENLABS_GET_AGENT_DETAILS` 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. #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Agent Link **Slug:** `ELEVENLABS_GET_AGENT_LINK` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `agent_id` | string | Yes | The id of an agent. This is returned on agent creation. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get user profile **Slug:** `ELEVENLABS_GET_A_PROFILE_PAGE` Retrieves the profile information for the authenticated ElevenLabs user (identified by API key). #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get audio from history item **Slug:** `ELEVENLABS_GET_AUDIO_FROM_HISTORY_ITEM` Retrieves the audio content for a specific history item from ElevenLabs, using a `history_item_id` that must correspond to a previously generated audio. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `history_item_id` | string | Yes | The unique identifier for the history item. This ID can be obtained by listing your history items (e.g., via an action that calls GET /v1/history). | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get sample audio **Slug:** `ELEVENLABS_GET_AUDIO_FROM_SAMPLE` Retrieves the audio for a given `sample_id` that must belong to the specified `voice_id`. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `voice_id` | string | Yes | Identifier for the voice. A list of available voice IDs can be obtained from the GET https://api.elevenlabs.io/v1/voices endpoint. | | `sample_id` | string | Yes | Identifier for the sample. A list of available sample IDs for a specific voice can be obtained from the GET https://api.elevenlabs.io/v1/voices/{voice_id} endpoint. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get audio native settings **Slug:** `ELEVENLABS_GET_AUDIO_NATIVE_SETTINGS` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `project_id` | string | Yes | The ID of the Studio project. Use the audio-native project ID from when you created the project. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get chapter by ID **Slug:** `ELEVENLABS_GET_CHAPTER_BY_ID` Fetches comprehensive details for a specific chapter within a given project, including its metadata (name, ID), conversion status, progress, download availability, and content statistics. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `chapter_id` | string | Yes | Identifier of the chapter. You can find `chapter_id` by listing all available chapters for a project via the `/v1/studio/projects/{project_id}/chapters` endpoint. | | `project_id` | string | Yes | Identifier of the project. You can find `project_id` by listing all available projects via the `/v1/studio/projects` endpoint. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get chapters by project id **Slug:** `ELEVENLABS_GET_CHAPTERS` Retrieves a list of all chapters, their details, and conversion status for a project, useful for managing content or tracking progress. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `project_id` | string | Yes | Identifier of the Studio project for which to retrieve chapters. You can find available `project_id`s by listing all projects (e.g., via GET https://api.elevenlabs.io/v1/studio/projects). | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get chapter snapshots **Slug:** `ELEVENLABS_GET_CHAPTER_SNAPSHOTS` Retrieves all saved version snapshots for a specific chapter within a given project, enabling review of its history or reversion to prior states. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `chapter_id` | string | Yes | Identifier of the chapter for which snapshots are to be retrieved. | | `project_id` | string | Yes | Identifier of the project containing the chapter. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Conversational AI Agent **Slug:** `ELEVENLABS_GET_CONVAI_AGENT` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `agent_id` | string | Yes | The ID of the agent. This is returned on agent creation. | | `branch_id` | string | No | The ID of the branch to use. If not specified, uses the main branch. | | `version_id` | string | No | The ID of the agent version to use. If not specified, uses the latest version. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Agent Knowledge Base Size **Slug:** `ELEVENLABS_GET_CONVAI_AGENT_KNOWLEDGE_BASE_SIZE` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `agent_id` | string | Yes | The unique identifier of the conversational AI agent. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get ConvAI Agents Summaries **Slug:** `ELEVENLABS_GET_CONVAI_AGENTS_SUMMARIES` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `agent_ids` | array | Yes | List of agent IDs to fetch summaries for. At least one agent ID is required. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Agent Widget Config **Slug:** `ELEVENLABS_GET_CONVAI_AGENTS_WIDGET` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `agent_id` | string | Yes | The id of an agent. This is returned on agent creation. | | `conversation_signature` | string | No | An expiring token that enables a websocket conversation to start. These can be generated for an agent using the /v1/convai/conversation/get-signed-url endpoint | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Agent Response Test By ID **Slug:** `ELEVENLABS_GET_CONVAI_AGENT_TESTING_BY_ID` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `test_id` | string | Yes | The id of a chat response test. This is returned on test creation. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get conversational AI analytics live count **Slug:** `ELEVENLABS_GET_CONVAI_ANALYTICS_LIVE_COUNT` Tool to retrieve the live count of active ongoing Conversational AI conversations. Use when monitoring real-time conversation activity or checking current load. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `agent_id` | string | No | The id of an agent to restrict the analytics to. If not provided, returns analytics across all agents. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get batch call details **Slug:** `ELEVENLABS_GET_CONVAI_BATCH_CALLING` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `batch_id` | string | Yes | The unique identifier of the batch call to retrieve. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Batch Calls for Workspace **Slug:** `ELEVENLABS_GET_CONVAI_BATCH_CALLING_WORKSPACE` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `limit` | integer | No | Maximum number of batch calls to return per page. | | `last_doc` | string | No | Document ID for pagination. Use the 'next_doc' value from a previous response to get the next page of results. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Conversational AI Conversations **Slug:** `ELEVENLABS_GET_CONVAI_CONVERSATIONS` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `cursor` | string | No | Used for fetching next page. Cursor is returned in the response. | | `search` | string | No | Full-text or fuzzy search over transcript messages. | | `user_id` | string | No | Filter conversations by the user ID who initiated them. | | `agent_id` | string | No | The id of the agent you're taking the action on. Use this to restrict results to a specific agent. | | `branch_id` | string | No | Filter conversations by branch ID. | | `page_size` | integer | No | How many conversations to return at maximum. Can not exceed 100, defaults to 30. | | `rating_max` | string | No | Maximum overall rating (1-5). | | `rating_min` | string | No | Minimum overall rating (1-5). | | `tool_names` | string | No | Filter conversations by tool names used during the call. | | `summary_mode` | string ("exclude" | "include") | No | Summary mode for conversation responses. | | `main_languages` | string | No | Filter conversations by detected main language (language code). | | `call_successful` | string | No | The result of the success evaluation. Filter by success status. | | `evaluation_params` | array | No | Evaluation filters. Supports multiple values (repeated query params). Format per value: criteria_id:result. Example: ['value_framing:success', 'tone:professional'] | | `has_feedback_comment` | string | No | Filter conversations with user feedback comments. | | `call_start_after_unix` | string | No | Unix timestamp (in seconds) to filter conversations after to this start date. | | `call_duration_max_secs` | string | No | Maximum call duration in seconds. | | `call_duration_min_secs` | string | No | Minimum call duration in seconds. | | `call_start_before_unix` | string | No | Unix timestamp (in seconds) to filter conversations up to this start date. | | `data_collection_params` | array | No | Data collection filters. Supports multiple values (repeated query params). Format per value: id:op:value where op is one of eq\|neq\|gt\|gte\|lt\|lte\|in\|exists\|missing. For in, pipe-delimit values. | | `conversation_initiation_source` | string | No | Filter conversations by initiation source. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get ConvAI Knowledge Base **Slug:** `ELEVENLABS_GET_CONVAI_KNOWLEDGE_BASE` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `types` | string | No | If present, the endpoint will return only documents of the given types. | | `cursor` | string | No | Used for fetching next page. Cursor is returned in the response. | | `search` | string | No | If specified, the endpoint returns only such knowledge base documents whose names start with this string. | | `sort_by` | string | No | The field to sort the results by. | | `page_size` | integer | No | How many documents to return at maximum. Can not exceed 100, defaults to 30. | | `folders_first` | boolean | No | Whether folders should be returned first in the list of documents. | | `sort_direction` | string ("asc" | "desc") | No | Sort direction for knowledge base documents. | | `parent_folder_id` | string | No | If set, the endpoint will return only documents that are direct children of the given folder. | | `ancestor_folder_id` | string | No | If set, the endpoint will return only documents that are descendants of the given folder. | | `show_only_owned_documents` | boolean | No | If set to true, the endpoint will return only documents owned by you (and not shared from somebody else). | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Knowledge Base Document Content **Slug:** `ELEVENLABS_GET_CONVAI_KNOWLEDGE_BASE_CONTENT` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `documentation_id` | string | Yes | The id of a document from the knowledge base. This is returned on document addition. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Knowledge Base Dependent Agents **Slug:** `ELEVENLABS_GET_CONVAI_KNOWLEDGE_BASE_DEPENDENT_AGENTS` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `cursor` | string | No | Used for fetching next page. Cursor is returned in the response. | | `page_size` | integer | No | How many documents to return at maximum. Can not exceed 100, defaults to 30. | | `dependent_type` | string ("direct" | "transitive" | "all") | No | Type of dependent agents to return. | | `documentation_id` | string | Yes | The id of a document from the knowledge base. This is returned on document addition. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Knowledge Base Documentation **Slug:** `ELEVENLABS_GET_CONVAI_KNOWLEDGE_BASE_DOCUMENTATION` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `agent_id` | string | No | Optional agent ID to scope the knowledge base query | | `documentation_id` | string | Yes | The id of a document from the knowledge base. This is returned on document addition. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Knowledge Base RAG Index Overview **Slug:** `ELEVENLABS_GET_CONVAI_KNOWLEDGE_BASE_RAG_INDEX` 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. #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get ConvAI Knowledge Base RAG Indexes **Slug:** `ELEVENLABS_GET_CONVAI_KNOWLEDGE_BASE_RAG_INDEXES` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `documentation_id` | string | Yes | The id of a document from the knowledge base. This is returned on document addition. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Knowledge Base Source File URL **Slug:** `ELEVENLABS_GET_CONVAI_KNOWLEDGE_BASE_SOURCE_FILE_URL` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `documentation_id` | string | Yes | The id of a document from the knowledge base. This is returned on document addition. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Knowledge Base Summaries **Slug:** `ELEVENLABS_GET_CONVAI_KNOWLEDGE_BASE_SUMMARIES` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `document_ids` | array | Yes | The IDs of knowledge base documents to retrieve summaries for. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get ConvAI MCP Server **Slug:** `ELEVENLABS_GET_CONVAI_MCP_SERVER` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `mcp_server_id` | string | Yes | ID of the MCP Server. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get ConvAI MCP Servers **Slug:** `ELEVENLABS_GET_CONVAI_MCP_SERVERS` 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. #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get ConvAI MCP Server Tools **Slug:** `ELEVENLABS_GET_CONVAI_MCP_SERVER_TOOLS` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `mcp_server_id` | string | Yes | ID of the MCP Server. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Phone Number by ID **Slug:** `ELEVENLABS_GET_CONVAI_PHONE_NUMBER_BY_ID` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `phone_number_id` | string | Yes | The ID of the phone number. This is returned on phone number creation. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get ConvAI Workspace Secrets **Slug:** `ELEVENLABS_GET_CONVAI_SECRETS` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `cursor` | string | No | Used for fetching next page. Cursor is returned in the response. | | `page_size` | integer | No | How many secrets to return at maximum. Can not exceed 100. If not provided, returns all secrets. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Convai Settings **Slug:** `ELEVENLABS_GET_CONVAI_SETTINGS` Tool to retrieve Convai settings for the workspace. Use when you need to inspect webhook configurations, RAG retention settings, or MCP server capabilities. #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Convai Dashboard Settings **Slug:** `ELEVENLABS_GET_CONVAI_SETTINGS_DASHBOARD` Tool to retrieve Convai dashboard settings for the workspace. Use when you need to inspect configured dashboard charts for monitoring conversational AI performance. #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Test Invocations **Slug:** `ELEVENLABS_GET_CONVAI_TEST_INVOCATIONS` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `cursor` | string | No | Cursor for pagination. Use the next_cursor value from a previous response to fetch the next page of results. | | `agent_id` | string | Yes | Filter test invocations by agent ID. This is required to fetch test invocations for a specific agent. | | `page_size` | integer | No | How many test invocations to return at maximum. Cannot exceed 100. Defaults to 30 if not specified. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Conversational AI Tool **Slug:** `ELEVENLABS_GET_CONVAI_TOOL` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `tool_id` | string | Yes | ID of the requested tool. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get ConvAI tools **Slug:** `ELEVENLABS_GET_CONVAI_TOOLS` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `types` | string | No | Filter tools by type. Comma-separated list of tool types. | | `cursor` | string | No | Cursor for pagination. Used to fetch the next page of results. | | `search` | string | No | Filter tools whose names start with this string. | | `sort_by` | string | No | The field to sort the results by. | | `page_size` | integer | No | How many tools to return at maximum. Cannot exceed 100, defaults to 30. | | `sort_direction` | string ("asc" | "desc") | No | Sort direction options for listing tools. | | `show_only_owned_documents` | boolean | No | If set to true, return only tools owned by you (not shared from others). | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Tool Dependent Agents **Slug:** `ELEVENLABS_GET_CONVAI_TOOLS_DEPENDENT_AGENTS` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `cursor` | string | No | Used for fetching next page. Cursor is returned in the response. | | `tool_id` | string | Yes | ID of the requested tool. | | `page_size` | integer | No | How many documents to return at maximum. Can not exceed 100, defaults to 30. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get conversation by ID **Slug:** `ELEVENLABS_GET_CONVERSATION_BY_ID` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `conversation_id` | string | Yes | The unique identifier of the conversation to retrieve. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Conversation Signed URL **Slug:** `ELEVENLABS_GET_CONVERSATION_SIGNED_URL` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `agent_id` | string | Yes | The id of the agent you're taking the action on. | | `branch_id` | string | No | The ID of the branch to use | | `include_conversation_id` | boolean | No | Whether to include a conversation_id with the response. If included, the conversation_signature cannot be used again. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get default voice settings **Slug:** `ELEVENLABS_GET_DEFAULT_VOICE_SETTINGS` 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. #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get dubbed audio for a language **Slug:** `ELEVENLABS_GET_DUBBED_FILE` Retrieves an existing dubbed audio file for a specific `dubbing_id` and `language_code`. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `dubbing_id` | string | Yes | The unique identifier for the dubbing project from which to retrieve the audio. | | `language_code` | string | Yes | The language code specifying the desired language of the dubbed audio file (e.g., 'en', 'es', 'de-DE'). | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get dubbing project metadata **Slug:** `ELEVENLABS_GET_DUBBING_PROJECT_METADATA` Retrieves metadata and status for a specific dubbing project by its ID. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `dubbing_id` | string | Yes | The unique identifier of the dubbing project whose metadata is to be retrieved. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get dubbing transcript in specific format **Slug:** `ELEVENLABS_GET_DUBBING_TRANSCRIPTS_FORMAT` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `dubbing_id` | string | Yes | ID of the dubbing project. | | `format_type` | string ("srt" | "webvtt" | "json") | Yes | Format to return transcript in. For subtitles use either 'srt' or 'webvtt', and for a full transcript use 'json'. The 'json' format is not yet supported for Dubbing Studio. | | `language_code` | string | Yes | ISO-693 language code to retrieve the transcript for. Use 'source' to fetch the transcript of the original media. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get generated items **Slug:** `ELEVENLABS_GET_GENERATED_ITEMS` Retrieves metadata for a list of generated audio items from history, supporting pagination and optional filtering by voice ID. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `voice_id` | string | No | Filters the history items to only include those generated with the specified voice ID. You can obtain voice IDs by listing available voices (e.g., using an action to get voices from `https://api.elevenlabs.io/v1/voices`). | | `page_size` | integer | No | Specifies the maximum number of history items to return per page. The value must be between 1 and 1000, inclusive. | | `start_after_history_item_id` | string | No | The ID of the history item to start fetching results after, for pagination. If not provided, items are fetched from the most recent, ordered by creation date in descending order. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get history item by id **Slug:** `ELEVENLABS_GET_HISTORY_ITEM_BY_ID` Retrieves detailed information (excluding the audio file) for a specific audio generation history item from ElevenLabs, using its unique ID. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `history_item_id` | string | Yes | Unique identifier of the history item to retrieve. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get MCP Tool Configuration **Slug:** `ELEVENLABS_GET_MCP_TOOL_CONFIG` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `tool_name` | string | Yes | Name of the MCP tool to retrieve config overrides for | | `mcp_server_id` | string | Yes | ID of the MCP Server | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get pronunciation dictionary metadata **Slug:** `ELEVENLABS_GET_METADATA_FOR_A_PRONUNCIATION_DICTIONARY` Retrieves metadata for a specific, existing pronunciation dictionary from ElevenLabs using its ID. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `pronunciation_dictionary_id` | string | Yes | The unique identifier of the pronunciation dictionary for which to retrieve metadata. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get models **Slug:** `ELEVENLABS_GET_MODELS` Retrieves a detailed list of all available ElevenLabs text-to-speech (TTS) models and their capabilities. #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get project by ID **Slug:** `ELEVENLABS_GET_PROJECT_BY_ID` Use to retrieve all details for a specific project, including its chapters and their conversion statuses, by providing the project's unique ID. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `project_id` | string | Yes | Unique identifier for the project. To list all available projects and their IDs, you can use the endpoint that lists all projects (e.g., GET /v1/projects). | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get projects **Slug:** `ELEVENLABS_GET_PROJECTS` Fetches a list of all projects and their details associated with the user's ElevenLabs account; this is a read-only operation. #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get project snapshots **Slug:** `ELEVENLABS_GET_PROJECT_SNAPSHOTS` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `project_id` | string | Yes | Identifier of the project for which to retrieve snapshots. You can obtain project_ids by querying the GET /v1/studio/projects endpoint to list all available projects. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get pronunciation dictionaries **Slug:** `ELEVENLABS_GET_PRONUNCIATION_DICTIONARIES` Retrieves a paginated list of pronunciation dictionaries, used to customize how specific words or phrases are pronounced by the text-to-speech (TTS) engine. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `cursor` | string | No | Cursor for pagination, obtained from a previous response, to fetch the next set of pronunciation dictionaries. Omit or leave empty to retrieve the first page. | | `page_size` | integer | No | The number of pronunciation dictionaries to retrieve per page, with a maximum value of 100. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get pronunciation dictionary version **Slug:** `ELEVENLABS_GET_PRONUNCIATION_DICT_VERSION` Downloads the Pronunciation Lexicon Specification (PLS) file for an existing version of a pronunciation dictionary from ElevenLabs, used to customize TTS pronunciation. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `version_id` | string | Yes | The unique identifier of the specific version of the pronunciation dictionary. | | `dictionary_id` | string | Yes | The unique identifier of the pronunciation dictionary. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Service Accounts **Slug:** `ELEVENLABS_GET_SERVICE_ACCOUNTS` 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. #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get shared voices **Slug:** `ELEVENLABS_GET_SHARED_VOICES` Retrieves a paginated and filterable list of shared voices from the ElevenLabs Voice Library. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `age` | string | No | Filters voices by age group. | | `page` | integer | No | Page number for pagination, starting from 0. | | `sort` | string ("created_date" | "usage_character_count_1y" | "trending" | "cloned_by_count") | No | Valid sort options for shared voices. | | `accent` | string | No | Filters voices by accent. | | `gender` | string | No | Filters voices by gender. | | `search` | string | No | A search term to filter voices by name or description. | | `category` | string | No | Filters voices by category. | | `featured` | boolean | No | Filters for voices that are marked as featured. | | `language` | string | No | Filters voices by language (ISO 639-1 code). | | `owner_id` | string | No | Filters voices by the public ID of their owner. | | `page_size` | integer | No | Maximum number of shared voices per page (max 100). | | `use_cases` | array | No | Filters voices by their intended use cases. | | `descriptives` | array | No | Filters voices by descriptive tags. | | `reader_app_enabled` | boolean | No | Filters for voices that are enabled for the reader application. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get sso provider admin **Slug:** `ELEVENLABS_GET_SSO_PROVIDER_ADMIN` Retrieves the SSO provider configuration for a specified workspace, typically for review purposes, and will indicate if no configuration exists. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `workspace_id` | string | Yes | The unique identifier of the workspace for which to retrieve the SSO provider configuration. | | `admin_url_prefix` | string | Yes | The admin URL prefix for the workspace. This is typically 'v1' for the standard API version. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Agent Response Test Summaries **Slug:** `ELEVENLABS_GET_SUMMARIES_CONVAI_AGENT_TESTING_SUMMARIES` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `test_ids` | array | Yes | List of test IDs to fetch. No duplicates allowed. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get dubbing transcript by language **Slug:** `ELEVENLABS_GET_TRANSCRIPT_FOR_DUB` Retrieves the textual transcript for a specified dubbing project and language, if one exists for that language in the project. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `dubbing_id` | string | Yes | The unique identifier for the dubbing project. | | `language_code` | string | Yes | The ISO 639-1 language code for which to retrieve the transcript. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Usage Character Stats **Slug:** `ELEVENLABS_GET_USAGE_CHARACTER_STATS` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `metric` | string ("credits" | "tts_characters" | "minutes_used" | "request_count" | "ttfb_avg" | "ttfb_p95" | "fiat_units_spent" | "concurrency" | "concurrency_average") | No | Which metric to aggregate. | | `end_unix` | integer | Yes | UTC Unix timestamp for the end of the usage window, in milliseconds. To include the last day of the window, the timestamp should be at 23:59:59 of that day. | | `start_unix` | integer | Yes | UTC Unix timestamp for the start of the usage window, in milliseconds. To include the first day of the window, the timestamp should be at 00:00:00 of that day. | | `breakdown_type` | string ("none" | "voice" | "voice_multiplier" | "user" | "groups" | "api_keys" | "all_api_keys" | "product_type" | "model" | "resource" | "request_queue" | "region" | "subresource_id" | "reporting_workspace_id" | "has_api_key" | "request_source") | No | Breakdown type for usage statistics. | | `aggregation_interval` | string ("hour" | "day" | "week" | "month" | "cumulative") | No | Aggregation interval for usage data over time. | | `aggregation_bucket_size` | string | No | Aggregation bucket size in seconds. Overrides the aggregation interval. | | `include_workspace_metrics` | boolean | No | Whether or not to include the statistics of the entire workspace. Default is false. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get user info **Slug:** `ELEVENLABS_GET_USER_INFO` Retrieves detailed information about the authenticated ElevenLabs user's account, including subscription, usage, API key, and status. #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get user subscription info **Slug:** `ELEVENLABS_GET_USER_SUBSCRIPTION_INFO` Retrieves detailed subscription information for the currently authenticated ElevenLabs user. #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get voice **Slug:** `ELEVENLABS_GET_VOICE` Retrieves comprehensive details for a specific, existing voice by its `voice_id`, optionally including its settings. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `voice_id` | string | Yes | Identifier of the voice. Use the `GET /v1/voices` endpoint to list available IDs. | | `with_settings` | boolean | No | If true, the response will include detailed settings information for the voice. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get voices list **Slug:** `ELEVENLABS_GET_VOICES` Retrieves a list of all available voices along with their detailed attributes and settings. #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get voice settings **Slug:** `ELEVENLABS_GET_VOICE_SETTINGS` Retrieves the stability, similarity, style, and speaker boost settings for a specific, existing ElevenLabs voice using its `voice_id`. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `voice_id` | string | Yes | Identifier of the voice for which to retrieve settings. A list of available voice IDs can be obtained from the /v1/voices endpoint. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get workspace resource metadata **Slug:** `ELEVENLABS_GET_WORKSPACE_RESOURCE` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `resource_id` | string | Yes | The ID of the target resource. | | `resource_type` | string ("voice" | "voice_collection" | "pronunciation_dictionary" | "dubbing" | "project" | "convai_agents" | "convai_knowledge_base_documents" | "convai_tools" | "convai_settings" | "convai_secrets" | "workspace_auth_connections" | "convai_phone_numbers" | "convai_mcp_servers" | "convai_api_integration_connections" | "convai_api_integration_trigger_connections" | "convai_batch_calls" | "convai_agent_response_tests" | "convai_test_suite_invocations" | "convai_crawl_jobs" | "convai_crawl_tasks" | "convai_whatsapp_accounts" | "convai_agent_versions" | "convai_agent_branches" | "convai_agent_versions_deployments" | "dashboard" | "dashboard_configuration" | "convai_agent_drafts" | "resource_locators" | "assets" | "content_generations" | "content_templates") | Yes | Resource type of the target resource. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Workspace Webhooks **Slug:** `ELEVENLABS_GET_WORKSPACE_WEBHOOKS` Tool to list all webhooks configured for the workspace. Use when you need to view existing webhook configurations or verify webhook settings. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `include_usages` | boolean | No | Whether to include active usages of the webhook, only usable by admins | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Conversational AI Agent Tests **Slug:** `ELEVENLABS_LIST_CONVAI_AGENT_TESTING` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `cursor` | string | No | Used for fetching next page. Cursor is returned in the response. | | `search` | string | No | Search query to filter tests by name. | | `page_size` | integer | No | How many tests to return at maximum. Cannot exceed 100, defaults to 30. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Dubs **Slug:** `ELEVENLABS_LIST_DUBS` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `cursor` | string | No | Cursor for pagination. Use the next_cursor value from a previous response to fetch the next page. | | `order_by` | string | No | The field to use for ordering results from this query. | | `page_size` | integer | No | Number of dubs to return per page. Cannot exceed 200, defaults to 100. | | `dubbing_status` | string ("dubbing" | "dubbed" | "failed") | No | Status of the dubbing project. | | `order_direction` | string ("DESCENDING" | "ASCENDING") | No | Order direction for results. | | `filter_by_creator` | string ("personal" | "others" | "all") | No | Filter for who created the dubbing projects. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Phone Numbers **Slug:** `ELEVENLABS_LIST_PHONE_NUMBERS` 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. #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List WhatsApp Accounts **Slug:** `ELEVENLABS_LIST_WHATSAPP_ACCOUNTS` 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. #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Move Bulk Knowledge Base Items **Slug:** `ELEVENLABS_MOVE_BULK_CONVAI_KNOWLEDGE_BASE` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `move_to` | string | No | The folder ID to move the entities to. If not set, the entities will be moved to the root folder. | | `document_ids` | array | Yes | The ids of documents or folders from the knowledge base to move. Must contain between 1 and 20 IDs. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Move ConvAI Knowledge Base Entity **Slug:** `ELEVENLABS_MOVE_CONVAI_KNOWLEDGE_BASE` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `move_to` | string | No | The folder to move the entities to. If not set, the entities will be moved to the root folder. | | `document_id` | string | Yes | The id of a document from the knowledge base. This is returned on document addition. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Outbound call **Slug:** `ELEVENLABS_OUTBOUND_CALL` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `agent_id` | string | Yes | Agent ID to place the call with (retrieve via Agents API). | | `to_number` | string | Yes | Destination phone number in E.164 format to call. | | `agent_phone_number_id` | string | Yes | ID of the phone number to originate the call from (must support outbound calls). | | `conversation_initiation_client_data` | object | No | Personalization and override payload for initiating a conversation. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get API documentation **Slug:** `ELEVENLABS_REDIRECT_TO_MINTLIFY` Retrieves the content of the official ElevenLabs API documentation page hosted on Mintlify. #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Register Twilio Call for ConvAI Agent **Slug:** `ELEVENLABS_REGISTER_CALL_CONVAI_TWILIO` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `agent_id` | string | Yes | The unique identifier of the Conversational AI agent to use for this call | | `direction` | string ("inbound" | "outbound") | No | Direction of the call: 'inbound' for incoming calls or 'outbound' for outgoing calls | | `to_number` | string | Yes | The phone number the call is directed to in E.164 format | | `from_number` | string | Yes | The phone number the call is originating from in E.164 format | | `conversation_initiation_client_data` | object | No | Optional client data for conversation initialization. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Remove rules from pronunciation dictionary **Slug:** `ELEVENLABS_REMOVE_RULES_FROM_THE_PRONUNCIATION_DICTIONARY` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `rule_strings` | array | Yes | A list of exact pronunciation rule strings to be removed from the dictionary (e.g., 'word -> wɜːd'). Non-matching strings will be ignored. | | `pronunciation_dictionary_id` | string | Yes | Identifier of the pronunciation dictionary from which rules will be removed. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Resubmit Test Invocations **Slug:** `ELEVENLABS_RESUBMIT_CONVAI_TEST_INVOCATIONS` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `agent_id` | string | Yes | Agent ID to resubmit tests for | | `branch_id` | string | No | ID of the branch to run the tests on. If not provided, the tests will be run on the agent default configuration. | | `test_run_ids` | array | Yes | List of test run IDs to resubmit | | `test_invocation_id` | string | Yes | The id of a test invocation. This is returned when tests are run. | | `agent_config_override` | object | No | Configuration overrides to use for testing. If not provided, the agent's default configuration will be used. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Retry Batch Call **Slug:** `ELEVENLABS_RETRY_CONVAI_BATCH_CALL` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `batch_id` | string | Yes | Unique identifier of the batch call to retry. Retries failed and no-response recipients. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Run Agent Tests **Slug:** `ELEVENLABS_RUN_AGENT_TESTS` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `tests` | array | Yes | List of tests to run on the agent. Must contain at least 1 test and at most 200 tests. | | `agent_id` | string | Yes | The unique identifier of the agent to run tests on. This is returned on agent creation. | | `branch_id` | string | No | ID of the branch to run the tests on. If not provided, the tests will be run on the agent default configuration. | | `agent_config_override` | object | No | Configuration overrides to use for testing. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Set Agent Avatar **Slug:** `ELEVENLABS_SET_AGENT_AVATAR` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `agent_id` | string | Yes | The unique identifier of the agent. This is returned on agent creation. | | `avatar_file` | object | Yes | Image file to be used as the agent's avatar. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Simulate Conversational AI Agent Conversation **Slug:** `ELEVENLABS_SIMULATE_CONVAI_AGENTS_SIMULATE_CONVERSATION` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `agent_id` | string | Yes | The id of an agent. This is returned on agent creation. | | `new_turns_limit` | integer | No | Maximum number of new turns to generate in the conversation simulation | | `simulation_specification` | object | Yes | A specification that will be used to simulate a conversation between an agent and an AI user | | `extra_evaluation_criteria` | array | No | A list of evaluation criteria to test | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Speech to speech **Slug:** `ELEVENLABS_SPEECH_TO_SPEECH` Converts an input audio file to speech using a specified voice; if a `model_id` is provided, it must support speech-to-speech conversion. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `seed` | integer | No | Seed for deterministic audio generation (integer 0-4294967295). Same seed and parameters yield same audio. | | `audio` | object | Yes | The audio file to be converted. | | `model_id` | string | No | Identifier of the model. Must support speech-to-speech (where `can_do_voice_conversion` is true). Use /v1/models to list models. | | `voice_id` | string | Yes | Identifier of the voice to be used. Available voices can be retrieved using the /v1/voices endpoint. | | `output_format` | string | No | Output audio format. Supported options: mp3_22050_32 (MP3 22.05kHz, 32kbps), mp3_44100_32 (MP3 44.1kHz, 32kbps), mp3_44100_64 (MP3 44.1kHz, 64kbps), mp3_44100_96 (MP3 44.1kHz, 96kbps), mp3_44100_128 (MP3 44.1kHz, 128kbps), mp3_44100_192 (MP3 44.1kHz, 192kbps; Requires Creator tier or above), pcm_16000 (PCM S16LE 16kHz), pcm_22050 (PCM S16LE 22.05kHz), pcm_24000 (PCM S16LE 24kHz), pcm_44100 (PCM S16LE 44.1kHz; Requires Pro tier or above), ulaw_8000 (μ-law 8kHz; for Twilio audio inputs). | | `voice_settings` | string | No | JSON string defining voice settings, such as `stability` (float) and `similarity_boost` (float). | | `optimize_streaming_latency` | integer | No | Latency optimization. Higher values reduce latency but may lower quality. Options: 0 (no optimizations), 1 (normal), 2 (strong), 3 (max), 4 (max, text normalizer disabled; best latency, can mispronounce numbers/dates). | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Speech to speech streaming **Slug:** `ELEVENLABS_SPEECH_TO_SPEECH_STREAMING` Converts an input audio stream to a different voice output stream in real-time, using a specified speech-to-speech model. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `seed` | integer | No | An integer seed for deterministic audio generation (0-4294967295). Using the same seed with identical input parameters aims to produce the same audio output, aiding reproducibility. | | `audio` | object | Yes | The input audio file (e.g..wav.mp3) to be converted. | | `model_id` | string | No | Identifier of the speech-to-speech model (e.g., 'eleven_english_sts_v2'). Ensure the chosen model supports voice conversion. Available models can be fetched from the `/v1/models` endpoint. | | `voice_id` | string | Yes | Identifier for the voice to be used. A list of available voices can be fetched from the `https://api.elevenlabs.io/v1/voices` endpoint. | | `output_format` | string | No | Desired output audio stream format. Supported formats include: 'mp3_22050_32': MP3 22.05kHz 32kbps. 'mp3_44100_32': MP3 44.1kHz 32kbps. 'mp3_44100_64': MP3 44.1kHz 64kbps. 'mp3_44100_96': MP3 44.1kHz 96kbps. 'mp3_44100_128': MP3 44.1kHz 128kbps. 'mp3_44100_192': MP3 44.1kHz 192kbps (requires Creator tier or above). 'pcm_16000': PCM (S16LE) 16kHz. 'pcm_22050': PCM (S16LE) 22.05kHz. 'pcm_24000': PCM (S16LE) 24kHz. 'pcm_44100': PCM (S16LE) 44.1kHz (requires Pro tier or above). 'ulaw_8000': μ-law 8kHz (commonly used for Twilio audio inputs). | | `voice_settings` | string | No | A JSON string containing voice settings, such as stability and similarity_boost, to fine-tune the characteristics of the generated voice. Example: '{"stability": 0.5, "similarity_boost": 0.75}'. If not provided, the default voice settings for the selected voice will be used. | | `optimize_streaming_latency` | integer | No | Controls latency optimizations for streaming audio. Higher values offer lower latency at a potential cost to audio quality. Supported values: 0: Default mode (no latency optimizations). 1: Normal latency optimizations (provides about 50% of the latency improvement of option 3). 2: Strong latency optimizations (provides about 75% of the latency improvement of option 3). 3: Maximum latency optimizations. 4: Maximum latency optimizations, with text normalizer turned off (can mispronounce numbers and dates but offers the best latency). | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Stream audio isolation **Slug:** `ELEVENLABS_STREAM_AUDIO_ISOLATION` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `audio` | object | No | The audio file from which vocals/speech will be isolated. Audio must be at least 4.6 seconds long. Alternatively, use 'local_file_path'. | | `file_format` | string ("pcm_s16le_16" | "other") | No | The format of input audio. Use 'pcm_s16le_16' for 16-bit PCM at a 16kHz sample rate, single channel (mono), and little-endian byte order (lower latency). Use 'other' for all other encoded waveform formats. | | `local_file_path` | string | No | Absolute path to a local audio file to process. If provided, the action will read raw bytes from this path instead of the file reference. Useful for testing or when the file is available locally. Audio must be at least 4.6 seconds long. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Stream chapter audio **Slug:** `ELEVENLABS_STREAM_CHAPTER_AUDIO` Streams the audio for a specified chapter snapshot from an ElevenLabs project, optionally converting the output to MPEG format. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `chapter_id` | string | Yes | Identifier of the chapter. To list available chapters for a specific project, use the GET /v1/studio/projects/{project_id}/chapters endpoint. | | `project_id` | string | Yes | Identifier of the project. To find available project IDs, you can list all projects using the GET /v1/studio/projects endpoint. | | `convert_to_mpeg` | boolean | No | If true, the output audio stream will be converted to MPEG format. If false, the audio will be streamed in its original format (likely PCM). | | `chapter_snapshot_id` | string | Yes | Identifier of the chapter snapshot (a specific version of the chapter). To list all available snapshots for a chapter, use the GET /v1/studio/projects/{project_id}/chapters/{chapter_id}/snapshots endpoint. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Stream ConvAI agent simulate conversation **Slug:** `ELEVENLABS_STREAM_CONVAI_AGENTS_SIMULATE_CONVERSATION` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `agent_id` | string | Yes | The ID of the conversational AI agent. This is returned on agent creation. | | `new_turns_limit` | integer | No | Maximum number of new turns to generate in the conversation simulation. | | `simulation_specification` | object | Yes | Specification that defines how to simulate the conversation between the agent and a simulated user. | | `extra_evaluation_criteria` | array | No | A list of additional evaluation criteria to test during the simulation. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Stream project audio **Slug:** `ELEVENLABS_STREAM_PROJECT_AUDIO` Streams audio from a specific project snapshot, optionally converting it to MPEG format. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `project_id` | string | Yes | Identifier of the project. | | `convert_to_mpeg` | boolean | No | If true, converts the output audio to MPEG format; otherwise, streams in its original or a default raw format. | | `project_snapshot_id` | string | Yes | Identifier of the project snapshot. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Archive project snapshot **Slug:** `ELEVENLABS_STREAMS_ARCHIVE_WITH_PROJECT_AUDIO` Archives an existing project snapshot by its ID, creating a permanent, immutable, and typically irreversible copy of its state. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `project_id` | string | Yes | The ID of the project whose snapshot is to be archived. | | `project_snapshot_id` | string | Yes | The ID of the project snapshot to archive. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Submit Batch Call **Slug:** `ELEVENLABS_SUBMIT_BATCH_CALL` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `agent_id` | string | Yes | ID of the agent to use for the calls | | `call_name` | string | Yes | Name of the batch call | | `recipients` | array | Yes | List of recipient objects for batch calling | | `scheduled_time_unix` | integer | No | Unix timestamp to schedule the batch (omit or null to send immediately) | | `agent_phone_number_id` | string | No | ID of the phone number to originate calls from | | `agent_whatsapp_business_account_id` | string | No | ID of the WhatsApp Business Account to use | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Text to speech **Slug:** `ELEVENLABS_TEXT_TO_SPEECH` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `seed` | integer | No | Integer seed for potentially deterministic audio generation. Repeatability with the same seed and parameters is aimed for but not guaranteed. | | `text` | string | Yes | Input text for speech conversion. Max 10,000 characters for most models. Flash/Turbo v2 models: up to 30,000. Flash/Turbo v2.5 models: up to 40,000. For long-form content, use Studio. | | `model_id` | string | No | Identifier of the model for synthesis. List available models via `/v1/models`; ensure chosen model's `can_do_text_to_speech` is true. | | `voice_id` | string | Yes | Identifier of the voice for speech generation. Obtainable from the `/v1/voices` endpoint. | | `output_format` | string | No | Output audio format. Supported formats include: - `mp3_22050_32`: 22.05kHz, 32kbps MP3. - `mp3_44100_32`: 44.1kHz, 32kbps MP3. - `mp3_44100_64`: 44.1kHz, 64kbps MP3. - `mp3_44100_96`: 44.1kHz, 96kbps MP3. - `mp3_44100_128`: 44.1kHz, 128kbps MP3. - `mp3_44100_192`: 44.1kHz, 192kbps MP3 (Creator tier+). - `pcm_16000`: 16kHz PCM (S16LE). - `pcm_22050`: 22.05kHz PCM (S16LE). - `pcm_24000`: 24kHz PCM (S16LE). - `pcm_44100`: 44.1kHz PCM (S16LE) (Pro tier+). - `ulaw_8000`: 8kHz μ-law (for Twilio audio inputs). | | `voice_settings` | object | No | Voice settings for controlling speech generation characteristics. | | `optimize_streaming_latency` | integer | No | Controls latency optimizations for streaming. Higher values reduce latency, potentially affecting quality. 0: No optimizations. 1: Normal (approx. 50% of max improvement vs option 3). 2: Strong (approx. 75% of max improvement vs option 3). 3: Maximum. 4: Maximum with text normalizer disabled (affects number/date pronunciation, best latency). NOTE: Not supported with model 'eleven_v3'. If using eleven_v3, leave this parameter unset. | | `pronunciation_dictionary_locators` | array | No | List of up to 3 pronunciation dictionary locators, applied sequentially. Each dictionary must contain `pronunciation_dictionary_id` and `version_id`. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Text to speech stream **Slug:** `ELEVENLABS_TEXT_TO_SPEECH_STREAM` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `seed` | integer | No | If specified, the system will attempt to sample deterministically, meaning that repeated requests with the same seed and parameters should ideally return the same audio result. However, complete determinism is not guaranteed. | | `text` | string | Yes | The text that will be converted into speech. It is recommended to keep the text length under 5000 characters, as longer texts might face limitations. | | `model_id` | string | No | Identifier of the model to be used for text-to-speech conversion. Available models can be listed using the `GET /v1/models` endpoint. Ensure the chosen model supports text-to-speech by verifying its `can_do_text_to_speech` property. Voice and account compatibility with specific models (e.g., eleven_turbo_v2, eleven_multilingual_v2) may vary; validate by testing a short clip (~200 characters) before full runs. | | `voice_id` | string | Yes | Identifier of the voice to be used for speech generation. A list of available voice IDs can be retrieved from the `GET /v1/voices` endpoint. | | `output_format` | string | No | Specifies the desired output format for the generated audio stream. Supported MP3 formats: - mp3_22050_32: MP3, 22.05kHz, 32kbps. - mp3_44100_32: MP3, 44.1kHz, 32kbps. - mp3_44100_64: MP3, 44.1kHz, 64kbps. - mp3_44100_96: MP3, 44.1kHz, 96kbps. - mp3_44100_128: MP3, 44.1kHz, 128kbps. - mp3_44100_192: MP3, 44.1kHz, 192kbps (Creator tier or above required). Supported PCM formats (S16LE): - pcm_16000: PCM, 16kHz. - pcm_22050: PCM, 22.05kHz. - pcm_24000: PCM, 24kHz. - pcm_44100: PCM, 44.1kHz (Pro tier or above required). Supported μ-law format: - ulaw_8000: μ-law, 8kHz (commonly used for Twilio audio inputs). | | `optimize_streaming_latency` | integer | No | Controls latency optimization for the streaming audio. Higher values prioritize lower latency, potentially at the cost of audio quality. Possible values: - 0: Default mode (no latency optimizations). - 1: Normal latency optimizations (reduces latency by approximately 50% of option 3's improvement). - 2: Strong latency optimizations (reduces latency by approximately 75% of option 3's improvement). - 3: Maximum latency optimizations. - 4: Maximum latency optimizations with text normalizer disabled (offers the lowest latency but may lead to mispronunciations of numbers, dates, etc.). | | `pronunciation_dictionary_locators` | array | No | A list of pronunciation dictionary locators to be applied to the text. Each locator should be a dictionary containing 'pronunciation_dictionary_id' (string) and 'version_id' (string). Dictionaries are applied in the provided order. A maximum of 3 locators can be used per request. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update Audio Native project content **Slug:** `ELEVENLABS_UPDATE_AUDIO_NATIVE_CONTENT` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `file` | object | Yes | Text or HTML file containing the article content. For HTML, format as '

Your content

More content
'. | | `project_id` | string | Yes | The ID of the Audio Native project to update. | | `auto_convert` | boolean | No | Whether to automatically convert the project to audio after updating content. | | `auto_publish` | boolean | No | Whether to automatically publish the new project snapshot after conversion completes. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update Conversational AI Agent **Slug:** `ELEVENLABS_UPDATE_CONVAI_AGENT` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `name` | string | No | A name to make the agent easier to find | | `tags` | array | No | Tags to help classify and filter the agent | | `agent_id` | string | Yes | The id of an agent. This is returned on agent creation. | | `workflow` | object | No | Workflow configuration defining conditional logic, tool execution modes, and conversation flow patterns for the agent | | `branch_id` | string | No | The ID of the branch to use | | `procedure_refs` | array | No | List of procedure refs used for this agent version. | | `platform_settings` | object | No | Platform settings for the agent are all settings that aren't related to the conversation orchestration and content. | | `conversation_config` | object | No | Conversation configuration for an agent | | `version_description` | string | No | Description for this version when publishing changes (only applicable for versioned agents) | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update Agent Response Test **Slug:** `ELEVENLABS_UPDATE_CONVAI_AGENT_TESTING` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `name` | string | Yes | Name for the test case to identify it later | | `type` | string ("llm" | "tool_call" | "simulation") | No | Type of agent test. | | `test_id` | string | Yes | The id of a chat response test. This is returned on test creation. | | `chat_history` | array | No | Array of messages representing the conversation history to test against. Each message must include role ('user' or 'agent'), time_in_call_secs (float), and optional message text content. | | `failure_examples` | array | No | Examples of failed or incorrect agent responses for LLM tests | | `success_examples` | array | No | Examples of successful agent responses for LLM tests | | `dynamic_variables` | object | No | Key-value pairs of variables to be dynamically injected into the test context | | `success_condition` | string | No | For 'llm' and 'simulation' types: Natural language description of what constitutes a successful agent response | | `simulation_scenario` | string | No | For 'simulation' type: Natural language description of the scenario to simulate in the conversation | | `simulation_max_turns` | integer | No | For 'simulation' type tests: Maximum number of conversation turns to simulate | | `tool_call_parameters` | string | No | For 'tool_call' type tests: Expected parameters for the tool that should be called by the agent | | `check_any_tool_matches` | string | No | For 'tool_call' type tests: Whether to check if any tool matches the expected call pattern | | `from_conversation_metadata` | string | No | Metadata from a previous conversation to use as context for this test | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update Knowledge Base Document **Slug:** `ELEVENLABS_UPDATE_CONVAI_KNOWLEDGE_BASE` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `name` | string | Yes | A custom, human-readable name for the document. | | `documentation_id` | string | Yes | The id of a document from the knowledge base. This is returned on document addition. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update ConvAI Workspace Secret **Slug:** `ELEVENLABS_UPDATE_CONVAI_SECRET` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `name` | string | Yes | Updated name identifier for the secret. Must be unique within the workspace. | | `type` | string ("update") | Yes | Type of operation. Must be the literal value 'update' for updating secrets. | | `value` | string | Yes | The updated secret value to store securely in the workspace. | | `secret_id` | string | Yes | The unique identifier of the workspace secret to update. This ID is returned when creating or listing secrets. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update Convai Settings **Slug:** `ELEVENLABS_UPDATE_CONVAI_SETTINGS` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `webhooks` | object | No | Webhook configuration for ConvAI conversations. | | `can_use_mcp_servers` | boolean | No | Whether the workspace can use MCP servers | | `default_livekit_stack` | string ("standard" | "static") | No | Valid Livekit stack types for the default_livekit_stack setting. | | `rag_retention_period_days` | integer | No | Number of days to retain RAG data. Maximum: 30 days | | `conversation_initiation_client_data_webhook` | object | No | Webhook configuration for conversation initiation client data. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update Convai Dashboard Settings **Slug:** `ELEVENLABS_UPDATE_CONVAI_SETTINGS_DASHBOARD` Tool to update Convai dashboard settings for the workspace. Use when you need to configure dashboard charts for monitoring conversational AI performance. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `charts` | array | No | List of dashboard charts (max 4), each representing call success metrics, criteria evaluations, or data collection insights | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update Conversational AI Tool **Slug:** `ELEVENLABS_UPDATE_CONVAI_TOOL` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `tool_id` | string | Yes | ID of the tool to update. | | `tool_config` | object | Yes | Complete tool configuration object to update. Must include 'type' field (webhook/client/system/mcp) and all type-specific required fields. For webhook: requires name, description, api_schema. For client: requires name, description. For system: requires name, params. For mcp: requires name, description, integration_type, mcp_tool_name, mcp_tool_description, mcp_server_id, mcp_server_name. Optional fields include: assignments, disable_interruptions, dynamic_variables, execution_mode, force_pre_tool_speech, response_timeout_secs, tool_call_sound, tool_call_sound_behavior, tool_error_handling_mode. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update project pronunciation dictionaries **Slug:** `ELEVENLABS_UPDATE_PRONUNCIATION_DICTIONARIES` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `project_id` | string | Yes | The ID of the project to which the pronunciation dictionaries will be applied. | | `pronunciation_dictionary_locators` | array | Yes | List of locators, each provided as a JSON string detailing `pronunciation_dictionary_id` and `version_id`, due to form-data requirements. The ElevenLabs UI currently displays only the first applied dictionary. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update pronunciation dictionary **Slug:** `ELEVENLABS_UPDATE_PRONUNCIATION_DICTIONARY` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `name` | string | No | The name of the pronunciation dictionary, used for identification only. | | `archived` | boolean | No | Whether to archive the pronunciation dictionary. | | `pronunciation_dictionary_id` | string | Yes | The unique identifier of the pronunciation dictionary to update. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update Workspace Webhook **Slug:** `ELEVENLABS_UPDATE_WORKSPACE_WEBHOOK` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `name` | string | Yes | The display name of the webhook (used for display purposes only). | | `webhook_id` | string | Yes | The unique ID for the webhook | | `is_disabled` | boolean | Yes | Whether to disable or enable the webhook | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Voice generation parameters retrieval **Slug:** `ELEVENLABS_VOICE_GENERATION_PARAMETERS` 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. #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not |