# Elevenreader ElevenReader is an AI-powered text-to-speech application by ElevenLabs that converts written content into natural-sounding audio - **Category:** artificial intelligence - **Auth:** API_KEY - **Composio Managed App Available?** N/A - **Tools:** 124 - **Triggers:** 0 - **Slug:** `ELEVENREADER` - **Version:** 20260312_00 ## Tools ### Add Documentation To Knowledge Base **Slug:** `ELEVENREADER_ADD_DOCUMENTATION_TO_KNOWLEDGE_BASE` Tool to add documentation to a conversational AI agent's knowledge base. Accepts either a file upload or a URL to documentation. Use when configuring an agent to have access to specific documentation for user interactions. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `url` | string | No | URL to a page of documentation that the agent will have access to. Either file or url must be provided, but not both. | | `file` | object | No | Documentation file to upload. Either file or url must be provided, but not both. | | `name` | string | No | A custom, human-readable name for the document. | | `agent_id` | string | No | The ID of the agent to add the documentation to. | #### 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 File **Slug:** `ELEVENREADER_ADD_PRONUNCIATION_DICTIONARY_FROM_FILE` Tool to add a pronunciation dictionary from a .pls file to ElevenLabs. Use when you need to create custom pronunciation rules for text-to-speech. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `file` | object | No | A lexicon.pls file which will be used to initialize the pronunciation dictionary. | | `name` | string | Yes | The name of the pronunciation dictionary, used for identification only. | | `description` | string | No | A description of the pronunciation dictionary, used for identification only. | | `workspace_access` | string ("admin" | "editor" | "viewer") | No | Workspace access level for 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 | ### Add Pronunciation Dictionary From Rules **Slug:** `ELEVENREADER_ADD_PRONUNCIATION_DICTIONARY_FROM_RULES` Tool to add a pronunciation dictionary from rules in ElevenLabs. Use when you need to define custom pronunciations for text-to-speech using alias rules (text replacements) or phoneme rules (phonetic pronunciations). #### 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. Each rule can be either an alias rule (string replacement) or a phoneme rule (phonetic pronunciation). | | `description` | string | No | A description of the pronunciation dictionary, used for identification only. | | `workspace_access` | string ("admin" | "editor" | "viewer") | No | Workspace access level for 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 | ### Add Pronunciation Dictionary Rules **Slug:** `ELEVENREADER_ADD_PRONUNCIATION_DICTIONARY_RULES` Tool to add pronunciation rules to an ElevenLabs pronunciation dictionary. Use when you need to customize how specific words or phrases are pronounced in text-to-speech, either by providing an alias (alternative text) or phoneme representation. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `rules` | array | Yes | List of pronunciation rules to add. Each rule can be either an alias rule (replaces text with spoken alternative) or a phoneme rule (defines phonetic pronunciation). | | `pronunciation_dictionary_id` | string | Yes | The ID of the pronunciation dictionary to add rules to. | #### 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 Shared Voice **Slug:** `ELEVENREADER_ADD_SHARED_VOICE` Tool to add a shared voice from another user's public library to your own voice library. Use when you want to clone or use a voice that has been shared publicly by another ElevenLabs user. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `new_name` | string | Yes | The name that identifies this voice. This will be displayed in the dropdown of the website. | | `voice_id` | string | Yes | Voice ID to be used, you can use https://api.elevenlabs.io/v1/voices to list all the available voices. | | `public_user_id` | string | Yes | Public user ID used to publicly identify ElevenLabs users. | #### 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 Tool **Slug:** `ELEVENREADER_ADD_TOOL` Tool to add a conversational AI tool to ElevenLabs ConvAI. Use when you need to create a new tool for agents to use during conversations. Supports webhook, client-side, system, and MCP tools. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `tool_config` | string | Yes | Configuration for the tool. Can be one of: webhook, client, system, or mcp tool configuration. | #### 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 Public LLM Expected Cost **Slug:** `ELEVENREADER_CALCULATE_PUBLIC_LLM_EXPECTED_COST` Tool to calculate expected LLM usage costs based on prompt length, knowledge base size, and RAG configuration. Use when estimating operational costs for conversational AI without requiring a specific agent. #### 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:** `ELEVENREADER_CANCEL_BATCH_CALL` Tool to cancel an active batch call operation. Use when you need to stop a scheduled or in-progress batch calling campaign. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `batch_id` | string | Yes | The 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 | ### Compute RAG Index **Slug:** `ELEVENREADER_COMPUTE_RAG_INDEX` Tool to compute RAG index for a knowledge base document. Use when you need to generate embeddings for a specific document to enable semantic search and retrieval. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `model` | string ("e5_mistral_7b_instruct" | "multilingual_e5_large_instruct") | Yes | Embedding model to use for RAG index computation. | | `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 | ### Create Agent **Slug:** `ELEVENREADER_CREATE_AGENT` Tool to create a conversational AI agent with ElevenLabs. Use when you need to set up a new agent with specific voice, language, and conversation 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. | | `conversation_config` | object | Yes | Configuration for the conversational agent including TTS, ASR, and agent behavior 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 | ### Create Agent Response Test **Slug:** `ELEVENREADER_CREATE_AGENT_RESPONSE_TEST` Tool to create an agent response test for testing conversational AI agents. Use when you need to create response tests, tool call tests, or simulation tests for agent validation. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `name` | string | Yes | Name of the test | | `type` | string ("llm" | "tool" | "simulation") | Yes | Type of test to create: 'llm' for response tests, 'tool' for tool call tests, 'simulation' for simulation tests | | `chat_history` | array | No | List of chat messages representing the conversation history | | `failure_examples` | array | No | Examples of failed responses. Used for 'llm' test type | | `success_examples` | array | No | Examples of successful responses. Used for 'llm' test type | | `dynamic_variables` | object | No | Dynamic variables to use in the test | | `success_condition` | string | No | Condition that defines a successful test. Used for 'llm' and 'simulation' test types | | `simulation_scenario` | string | No | Scenario to simulate in the test. Used for 'simulation' test type | | `simulation_max_turns` | integer | No | Maximum number of turns in the simulation. Used for 'simulation' test type | | `tool_call_parameters` | string | No | Parameters for the tool call. Used for 'tool_call' test type | | `check_any_tool_matches` | string | No | Flag to check if any tool matches. Used for 'tool_call' test type | | `from_conversation_metadata` | string | No | Metadata from the 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 | ### Create Audio Native Project **Slug:** `ELEVENREADER_CREATE_AUDIO_NATIVE_PROJECT` Tool to create an Audio Native enabled project on ElevenLabs. Use when you need to convert text or HTML content into an embeddable audio player with customizable appearance and voice settings. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `file` | object | No | File to upload containing the article content (TXT or HTML). HTML should be formatted as '

Your content

More content

'. | | `name` | string | Yes | Project name for the Audio Native project. | | `image` | string | No | (Deprecated) Image URL used in the player. If not provided, default image set in the Player settings is used. | | `small` | boolean | No | (Deprecated) Whether to use small player or not. If not provided, default value set in the Player settings is used. | | `title` | string | No | Title used in the player and inserted at the top of the uploaded article. If not provided, the default title set in the Player settings is used. | | `author` | string | No | Author used in the player and inserted at the start of the uploaded article. If not provided, the default author set in the Player settings is used. | | `model_id` | string | No | TTS Model ID used in the player. If not provided, default model ID set in the Player settings is used. | | `voice_id` | string | No | Voice ID used to voice the content. If not provided, default voice ID set in the Player settings is used. | | `text_color` | string | No | Text color used in the player as hex code (e.g., '#FFFFFF' for white). If not provided, default text color set in the Player settings is used. | | `auto_convert` | boolean | No | Whether to automatically convert the project to audio after creation. | | `sessionization` | integer | No | (Deprecated) Specifies for how many minutes to persist the session across page reloads. If not provided, default sessionization set in the Player settings is used. | | `background_color` | string | No | Background color used in the player as hex code (e.g., '#000000' for black). If not provided, default background color set in the Player settings is used. | | `apply_text_normalization` | string ("auto" | "on" | "off" | "apply_english") | No | Text normalization modes for audio conversion. | | `pronunciation_dictionary_locators` | array | No | List of pronunciation dictionary locators (pronunciation_dictionary_id, version_id) encoded as JSON strings for pronunciation dictionaries to be applied to the text. | #### 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 Batch Call **Slug:** `ELEVENREADER_CREATE_BATCH_CALL` Tool to submit a batch call request to ElevenLabs ConvAI. Use when you need to initiate automated calls to multiple recipients with a conversational AI agent. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `agent_id` | string | Yes | ID of the conversational AI agent to use for the calls. | | `timezone` | string | No | Timezone for the scheduled time (e.g., 'America/New_York', 'UTC'). | | `call_name` | string | Yes | Name for the batch call campaign. | | `recipients` | array | Yes | List of recipients for the batch call. Maximum 10,000 recipients. | | `whatsapp_params` | object | No | WhatsApp-specific parameters for batch calls. | | `scheduled_time_unix` | integer | No | Unix timestamp for when to schedule the batch call. If not provided, calls start immediately. | | `agent_phone_number_id` | string | No | ID of the phone number to use for making the calls. | #### 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 File Document **Slug:** `ELEVENREADER_CREATE_FILE_DOCUMENT` Tool to create a file document in the ElevenLabs knowledge base. Use when you need to upload documentation that the agent will access for user interactions. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `file` | object | Yes | Documentation file that the agent will have access to in order to interact 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. | #### 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 Folder **Slug:** `ELEVENREADER_CREATE_FOLDER` Tool to create a folder in the ElevenLabs knowledge base. Use when you need to organize documents into folders for better structure and management. #### 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 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:** `ELEVENREADER_CREATE_SECRET` Tool to create a Convai workspace secret in ElevenLabs. Use when you need to securely store API keys, tokens, or other sensitive values for agent workflows. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `name` | string | Yes | Name of the secret for identification purposes. | | `type` | string ("new") | Yes | Type of secret. Must be 'new' for creating a new secret. | | `value` | string | Yes | The secret value to store securely. | #### 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 Text Document **Slug:** `ELEVENREADER_CREATE_TEXT_DOCUMENT` Tool to create a text document in the ElevenLabs knowledge base. Use when you need to add text content that the agent will access for user interactions. #### 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 URL Document **Slug:** `ELEVENREADER_CREATE_URL_DOCUMENT` Tool to create a URL document in the ElevenLabs knowledge base. Use when you need to add web-based documentation that the agent will access for user interactions. #### 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 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 | ### Delete Agent **Slug:** `ELEVENREADER_DELETE_AGENT` Tool to permanently delete an agent from ElevenLabs. Use when you need to remove an agent that is no longer needed. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `agent_id` | string | Yes | The id of an agent. This is returned on agent creation. WARNING: This permanently deletes the agent and cannot be undone. | #### 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:** `ELEVENREADER_DELETE_BATCH_CALL` Tool to delete a specific batch call. Use when you need to permanently remove a batch call by its ID. The batch call ID must be valid and the batch call must exist, otherwise a 404 error will be raised. Example: "Delete batch call with ID btcal_8801kfh8w831e4ft55k8k6jvzck4" #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `batch_id` | string | Yes | The unique identifier of the batch call 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 Agent Response Test **Slug:** `ELEVENREADER_DELETE_CHAT_RESPONSE_TEST` Tool to delete an agent response test. Use when you need to remove a test that is no longer needed. #### 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 Conversation **Slug:** `ELEVENREADER_DELETE_CONVERSATION` Tool to delete a conversation by its unique ID. Use when you need to permanently remove a conversation from the system. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `conversation_id` | string | Yes | The id of the conversation you're taking the action on. | #### 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 Dubbing **Slug:** `ELEVENREADER_DELETE_DUBBING` Tool to permanently delete a dubbing project by its ID. Use when you need to remove a dubbing project that is no longer needed. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `dubbing_id` | string | Yes | ID of the dubbing project to delete. This permanently removes the dubbing project and cannot be undone. | #### 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 **Slug:** `ELEVENREADER_DELETE_KNOWLEDGE_BASE_DOCUMENT` Tool to permanently delete a document from the knowledge base. Use when you need to remove documentation that is no longer needed. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `force` | boolean | No | If set to true, the document will be deleted regardless of whether it is used by any agents and it will be deleted from the dependent agents. | | `documentation_id` | string | Yes | The id of a document from the knowledge base. This is returned on document addition. WARNING: This permanently deletes the document and cannot be undone. | #### 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 **Slug:** `ELEVENREADER_DELETE_PHONE_NUMBER` Tool to permanently delete a phone number from ElevenLabs ConvAI. Use when you need to remove a phone number that is no longer needed. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `phone_number_id` | string | Yes | The id of a phone number. This is returned when listing phone numbers. WARNING: This permanently deletes the phone number and cannot be undone. | #### 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 RAG Index **Slug:** `ELEVENREADER_DELETE_RAG_INDEX` Tool to permanently delete a RAG index from a knowledge base document. Use when you need to remove an embedding index that is no longer needed. #### 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 Convai Workspace Secret **Slug:** `ELEVENREADER_DELETE_SECRET_ROUTE` Tool to delete a specific Convai workspace secret. Use when you need to permanently remove a secret by its ID. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `secret_id` | string | Yes | The unique identifier of the secret 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 Speech History Item **Slug:** `ELEVENREADER_DELETE_SPEECH_HISTORY_ITEM` Tool to permanently delete a speech history item by its ID. Use when you need to remove a specific history item from ElevenLabs. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `history_item_id` | string | Yes | History item ID to be used. You can use GET https://api.elevenlabs.io/v1/history to receive a list of history items and their IDs. This permanently deletes the history item. | #### 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 Tool **Slug:** `ELEVENREADER_DELETE_TOOL_ROUTE` Tool to permanently delete a conversational AI tool from ElevenLabs. Use when you need to remove a tool that is no longer needed. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `tool_id` | string | Yes | ID of the requested tool 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 Transcript By Id **Slug:** `ELEVENREADER_DELETE_TRANSCRIPT_BY_ID` Tool to permanently delete a speech-to-text transcript by its ID. Use when you need to remove a transcript that is no longer needed. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `transcription_id` | string | Yes | The unique ID of the transcript to delete. This permanently removes the transcript and cannot be undone. | #### 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 Speech History Items **Slug:** `ELEVENREADER_DOWNLOAD_SPEECH_HISTORY_ITEMS` Tool to download speech history items from ElevenLabs. Use when you need to retrieve previously generated audio files. Returns a single audio file or a zip containing multiple files. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `output_format` | string | No | Output format to transcode the audio file. Must be 'wav' or None. If not specified or None, uses the original format. | | `history_item_ids` | array | Yes | A list of history item IDs to download. You can get IDs of history items and other metadata using the List Speech 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 | ### Duplicate Agent **Slug:** `ELEVENREADER_DUPLICATE_AGENT` Tool to duplicate an existing agent. Use when you need to create a copy of an agent with all its configuration. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `name` | string | No | A name to make the agent easier to find. If not provided, the duplicated agent will have a default name. | | `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:** `ELEVENREADER_EDIT_VOICE` Tool to edit an existing voice in ElevenLabs. Use when you need to update a voice's name, description, labels, or add audio files to it. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `name` | string | Yes | The name that identifies this voice. This will be displayed in the dropdown of the website. | | `files` | array | No | Audio files to add to the voice. List of. | | `labels` | string | No | Labels for the voice. Can be a dictionary with keys like language, accent, gender, or age, or a JSON string. | | `voice_id` | string | Yes | Voice ID to be used, you can use https://api.elevenlabs.io/v1/voices to list all the available voices. | | `description` | string | No | A description of the voice. | | `remove_background_noise` | boolean | No | If set will remove background noise for voice samples using our audio isolation model. If the samples do not include background noise, it can make the quality worse. | #### 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:** `ELEVENREADER_EDIT_VOICE_SETTINGS` Tool to edit voice settings for a specific voice in ElevenLabs. Use when you need to adjust voice parameters like stability, similarity boost, speed, style, or speaker boost. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `speed` | number | No | Adjusts the speed of the voice. A value of 1.0 is the default speed, while values less than 1.0 slow down the speech, and values greater than 1.0 speed it up. | | `style` | number | No | Determines the style exaggeration of the voice. This setting attempts to amplify the style of the original speaker. It does consume additional computational resources and might increase latency if set to anything other than 0. | | `voice_id` | string | Yes | Voice ID to be used, you can use https://api.elevenlabs.io/v1/voices to list all the available voices. | | `stability` | number | No | Determines how stable the voice is and the randomness between each generation. Lower values introduce broader emotional range for the voice. Higher values can result in a monotonous voice with limited emotion. | | `similarity_boost` | number | No | Determines how closely the AI should adhere to the original voice when attempting to replicate it. | | `use_speaker_boost` | boolean | No | This setting boosts the similarity to the original speaker. Using this setting requires a slightly higher computational load, which in turn increases 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 | ### Generate Composition Plan **Slug:** `ELEVENREADER_GENERATE_COMPOSITION_PLAN` Tool to generate a music composition plan using ElevenLabs Music API. Use when you need to create a structured musical composition from a text prompt, including style directions and song sections. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `prompt` | string | Yes | A simple text prompt to compose a plan from. Describe the desired music style, tempo, mood, and structure. | | `model_id` | string ("music_v1") | No | Model ID for music generation | | `music_length_ms` | integer | No | The length of the composition plan to generate in milliseconds. Must be between 3000ms and 600000ms. Optional - if not provided, the model will choose a length based on the prompt. | | `source_composition_plan` | object | No | Source composition plan structure | #### 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 **Slug:** `ELEVENREADER_GET_AGENT` Tool to retrieve complete details for a specific conversational AI agent by ID. Use when you need agent configuration, workflow, platform settings, or metadata. #### 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 Agent Knowledge Base Size **Slug:** `ELEVENREADER_GET_AGENT_KNOWLEDGE_BASE_SIZE` Tool to retrieve the size of a conversational AI agent's knowledge base. Use when you need to check how many pages are stored in an agent's knowledge base. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `agent_id` | string | Yes | The unique identifier of the conversational AI agent whose knowledge base size 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 Agent Shareable Link **Slug:** `ELEVENREADER_GET_AGENT_LINK` Tool to get a shareable link for a conversational AI agent. Use when you need to generate or retrieve a link to share an 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 | ### Calculate Agent LLM Expected Cost **Slug:** `ELEVENREADER_GET_AGENT_LLM_EXPECTED_COST_CALCULATION` Tool to calculate expected LLM usage costs for a conversational AI agent. Use when estimating operational costs based on knowledge base size, prompt length, and RAG configuration. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `agent_id` | string | Yes | Unique identifier for the conversational AI agent | | `rag_enabled` | boolean | No | Whether RAG (Retrieval-Augmented Generation) 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 | ### Get Agent Response Test **Slug:** `ELEVENREADER_GET_AGENT_RESPONSE_TEST` Tool to retrieve agent response test details by test ID. Use when you need to fetch test configuration and 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 Agent Response Tests Summaries **Slug:** `ELEVENREADER_GET_AGENT_RESPONSE_TESTS_SUMMARIES` Tool to retrieve agent response test summaries by test IDs. Use when you need to fetch summary information for specific agent tests. #### 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 Agent Summaries **Slug:** `ELEVENREADER_GET_AGENT_SUMMARIES` Tool to retrieve summaries for multiple agents by their IDs. Use when you need to fetch agent information for one or more agents. The response includes a dictionary keyed by agent ID, where each value indicates success or failure for that specific agent. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `agent_ids` | array | Yes | List of agent IDs to fetch summaries for. Each agent ID should be a unique identifier. | #### 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:** `ELEVENREADER_GET_AGENT_WIDGET_ROUTE` Tool to retrieve the widget configuration for a conversational AI agent. Use when you need to get the embed/widget settings including appearance, behavior, and interaction options. #### 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 Audio From History Item **Slug:** `ELEVENREADER_GET_AUDIO_FULL_FROM_SPEECH_HISTORY_ITEM` Tool to retrieve the audio file from a speech history item. Use when you need to download the generated audio for a specific history item. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `history_item_id` | string | Yes | History item ID to be used, you can use GET https://api.elevenlabs.io/v1/history to receive a list of history items and their 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 | ### Get Audio Native Project Settings **Slug:** `ELEVENREADER_GET_AUDIO_NATIVE_PROJECT_SETTINGS` Tool to retrieve audio native project settings from ElevenLabs. Use when you need to get configuration details for a specific Studio project, including enabled status, project settings (title, author, colors, etc.), and snapshot information. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `project_id` | string | Yes | The ID of the Studio 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 Batch Call By Id **Slug:** `ELEVENREADER_GET_BATCH_CALL` Tool to retrieve a batch call by its ID. Use when you need to check the status and details of a specific batch call. #### 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 conversation history **Slug:** `ELEVENREADER_GET_CONVERSATION_HISTORY` Tool to retrieve complete conversation details including transcript, metadata, and analysis. Use when you need to examine the full conversation history, timing data, or assess call performance. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `conversation_id` | string | Yes | The id of the conversation you're taking the action on. | #### 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 Conversations **Slug:** `ELEVENREADER_GET_CONVERSATIONS` Tool to retrieve conversations from ElevenLabs Conversational AI. Use when you need to list, filter, or search conversations by various criteria such as agent, date range, rating, or language. #### 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. | | `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 | Whether to include transcript summaries in the response. | | `main_languages` | string | No | Filter conversations by detected main language (language code). | | `call_successful` | string | No | The result of the success evaluation | | `evaluation_params` | string | No | Evaluation filters. Repeat param. Format: criteria_id:result. Example: eval=value_framing:success | | `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` | string | No | Data collection filters. Repeat param. Format: 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 Conversation Signed Link **Slug:** `ELEVENREADER_GET_CONVERSATION_SIGNED_LINK` Tool to get a signed URL for a conversation with an agent. Use when you need to generate a secure URL for accessing a conversation. #### 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 ConvAI dashboard settings **Slug:** `ELEVENREADER_GET_DASHBOARD_SETTINGS_ROUTE` Tool to retrieve ConvAI dashboard settings including configured charts. Use when you need to view dashboard configuration or check which charts are enabled. #### 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 Documentation From Knowledge Base **Slug:** `ELEVENREADER_GET_DOCUMENTATION_FROM_KNOWLEDGE_BASE` Tool to retrieve a specific document from a conversational AI agent's knowledge base by document ID. Use when you need to fetch details about a specific knowledge base entry including its content, type, and metadata. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `agent_id` | string | No | The ID of the agent to scope the knowledge base query to. | | `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 Dubbed File **Slug:** `ELEVENREADER_GET_DUBBED_FILE` Tool to download a dubbed audio or video file from a dubbing project. Use when you need to retrieve the dubbed output for a specific language from a completed dubbing project. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `dubbing_id` | string | Yes | ID of the dubbing project. | | `language_code` | string | Yes | ID of the language for the dubbed file (e.g., 'es' for Spanish, 'fr' for French). | #### 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 Metadata **Slug:** `ELEVENREADER_GET_DUBBED_METADATA` Tool to retrieve metadata for a dubbing project by ID. Use when you need to check the status, languages, or configuration of a specific dubbing project. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `dubbing_id` | string | Yes | ID of the dubbing 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 Dubbed Transcript **Slug:** `ELEVENREADER_GET_DUBBED_TRANSCRIPT_FILE` Tool to retrieve the transcript of a dubbed audio or video file. Use when you need to get subtitles or full transcript for a specific language from a dubbing project. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `dubbing_id` | string | Yes | ID of the dubbing project. | | `format_type` | string ("srt" | "webvtt" | "json") | No | Format type for the transcript output. | | `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 Dubbing Transcripts **Slug:** `ELEVENREADER_GET_DUBBING_TRANSCRIPTS` Tool to retrieve transcripts from a dubbing project in various formats. Use when you need to get subtitles (SRT/WebVTT) or full transcript data (JSON) for a specific language from a dubbing project. #### 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-639 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 Generate Voice Parameters **Slug:** `ELEVENREADER_GET_GENERATE_VOICE_PARAMETERS` Tool to retrieve voice generation parameters from ElevenLabs. Use when you need to get available options (genders, accents, ages) and constraints (character limits, accent strength ranges) for generating voices. #### 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 Content **Slug:** `ELEVENREADER_GET_KNOWLEDGE_BASE_CONTENT` Tool to retrieve the text content of a knowledge base document by ID. Use when you need to access the actual content/text of a knowledge base entry rather than just its metadata. #### 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:** `ELEVENREADER_GET_KNOWLEDGE_BASE_DEPENDENT_AGENTS` Tool to retrieve the list of conversational AI agents that depend on a specific knowledge base document. Use when you need to identify which agents are using a particular knowledge base entry before modifying or deleting it. #### 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. Cannot 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 Source File URL **Slug:** `ELEVENREADER_GET_KNOWLEDGE_BASE_SOURCE_FILE_URL` Tool to retrieve a signed URL for downloading the source file of a document from the knowledge base. Use when you need to access or download the original file associated with 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:** `ELEVENREADER_GET_KNOWLEDGE_BASE_SUMMARIES` Tool to retrieve summaries for multiple knowledge base documents by their IDs. Use when you need to fetch document information for one or more knowledge base documents. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `document_ids` | array | Yes | List of knowledge base document IDs to fetch summaries for. Each document ID should be a unique identifier. | #### 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 Library Voices **Slug:** `ELEVENREADER_GET_LIBRARY_VOICES` Tool to retrieve shared voices from the ElevenLabs voice library. Use when you need to browse, search, or filter available voices for text-to-speech. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `age` | string | No | Age used for filtering | | `page` | integer | No | Page number for pagination | | `sort` | string | No | Sort criteria | | `accent` | string | No | Accent used for filtering | | `gender` | string | No | Gender used for filtering | | `locale` | string | No | Locale used for filtering | | `search` | string | No | Search term used for filtering | | `category` | string ("professional" | "famous" | "high_quality") | No | Voice category for filtering shared voices. | | `featured` | boolean | No | Filter featured voices | | `language` | string | No | Language used for filtering | | `owner_id` | string | No | Filter voices by public owner ID | | `page_size` | integer | No | How many shared voices to return at maximum. Cannot exceed 100, defaults to 30. | | `use_cases` | string | No | Use-case used for filtering | | `descriptives` | string | No | Descriptive terms used for filtering | | `reader_app_enabled` | boolean | No | Filter voices that are enabled for the reader app | | `include_custom_rates` | string | No | Include/exclude voices with custom rates | | `include_live_moderated` | string | No | Include/exclude voices that are live moderated | | `min_notice_period_days` | string | No | Filter voices with a minimum notice period of the given number of days | #### 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 Live Count **Slug:** `ELEVENREADER_GET_LIVE_COUNT` Tool to retrieve the count of active ongoing conversations. Use when you need to monitor live conversation activity for analytics purposes. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `agent_id` | string | No | The id of an agent to restrict the analytics to. If not provided, returns the count for 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 Models **Slug:** `ELEVENREADER_GET_MODELS` Tool to retrieve available ElevenLabs speech synthesis models. Use when you need to list models for text-to-speech, voice conversion, or to check model capabilities and pricing. #### 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 Or Create RAG Indexes **Slug:** `ELEVENREADER_GET_OR_CREATE_RAG_INDEXES` Tool to compute or retrieve RAG indexes for knowledge base documents in batch. Use when you need to generate embeddings for documents to enable semantic search and retrieval. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `items` | array | Yes | List of requested RAG indexes. Must contain at least 1 and at most 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 | ### Get phone number **Slug:** `ELEVENREADER_GET_PHONE_NUMBER` Tool to retrieve details for a specific phone number by ID. Use when you need phone number configuration, provider settings, or assigned agent information. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `phone_number_id` | string | Yes | The id of a phone number. This is returned when a phone number 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 | ### Get Pronunciation Dictionaries **Slug:** `ELEVENREADER_GET_PRONUNCIATION_DICTIONARIES_METADATA` Tool to get a list of pronunciation dictionaries and their metadata. Use when you need to retrieve available pronunciation dictionaries for browsing, filtering, or selecting a dictionary for further operations. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `sort` | string ("creation_time_unix" | "name") | No | Field to sort pronunciation dictionaries by. | | `cursor` | string | No | Used for fetching next page. Cursor is returned in the response. | | `page_size` | integer | No | How many pronunciation dictionaries to return at maximum. Cannot exceed 100, defaults to 30. | | `sort_direction` | string ("ascending" | "descending") | No | Direction to sort the results in. | #### 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:** `ELEVENREADER_GET_PRONUNCIATION_DICTIONARY_METADATA` Tool to retrieve metadata for a specific pronunciation dictionary by ID. Use when you need details about a particular pronunciation dictionary including version info, rules count, and timestamps. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `pronunciation_dictionary_id` | string | Yes | The id 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 Pronunciation Dictionary Version PLS **Slug:** `ELEVENREADER_GET_PRONUNCIATION_DICTIONARY_VERSION_PLS` Tool to download a PLS file with pronunciation dictionary version rules. Use when you need to retrieve the pronunciation rules for a specific dictionary version in PLS XML format. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `version_id` | string | Yes | The id of the pronunciation dictionary version | | `dictionary_id` | string | Yes | The id 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 RAG Indexes **Slug:** `ELEVENREADER_GET_RAG_INDEXES` Tool to retrieve RAG indexes for a specific knowledge base document. Use when you need to check the status and details of embeddings generated for a 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 RAG Index Overview **Slug:** `ELEVENREADER_GET_RAG_INDEX_OVERVIEW` Tool to retrieve an overview of the RAG (Retrieval-Augmented Generation) index. Use when you need to check storage usage and available capacity for the knowledge base embedding models. #### 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 Resource Metadata **Slug:** `ELEVENREADER_GET_RESOURCE_METADATA` Tool to retrieve metadata and sharing permissions for a workspace resource. Use when you need to check who has access to a resource, manage sharing permissions, or view resource details. #### 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 ConvAI workspace secrets **Slug:** `ELEVENREADER_GET_SECRETS_ROUTE` Tool to retrieve ConvAI workspace secrets with pagination support. Use when you need to list stored secrets for the workspace, such as API keys or credentials used by agents. #### 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. Cannot 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 workspace settings **Slug:** `ELEVENREADER_GET_SETTINGS_ROUTE` Tool to retrieve ConvAI workspace settings including MCP server access, LiveKit stack configuration, RAG retention, and webhook settings. Use when you need to view the current workspace configuration. #### 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:** `ELEVENREADER_GET_SIMILAR_LIBRARY_VOICES` Tool to find similar voices from the ElevenLabs library by uploading an audio sample. Use when you need to discover library voices that match a specific voice characteristic or sample. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `top_k` | integer | No | Number of most similar voices to return. If similarity_threshold is provided, less than this number of voices may be returned. Values range from 1 to 100. | | `audio_file` | object | Yes | Audio file to compare against library voices. | | `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. | #### 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 Single Use Token **Slug:** `ELEVENREADER_GET_SINGLE_USE_TOKEN` Tool to create a single-use token for ElevenLabs API. Use when you need a time-limited token for websocket connections (TTS or real-time transcription). Token expires after 15 minutes and is consumed on first use. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `token_type` | string ("realtime_scribe" | "tts_websocket") | Yes | The type of token to create. Use 'realtime_scribe' for real-time transcription or '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 | ### Get Speech History **Slug:** `ELEVENREADER_GET_SPEECH_HISTORY` Tool to list generated speech history items from ElevenLabs. Use when you need to retrieve past speech generations for browsing, searching by voice or model, or reviewing generation history. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `search` | string | No | Search term used for filtering | | `source` | string | No | Source of the generated history item | | `model_id` | string | No | Model ID to filter history items by. | | `voice_id` | string | No | Voice ID to be filtered for, you can use GET https://api.elevenlabs.io/v1/voices to receive a list of voices and their IDs. | | `page_size` | integer | No | How many history items to return at maximum. Cannot exceed 1000, defaults to 100. | | `sort_direction` | string ("asc" | "desc") | No | Sort direction for history items. | | `date_after_unix` | string | No | Unix timestamp to filter history items after this date (inclusive). | | `date_before_unix` | string | No | Unix timestamp to filter history items before this date (exclusive). | | `start_after_history_item_id` | string | No | After which ID to start fetching, use this parameter to paginate across a large collection of history items. In case this parameter is not provided history items will be fetched starting from the most recently created one ordered descending by their creation date. | #### 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 speech history item by ID **Slug:** `ELEVENREADER_GET_SPEECH_HISTORY_ITEM_BY_ID` Tool to retrieve complete details for a specific speech history item by ID. Use when you need information about a previously generated audio item including text, voice settings, and metadata. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `history_item_id` | string | Yes | History item ID to be used, you can use GET https://api.elevenlabs.io/v1/history to receive a list of history items and their 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 | ### Get Test Invocation **Slug:** `ELEVENREADER_GET_TEST_INVOCATION` Tool to retrieve test invocation details by invocation ID. Use when you need to get test run results and status for a specific test invocation. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `test_invocation_id` | string | Yes | The id of a test invocation. This is returned when tests are run. | #### 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 **Slug:** `ELEVENREADER_GET_TOOL` Tool to retrieve complete details for a specific conversational AI tool by ID. Use when you need tool configuration, usage statistics, or access information. #### 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 Tool Dependent Agents **Slug:** `ELEVENREADER_GET_TOOL_DEPENDENT_AGENTS` Tool to retrieve the list of conversational AI agents that depend on a specific tool. Use when you need to identify which agents are using a particular tool before modifying or deleting it. #### 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. 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 | ### Get ConvAI Tools **Slug:** `ELEVENREADER_GET_TOOLS_ROUTE` Tool to retrieve ConvAI tools with pagination support. Use when you need to list available tools in the workspace for browsing, searching, or selecting a tool for further operations. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `types` | string | No | If present, the endpoint will return only tools 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 tools 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. Cannot exceed 100, defaults to 30. | | `sort_direction` | string ("asc" | "desc") | No | Sort direction for tool listing. | | `show_only_owned_documents` | boolean | No | If set to true, the endpoint will return only tools 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 Transcript By ID **Slug:** `ELEVENREADER_GET_TRANSCRIPT_BY_ID` Tool to retrieve a speech-to-text transcript by its unique ID. Use when you need to fetch the transcribed text, word timings, and language detection results for a previously processed audio file. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `transcription_id` | string | Yes | The unique ID of the transcript 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 Characters Usage Metrics **Slug:** `ELEVENREADER_GET_USAGE_CHARACTERS` Tool to retrieve character usage metrics from ElevenLabs. Use when you need to analyze usage patterns, track consumption over time periods, or generate usage reports with custom breakdowns and aggregation intervals. #### 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 | Metric type 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 | Type of breakdown for usage statistics. | | `aggregation_interval` | string ("hour" | "day" | "week" | "month" | "cumulative") | No | Time interval for aggregating usage data. | | `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. | #### 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:** `ELEVENREADER_GET_USER_INFO` Tool to retrieve information about the authenticated user, including subscription details, character limits, and voice quotas. Use when you need to check user account status, remaining credits, or subscription tier. #### 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:** `ELEVENREADER_GET_USER_SUBSCRIPTION_INFO` Tool to retrieve detailed subscription information for the authenticated user. Use when you need to check subscription tier, character usage, voice limits, billing status, or open invoices. #### 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 Voices V2 **Slug:** `ELEVENREADER_GET_USER_VOICES_V2` Tool to retrieve voices using the V2 API from ElevenLabs. Use when you need to list available voices with advanced filtering, sorting, and pagination capabilities including search, voice type, category, and fine-tuning state filters. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `sort` | string ("created_at_unix" | "name") | No | Field to sort voices by. | | `search` | string | No | Search term to filter voices by. Searches in name, description, labels, category. | | `category` | string ("premade" | "cloned" | "generated" | "professional") | No | Category of voice to filter by. | | `page_size` | integer | No | How many voices to return at maximum. Cannot exceed 100, defaults to 10. Page 0 may include more voices due to default voices being included. | | `voice_ids` | string | No | Voice IDs to lookup by. Maximum 100 voice IDs. | | `voice_type` | string ("personal" | "community" | "default" | "workspace" | "non-default" | "saved") | No | Type of voice to filter by. | | `collection_id` | string | No | Collection ID to filter voices by. | | `sort_direction` | string ("asc" | "desc") | No | Sort direction for voice listing. | | `next_page_token` | string | No | The next page token to use for pagination. Returned from the previous request. Use this in combination with the has_more flag for reliable pagination. | | `fine_tuning_state` | string ("draft" | "not_verified" | "not_started" | "queued" | "fine_tuning" | "fine_tuned" | "failed" | "delayed") | No | State of voice fine tuning. | | `include_total_count` | boolean | No | Whether to include the total count of voices found in the response. NOTE: The total_count value is a live snapshot and may change between requests as users create, modify, or delete voices. For pagination, rely on the has_more flag instead. Only enable this when you actually need the total count (e.g., for display purposes), as it incurs a performance cost. | #### 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 by ID **Slug:** `ELEVENREADER_GET_VOICE_BY_ID` Tool to retrieve complete details for a specific voice by ID. Use when you need information about a voice including its settings, category, verification status, and metadata. #### 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. | #### 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:** `ELEVENREADER_GET_VOICE_SETTINGS` Tool to retrieve the current settings for a specific voice. Use when you need to check voice configuration parameters like stability, similarity boost, speed, style, and speaker boost settings. #### 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. | #### 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:** `ELEVENREADER_GET_VOICE_SETTINGS_DEFAULT` Tool to retrieve default voice settings for speech synthesis. Use when you need to check the default configuration values for voice stability, similarity, speed, style, and speaker boost 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 Workspace Batch Calls **Slug:** `ELEVENREADER_GET_WORKSPACE_BATCH_CALLS` Tool to get all batch calls for a workspace. Use when you need to retrieve a list of batch calls with pagination support. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `limit` | integer | No | Maximum number of batch calls to return. Defaults to 100. | | `last_doc` | string | No | Document ID to paginate from. Use the next_doc value from a previous response to fetch the next page. | #### 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 Service Accounts **Slug:** `ELEVENREADER_GET_WORKSPACE_SERVICE_ACCOUNTS` Tool to retrieve all service accounts in the workspace. Use when you need to list service accounts for workspace management or API key administration. #### 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 | ### Handle SIP Trunk Outbound Call **Slug:** `ELEVENREADER_HANDLE_SIP_TRUNK_OUTBOUND_CALL` Tool to initiate an outbound call via SIP trunk using ElevenLabs ConvAI. Use when you need to programmatically place an outbound call with a conversational agent to a specific phone number. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `agent_id` | string | Yes | The ID of the conversational agent to use for this call. | | `to_number` | string | Yes | The destination phone number to call in E.164 format (e.g., +14155551234). | | `agent_phone_number_id` | string | Yes | The ID of the agent's phone number to use for this outbound call. | | `conversation_initiation_client_data` | object | No | Client data for conversation initiation. | #### 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 | ### Import Phone Number **Slug:** `ELEVENREADER_IMPORT_PHONE_NUMBER` Tool to import a phone number (Twilio or SIP trunk) into ElevenLabs ConvAI. Use when you need to add an external phone number for making or receiving calls with conversational agents. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `sid` | string | No | Twilio Account SID for authentication. Required for Twilio phone numbers. | | `label` | string | Yes | A custom label to identify this phone number. | | `token` | string | No | Twilio Auth Token for authentication. Required for Twilio phone numbers. | | `provider` | string | No | Provider name (e.g., 'twilio', 'sip_trunk'). | | `phone_number` | string | Yes | The phone number to import in E.164 format (e.g., +14155552468). | | `region_config` | object | No | Optional region-specific configuration for Twilio phone numbers. | | `supports_inbound` | boolean | No | Whether the phone number supports inbound calls. | | `supports_outbound` | boolean | No | Whether the phone number supports outbound calls. | | `inbound_trunk_config` | object | No | Configuration for inbound SIP trunk. Used for SIP trunk phone numbers. | | `outbound_trunk_config` | object | No | Configuration for outbound SIP trunk. Used for SIP trunk phone numbers. | #### 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 | ### Isolate Audio Stream **Slug:** `ELEVENREADER_ISOLATE_AUDIO_STREAM` Tool to isolate vocals/speech from audio files using ElevenLabs Audio Isolation API. Use when you need to extract or separate speech from background noise or music. The audio file must be at least 4.6 seconds long. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `audio` | object | Yes | The audio file from which vocals/speech will be isolated. Minimum duration: 4.6 seconds. | | `file_format` | string ("pcm_s16le_16" | "other") | No | Audio file format options | #### 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 Agent Branches **Slug:** `ELEVENREADER_LIST_AGENT_BRANCHES` Tool to list all branches for a specific agent. Use when you need to retrieve branch information for an agent. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `limit` | integer | No | How many results at most should be returned | | `agent_id` | string | Yes | The id of an agent. This is returned on agent creation. | | `include_archived` | boolean | No | Whether archived branches should be included | #### 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 Agent Response Tests **Slug:** `ELEVENREADER_LIST_AGENT_RESPONSE_TESTS` Tool to list agent response tests from ElevenLabs conversational AI. Use when you need to retrieve available tests for agent conversations or testing. #### 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. 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 | ### List Agents **Slug:** `ELEVENREADER_LIST_AGENTS` Tool to list conversational AI agents from ElevenLabs. Use when you need to retrieve agents for browsing, searching, or selecting an agent for further operations. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `cursor` | string | No | Used for fetching next page. Cursor is returned in the response. | | `search` | string | No | Search by agent name | | `sort_by` | string | No | The field to sort the results by | | `archived` | boolean | No | Filter agents by archived status. Set to true to show archived agents. | | `page_size` | integer | No | How many agents to return at maximum. Cannot exceed 100, defaults to 30. | | `sort_direction` | string ("asc" | "desc") | No | Sort direction for agent listing. | | `show_only_owned_agents` | boolean | No | If set to true, the endpoint will omit any agents that were shared with you by someone else and include only the ones you own | #### 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:** `ELEVENREADER_LIST_DUBS` Tool to list dubbing projects from ElevenLabs. Use when you need to retrieve dubbing projects for browsing, filtering by status, or selecting a dubbing project for further operations. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `cursor` | string | No | Used for fetching next page. Cursor is returned in the response. | | `order_by` | string | No | The field to use for ordering results from this query | | `page_size` | integer | No | How many dubs to return at maximum. Cannot exceed 200, defaults to 100. | | `dubbing_status` | string ("dubbing" | "dubbed" | "failed") | No | Status of the dubbing process. | | `order_direction` | string ("DESCENDING" | "ASCENDING") | No | Order direction for results. | | `filter_by_creator` | string ("personal" | "others" | "all") | No | Filter for who created the resources. | #### 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 Knowledge Bases **Slug:** `ELEVENREADER_LIST_KNOWLEDGE_BASES` Tool to list knowledge base documents from ElevenLabs. Use when you need to retrieve knowledge base documents for browsing, searching, or selecting documents for further operations. #### 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. Cannot 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 listing. | | `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 | ### List MCP Servers **Slug:** `ELEVENREADER_LIST_MCP_SERVERS` Tool to list all MCP (Model Context Protocol) server configurations in the workspace. Use when you need to view available MCP servers, their configurations, and which agents depend on them. #### 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:** `ELEVENREADER_LIST_PHONE_NUMBERS` Tool to list all phone numbers available in your ElevenLabs ConvAI workspace. Use when you need to retrieve configured phone numbers for 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 | ### List Test Invocations **Slug:** `ELEVENREADER_LIST_TEST_INVOCATIONS` Tool to list test invocations for a specific conversational AI agent. Use when you need to retrieve test execution history, including pass/fail counts and test run details. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `cursor` | string | No | Used for fetching next page. Cursor is returned in the response. | | `agent_id` | string | Yes | Filter by agent ID. This is required to retrieve test invocations for a specific agent. | | `page_size` | integer | No | How many Tests 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 | ### List WhatsApp Accounts **Slug:** `ELEVENREADER_LIST_WHATSAPP_ACCOUNTS` Tool to list all WhatsApp accounts available in your ElevenLabs ConvAI workspace. Use when you need to retrieve configured WhatsApp accounts for 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 | ### List Workspace Webhooks **Slug:** `ELEVENREADER_LIST_WORKSPACE_WEBHOOKS` Tool to list all webhooks configured in your ElevenLabs workspace. Use when you need to retrieve webhook configurations, check webhook status, or manage webhook integrations. #### 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 | ### Bulk Move Knowledge Base Entities **Slug:** `ELEVENREADER_MOVE_KNOWLEDGE_BASE_ENTITIES` Tool to bulk move documents or folders to a target folder in the knowledge base. Use when you need to organize multiple knowledge base entities by moving them to a specific folder or to the root. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `move_to` | string | No | The ID of the folder 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 Knowledge Base Entity **Slug:** `ELEVENREADER_MOVE_KNOWLEDGE_BASE_ENTITY` Tool to move a document or folder to a target folder in the knowledge base. Use when you need to organize a knowledge base entity by moving it to a specific folder or to the root. #### 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 | ### Patch Agent Settings **Slug:** `ELEVENREADER_PATCH_AGENT_SETTINGS` Tool to patch (partially update) an agent's settings. Use when you need to update specific fields of an agent without replacing all 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 | Agent workflow configuration including nodes and edges defining the agent's conversation flow | | `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 including agent, asr, conversation, tts, turn, and vad settings | | `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 Pronunciation Dictionary **Slug:** `ELEVENREADER_PATCH_PRONUNCIATION_DICTIONARY` Tool to update a pronunciation dictionary. Use when you need to modify the name or archive status of an existing pronunciation 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 ID 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 | ### Post Agent Avatar **Slug:** `ELEVENREADER_POST_AGENT_AVATAR` Tool to upload an avatar image for a conversational AI agent. Use when you need to set or update the visual representation of an agent. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `agent_id` | string | Yes | The id of an agent. This is returned on agent creation. | | `avatar_file` | object | Yes | An 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 | ### Register Twilio Call **Slug:** `ELEVENREADER_REGISTER_TWILIO_CALL` Tool to register a Twilio call with ElevenLabs ConvAI and return TwiML. Use when you need to connect an incoming or outgoing Twilio call to a conversational AI agent. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `agent_id` | string | Yes | ID of the conversational AI agent to use for the call. | | `direction` | string ("inbound" | "outbound") | No | Direction of the call: inbound or outbound. | | `to_number` | string | Yes | Phone number the call is to in E.164 format (e.g., +14155555678). | | `from_number` | string | Yes | Phone number the call is from in E.164 format (e.g., +14155551234). | | `conversation_initiation_client_data` | object | No | Client data for conversation initiation. | #### 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 Pronunciation Dictionary Rules **Slug:** `ELEVENREADER_REMOVE_PRONUNCIATION_DICTIONARY_RULES` Tool to remove rules from a pronunciation dictionary. Use when you need to delete specific pronunciation rules from a dictionary by their rule strings. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `rule_strings` | array | Yes | List of rule strings to remove from the pronunciation dictionary. | | `pronunciation_dictionary_id` | string | Yes | The ID of the pronunciation dictionary from which to remove rules. | #### 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 Tests **Slug:** `ELEVENREADER_RESUBMIT_TESTS` Tool to resubmit failed or specific tests from a previous test invocation. Use when you need to re-run specific tests without creating a new test suite, typically to verify fixes or retry failed tests. Supports 1-200 test runs per request with optional branch and configuration overrides. #### 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. Must contain 1-200 test run IDs. | | `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:** `ELEVENREADER_RETRY_BATCH_CALL` Tool to retry a failed or cancelled batch call. Use when you need to re-attempt a batch call that did not complete successfully. This action will re-queue the batch call for processing with an incremented retry count. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `batch_id` | string | Yes | The unique identifier of the batch call to retry | #### 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 Test Suite **Slug:** `ELEVENREADER_RUN_AGENT_TEST_SUITE` Tool to run tests on a conversational AI agent. Use when you need to execute one or more predefined tests to validate agent behavior, responses, or tool calls. Supports running 1-200 tests in a single request with optional branch and configuration overrides. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `tests` | array | Yes | List of tests to run on the agent. Must contain 1-200 tests. | | `agent_id` | string | Yes | The ID 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. 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 | ### Run Conversation Simulation **Slug:** `ELEVENREADER_RUN_CONVERSATION_SIMULATION` Tool to simulate a conversation between an agent and an AI user. Use when testing agent behavior in conversation scenarios. #### 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 during the conversation 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 | ### Simulate Conversation (Stream) **Slug:** `ELEVENREADER_SIMULATE_CONVERSATION_STREAM` Tool to simulate a conversation with an AI agent using a streaming endpoint. Use when you need to test or demonstrate agent conversation capabilities with streaming responses. This endpoint allows you to configure the simulated user's behavior, language, and conversation history. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `agent_id` | string | Yes | The ID of the agent to simulate a conversation with. 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 during the 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 | ### Update Agent Response Test **Slug:** `ELEVENREADER_UPDATE_AGENT_RESPONSE_TEST` Tool to update an existing agent response test in ElevenLabs ConvAI. Use when you need to modify test parameters, chat history, or test conditions for agent evaluation. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `name` | string | Yes | Name of the test. This field is required. | | `type` | string | No | Type of the test (e.g., 'response', 'tool_call', 'simulation') | | `test_id` | string | Yes | The ID of the test to update. This is returned on test creation. | | `chat_history` | array | No | List of chat messages to test the agent with | | `failure_examples` | array | No | Examples of failure responses for response unit tests. Can be strings or objects with 'response' and 'type' fields | | `success_examples` | array | No | Examples of successful responses for response unit tests. Can be strings or objects with 'response' and 'type' fields | | `dynamic_variables` | object | No | Dynamic variables to use in the test | | `success_condition` | string | No | Condition that defines success for the test | | `simulation_scenario` | string | No | Scenario description for simulation tests | | `simulation_max_turns` | integer | No | Maximum number of turns for simulation tests | | `tool_call_parameters` | string | No | Parameters for tool call verification | | `check_any_tool_matches` | string | No | Check if any tool matches the specified criteria | | `from_conversation_metadata` | string | No | Metadata from the 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 | ### Update Audio Native Project Content **Slug:** `ELEVENREADER_UPDATE_AUDIO_NATIVE_PROJECT_CONTENT` Tool to update audio-native project content by uploading a new txt or HTML file. Use when you need to replace or update the content of an existing audio-native project. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `file` | object | No | Either txt or HTML input file containing the article content. HTML should be formatted as follows '

Your content

More of your content

Some more of your content

'. | | `project_id` | string | Yes | The ID of the Studio project. | | `auto_convert` | boolean | No | Whether to auto convert the project to audio or not. | | `auto_publish` | boolean | No | Whether to auto publish the new project snapshot after it's 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 | ### Update ConvAI Settings **Slug:** `ELEVENREADER_UPDATE_CONVAI_SETTINGS` Tool to update ConvAI workspace settings in ElevenLabs. Use when you need to configure MCP server access, LiveKit stack preferences, RAG retention, or webhook settings. #### 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 | Type of LiveKit stack to use. | | `rag_retention_period_days` | integer | No | Number of days to retain RAG (Retrieval-Augmented Generation) data. Must be between 1 and 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:** `ELEVENREADER_UPDATE_DASHBOARD_SETTINGS_ROUTE` Tool to update ConvAI dashboard settings including chart configurations. Use when you need to customize which charts appear on the dashboard. Supports up to 4 charts of types: call success, criteria-based, or data collection. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `charts` | array | No | List of charts to display on the dashboard. Each chart can be one of three types: call success (for call success rate metrics), criteria (for tracking specific criteria by ID), or data collection (for tracking data collections by ID). Maximum of 4 charts 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 | ### Update Document **Slug:** `ELEVENREADER_UPDATE_DOCUMENT` Tool to update a document in the ElevenLabs knowledge base. Use when you need to modify the name of an existing 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 Phone Number **Slug:** `ELEVENREADER_UPDATE_PHONE_NUMBER` Tool to update a phone number's configuration in ElevenLabs ConvAI. Use when you need to modify the label, assign/unassign an agent, or update SIP trunk settings. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `label` | string | No | A label to identify this phone number | | `agent_id` | string | No | The id of an agent to assign to this phone number. Set to null to unassign. | | `livekit_stack` | string | No | LiveKit stack type for this phone number. Only applicable for SIP trunk phone numbers. | | `phone_number_id` | string | Yes | The id of the phone number to update. This is returned when listing phone numbers. | | `inbound_trunk_config` | object | No | Inbound SIP Trunk configuration. | | `outbound_trunk_config` | object | No | Outbound SIP Trunk configuration. | #### 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:** `ELEVENREADER_UPDATE_SECRET_ROUTE` Tool to update a Convai workspace secret by ID. Use when you need to modify the name or value of an existing secret. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `name` | string | Yes | The updated name for the secret | | `type` | string ("update") | No | Must be 'update' for PATCH requests | | `value` | string | Yes | The updated value for the secret | | `secret_id` | string | Yes | The ID of the secret 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 Tool **Slug:** `ELEVENREADER_UPDATE_TOOL` Tool to update a conversational AI tool configuration. Use when you need to modify tool settings like name, description, or API schema. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `tool_id` | string | Yes | ID of the tool to update. | | `tool_config` | object | Yes | Configuration for the tool. Must include 'type' field (webhook/client/system/mcp) and required fields for that type. For webhook: name, description, api_schema. For client: name, description. For system: name, params. For mcp: name, description, integration_type, mcp_tool_name, mcp_tool_description, mcp_server_id, mcp_server_name. | #### 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 |