Skip to main content
Elevenreader logo
  • Category: audio & speech
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 124
  • Triggers: 0
  • Slug: ELEVENREADER
  • Version: 20261101_00

Tools

Slug: ELEVENREADER_ADD_DOCUMENTATION_TO_KNOWLEDGE_BASETool 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

string
URL to a page of documentation that the agent will have access to. Either file or url must be provided, but not both.
object
Documentation file to upload. Either file or url must be provided, but not both.
string
A custom, human-readable name for the document.
string
The ID of the agent to add the documentation to.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENREADER_ADD_PRONUNCIATION_DICTIONARY_FROM_FILETool 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

object
A lexicon.pls file which will be used to initialize the pronunciation dictionary.
string
required
The name of the pronunciation dictionary, used for identification only.
string
A description of the pronunciation dictionary, used for identification only.
string ("admin" | "editor" | "viewer")
Workspace access level for the pronunciation dictionary.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENREADER_ADD_PRONUNCIATION_DICTIONARY_FROM_RULESTool 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

string
required
The name of the pronunciation dictionary, used for identification only.
array
required
List of pronunciation rules. Each rule can be either an alias rule (string replacement) or a phoneme rule (phonetic pronunciation).
string
A description of the pronunciation dictionary, used for identification only.
string ("admin" | "editor" | "viewer")
Workspace access level for the pronunciation dictionary.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENREADER_ADD_PRONUNCIATION_DICTIONARY_RULESTool 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

array
required
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).
string
required
The ID of the pronunciation dictionary to add rules to.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENREADER_ADD_SHARED_VOICETool 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

string
required
The name that identifies this voice. This will be displayed in the dropdown of the website.
string
required
Voice ID to be used, you can use https://api.elevenlabs.io/v1/voices to list all the available voices.
string
required
Public user ID used to publicly identify ElevenLabs users.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENREADER_ADD_TOOLTool 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

string
required
Configuration for the tool. Can be one of: webhook, client, system, or mcp tool configuration.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENREADER_CALCULATE_PUBLIC_LLM_EXPECTED_COSTTool 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

boolean
required
Whether RAG (Retrieval-Augmented Generation) is enabled
integer
required
Length of the prompt in characters
integer
required
Pages of content in PDF documents or URLs in the agent’s knowledge base

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENREADER_CANCEL_BATCH_CALLTool to cancel an active batch call operation. Use when you need to stop a scheduled or in-progress batch calling campaign.

Input Parameters

string
required
The unique identifier of the batch call to cancel.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENREADER_COMPUTE_RAG_INDEXTool 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

string ("e5_mistral_7b_instruct" | "multilingual_e5_large_instruct")
required
Embedding model to use for RAG index computation.
string
required
The id of a document from the knowledge base. This is returned on document addition.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENREADER_CREATE_AGENTTool 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

string
A name to make the agent easier to find.
array
Tags to help classify and filter the agent.
object
required
Configuration for the conversational agent including TTS, ASR, and agent behavior settings.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENREADER_CREATE_AGENT_RESPONSE_TESTTool 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

string
required
Name of the test
string ("llm" | "tool" | "simulation")
required
Type of test to create: ‘llm’ for response tests, ‘tool’ for tool call tests, ‘simulation’ for simulation tests
array
List of chat messages representing the conversation history
array
Examples of failed responses. Used for ‘llm’ test type
array
Examples of successful responses. Used for ‘llm’ test type
object
Dynamic variables to use in the test
string
Condition that defines a successful test. Used for ‘llm’ and ‘simulation’ test types
string
Scenario to simulate in the test. Used for ‘simulation’ test type
integer
Maximum number of turns in the simulation. Used for ‘simulation’ test type
object
Parameters for the tool call. Used for ‘tool_call’ test type
boolean
Flag to check if any tool matches. Used for ‘tool_call’ test type
object
Metadata from the conversation

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENREADER_CREATE_AUDIO_NATIVE_PROJECTTool 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

object
File to upload containing the article content (TXT or HTML). HTML should be formatted as ‘<html><body><div><p>Your content</p><h3>More content</h3></div></body></html>’.
string
required
Project name for the Audio Native project.
string
(Deprecated) Image URL used in the player. If not provided, default image set in the Player settings is used.
boolean
(Deprecated) Whether to use small player or not. If not provided, default value set in the Player settings is used.
string
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.
string
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.
string
TTS Model ID used in the player. If not provided, default model ID set in the Player settings is used.
string
Voice ID used to voice the content. If not provided, default voice ID set in the Player settings is used.
string
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.
boolean
Whether to automatically convert the project to audio after creation.
integer
(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.
string
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.
string ("auto" | "on" | "off" | "apply_english")
Text normalization modes for audio conversion.
array
List of pronunciation dictionary locators (pronunciation_dictionary_id, version_id) encoded as JSON strings for pronunciation dictionaries to be applied to the text.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENREADER_CREATE_BATCH_CALLTool 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

string
required
ID of the conversational AI agent to use for the calls.
string
Timezone for the scheduled time (e.g., ‘America/New_York’, ‘UTC’).
string
required
Name for the batch call campaign.
array
required
List of recipients for the batch call. Maximum 10,000 recipients.
object
WhatsApp-specific parameters for batch calls.
integer
Unix timestamp for when to schedule the batch call. If not provided, calls start immediately.
string
ID of the phone number to use for making the calls.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENREADER_CREATE_FILE_DOCUMENTTool 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

object
required
Documentation file that the agent will have access to in order to interact with users.
string
A custom, human-readable name for the document. If not provided, the filename will be used.
string
If set, the created document will be placed inside the given folder.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENREADER_CREATE_FOLDERTool 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

string
required
A custom, human-readable name for the folder.
string
If set, the created folder will be placed inside the given folder.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENREADER_CREATE_SECRETTool 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

string
required
Name of the secret for identification purposes.
string ("new")
required
Type of secret. Must be ‘new’ for creating a new secret.
string
required
The secret value to store securely.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENREADER_CREATE_TEXT_DOCUMENTTool 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

string
A custom, human-readable name for the document.
string
required
Text content to be added to the knowledge base.
string
If set, the created document will be placed inside the given folder.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENREADER_CREATE_URL_DOCUMENTTool 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

string
required
URL to a page of documentation that the agent will have access to in order to interact with users.
string
A custom, human-readable name for the document.
string
If set, the created document will be placed inside the given folder.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENREADER_DELETE_AGENTTool to permanently delete an agent from ElevenLabs. Use when you need to remove an agent that is no longer needed.

Input Parameters

string
required
The id of an agent. This is returned on agent creation. WARNING: This permanently deletes the agent and cannot be undone.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENREADER_DELETE_BATCH_CALLTool 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

string
required
The unique identifier of the batch call to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENREADER_DELETE_CHAT_RESPONSE_TESTTool to delete an agent response test. Use when you need to remove a test that is no longer needed.

Input Parameters

string
required
The id of a chat response test. This is returned on test creation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENREADER_DELETE_CONVERSATIONTool to delete a conversation by its unique ID. Use when you need to permanently remove a conversation from the system.

Input Parameters

string
required
The id of the conversation you’re taking the action on.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENREADER_DELETE_DUBBINGTool 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

string
required
ID of the dubbing project to delete. This permanently removes the dubbing project and cannot be undone.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENREADER_DELETE_KNOWLEDGE_BASE_DOCUMENTTool to permanently delete a document from the knowledge base. Use when you need to remove documentation that is no longer needed.

Input Parameters

boolean
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.
string
required
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENREADER_DELETE_PHONE_NUMBERTool 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

string
required
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENREADER_DELETE_RAG_INDEXTool 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

string
required
The id of RAG index of document from the knowledge base.
string
required
The id of a document from the knowledge base. This is returned on document addition.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENREADER_DELETE_SECRET_ROUTETool to delete a specific Convai workspace secret. Use when you need to permanently remove a secret by its ID.

Input Parameters

string
required
The unique identifier of the secret to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENREADER_DELETE_SPEECH_HISTORY_ITEMTool to permanently delete a speech history item by its ID. Use when you need to remove a specific history item from ElevenLabs.

Input Parameters

string
required
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENREADER_DELETE_TOOL_ROUTETool to permanently delete a conversational AI tool from ElevenLabs. Use when you need to remove a tool that is no longer needed.

Input Parameters

string
required
ID of the requested tool to be deleted.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENREADER_DELETE_TRANSCRIPT_BY_IDTool 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

string
required
The unique ID of the transcript to delete. This permanently removes the transcript and cannot be undone.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENREADER_DOWNLOAD_SPEECH_HISTORY_ITEMSTool 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

string
Output format to transcode the audio file. Must be ‘wav’ or None. If not specified or None, uses the original format.
array
required
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENREADER_DUPLICATE_AGENTTool to duplicate an existing agent. Use when you need to create a copy of an agent with all its configuration.

Input Parameters

string
A name to make the agent easier to find. If not provided, the duplicated agent will have a default name.
string
required
The id of an agent. This is returned on agent creation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENREADER_EDIT_VOICETool 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

string
required
The name that identifies this voice. This will be displayed in the dropdown of the website.
array
Audio files to add to the voice. List of.
string
Labels for the voice. Can be a dictionary with keys like language, accent, gender, or age, or a JSON string.
string
required
Voice ID to be used, you can use https://api.elevenlabs.io/v1/voices to list all the available voices.
string
A description of the voice.
boolean
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENREADER_EDIT_VOICE_SETTINGSEdit settings for a specific ElevenLabs voice, including stability, similarity boost, speed, style, and speaker boost. Omitted settings are sent with the tool’s defaults unless explicitly set to null.

Input Parameters

number
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.
number
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.
string
required
Voice ID to be used, you can use https://api.elevenlabs.io/v1/voices to list all the available voices.
number
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.
number
Determines how closely the AI should adhere to the original voice when attempting to replicate it.
boolean
This setting boosts the similarity to the original speaker. Using this setting requires a slightly higher computational load, which in turn increases latency.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENREADER_GENERATE_COMPOSITION_PLANTool 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

string
required
A simple text prompt to compose a plan from. Describe the desired music style, tempo, mood, and structure.
string ("music_v1")
Model ID for music generation
integer
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.
object
Source composition plan structure

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENREADER_GET_AGENTRetrieve details for a conversational AI agent by ID, including selected configuration, workflow, platform settings, and metadata. The response omits some configuration details, including prompt contents.

Input Parameters

string
required
The id of an agent. This is returned on agent creation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENREADER_GET_AGENT_KNOWLEDGE_BASE_SIZETool 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

string
required
The unique identifier of the conversational AI agent whose knowledge base size is to be retrieved.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENREADER_GET_AGENT_LLM_EXPECTED_COST_CALCULATIONTool 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

string
required
Unique identifier for the conversational AI agent
boolean
Whether RAG (Retrieval-Augmented Generation) is enabled
integer
Length of the prompt in characters
integer
Pages of content in pdf documents OR urls in agent’s Knowledge Base

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENREADER_GET_AGENT_RESPONSE_TESTTool to retrieve agent response test details by test ID. Use when you need to fetch test configuration and parameters.

Input Parameters

string
required
The id of a chat response test. This is returned on test creation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENREADER_GET_AGENT_RESPONSE_TESTS_SUMMARIESTool to retrieve agent response test summaries by test IDs. Use when you need to fetch summary information for specific agent tests.

Input Parameters

array
required
List of test IDs to fetch. No duplicates allowed.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENREADER_GET_AGENT_SUMMARIESTool 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

array
required
List of agent IDs to fetch summaries for. Each agent ID should be a unique identifier.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENREADER_GET_AGENT_WIDGET_ROUTETool 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

string
required
The id of an agent. This is returned on agent creation.
string
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENREADER_GET_AUDIO_FULL_FROM_SPEECH_HISTORY_ITEMTool 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

string
required
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENREADER_GET_AUDIO_NATIVE_PROJECT_SETTINGSTool 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

string
required
The ID of the Studio project.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENREADER_GET_BATCH_CALLTool 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

string
required
The unique identifier of the batch call to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENREADER_GET_CONVERSATION_HISTORYRetrieve conversation details by ID, including transcript, metadata and available analysis, for reviewing history, timing and call performance.

Input Parameters

string
required
The id of the conversation you’re taking the action on.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENREADER_GET_CONVERSATIONSTool 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

string
Used for fetching next page. Cursor is returned in the response.
Full-text or fuzzy search over transcript messages
string
Filter conversations by the user ID who initiated them.
string
The id of the agent you’re taking the action on.
string
Filter conversations by branch ID.
integer
How many conversations to return at maximum. Can not exceed 100, defaults to 30.
string
Maximum overall rating (1-5).
string
Minimum overall rating (1-5).
string
Filter conversations by tool names used during the call.
string ("exclude" | "include")
Whether to include transcript summaries in the response.
string
Filter conversations by detected main language (language code).
string
The result of the success evaluation
string
Evaluation filters. Repeat param. Format: criteria_id:result. Example: eval=value_framing:success
string
Filter conversations with user feedback comments.
string
Unix timestamp (in seconds) to filter conversations after to this start date.
string
Maximum call duration in seconds.
string
Minimum call duration in seconds.
string
Unix timestamp (in seconds) to filter conversations up to this start date.
string
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.
string
Filter conversations by initiation source.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENREADER_GET_DASHBOARD_SETTINGS_ROUTETool to retrieve ConvAI dashboard settings including configured charts. Use when you need to view dashboard configuration or check which charts are enabled.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENREADER_GET_DOCUMENTATION_FROM_KNOWLEDGE_BASERetrieve a knowledge base document by ID, including its type and available extracted content. The returned metadata and access information are empty objects.

Input Parameters

string
The ID of the agent to scope the knowledge base query to.
string
required
The id of a document from the knowledge base. This is returned on document addition.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENREADER_GET_DUBBED_FILETool 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

string
required
ID of the dubbing project.
string
required
ID of the language for the dubbed file (e.g., ‘es’ for Spanish, ‘fr’ for French).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENREADER_GET_DUBBED_METADATATool 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

string
required
ID of the dubbing project.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENREADER_GET_DUBBED_TRANSCRIPT_FILETool 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

string
required
ID of the dubbing project.
string ("srt" | "webvtt" | "json")
Format type for the transcript output.
string
required
ISO-693 language code to retrieve the transcript for. Use ‘source’ to fetch the transcript of the original media.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENREADER_GET_DUBBING_TRANSCRIPTSTool 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

string
required
ID of the dubbing project.
string ("srt" | "webvtt" | "json")
required
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.
string
required
ISO-639 language code to retrieve the transcript for. Use ‘source’ to fetch the transcript of the original media.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENREADER_GET_GENERATE_VOICE_PARAMETERSTool 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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENREADER_GET_KNOWLEDGE_BASE_CONTENTTool 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

string
required
The id of a document from the knowledge base. This is returned on document addition.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENREADER_GET_KNOWLEDGE_BASE_DEPENDENT_AGENTSTool 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

string
Used for fetching next page. Cursor is returned in the response.
integer
How many documents to return at maximum. Cannot exceed 100, defaults to 30.
string ("direct" | "transitive" | "all")
Type of dependent agents to return.
string
required
The id of a document from the knowledge base. This is returned on document addition.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENREADER_GET_KNOWLEDGE_BASE_SOURCE_FILE_URLTool 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

string
required
The id of a document from the knowledge base. This is returned on document addition.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENREADER_GET_KNOWLEDGE_BASE_SUMMARIESTool 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

array
required
List of knowledge base document IDs to fetch summaries for. Each document ID should be a unique identifier.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENREADER_GET_LIBRARY_VOICESTool 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

string
Age used for filtering
integer
Page number for pagination
string
Sort criteria
string
Accent used for filtering
string
Gender used for filtering
string
Locale used for filtering
string
Search term used for filtering
string ("professional" | "famous" | "high_quality")
Voice category for filtering shared voices.
Filter featured voices
string
Language used for filtering
string
Filter voices by public owner ID
integer
How many shared voices to return at maximum. Cannot exceed 100, defaults to 30.
string
Use-case used for filtering
string
Descriptive terms used for filtering
boolean
Filter voices that are enabled for the reader app
string
Include/exclude voices with custom rates
string
Include/exclude voices that are live moderated
string
Filter voices with a minimum notice period of the given number of days

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENREADER_GET_LIVE_COUNTTool to retrieve the count of active ongoing conversations. Use when you need to monitor live conversation activity for analytics purposes.

Input Parameters

string
The id of an agent to restrict the analytics to. If not provided, returns the count for all agents.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENREADER_GET_MODELSTool 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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENREADER_GET_OR_CREATE_RAG_INDEXESTool 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

array
required
List of requested RAG indexes. Must contain at least 1 and at most 100 items.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENREADER_GET_PHONE_NUMBERTool 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

string
required
The id of a phone number. This is returned when a phone number is created or listed.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENREADER_GET_PRONUNCIATION_DICTIONARIES_METADATATool 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

string ("creation_time_unix" | "name")
Field to sort pronunciation dictionaries by.
string
Used for fetching next page. Cursor is returned in the response.
integer
How many pronunciation dictionaries to return at maximum. Cannot exceed 100, defaults to 30.
string ("ascending" | "descending")
Direction to sort the results in.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENREADER_GET_PRONUNCIATION_DICTIONARY_METADATATool 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

string
required
The id of the pronunciation dictionary

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENREADER_GET_PRONUNCIATION_DICTIONARY_VERSION_PLSTool 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

string
required
The id of the pronunciation dictionary version
string
required
The id of the pronunciation dictionary

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENREADER_GET_RAG_INDEXESTool 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

string
required
The id of a document from the knowledge base. This is returned on document addition.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENREADER_GET_RAG_INDEX_OVERVIEWTool 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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENREADER_GET_RESOURCE_METADATARetrieve metadata and sharing permissions for a workspace resource, including access details and available sharing options.

Input Parameters

string
required
The ID of the target resource.
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")
required
Resource type of the target resource.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENREADER_GET_SECRETS_ROUTEList ConvAI workspace secret metadata with pagination, including names, IDs and usage information; secret values are not returned.

Input Parameters

string
Used for fetching next page. Cursor is returned in the response.
integer
How many documents to return at maximum. Cannot exceed 100. If not provided, returns all secrets.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENREADER_GET_SETTINGS_ROUTETool 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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENREADER_GET_SIMILAR_LIBRARY_VOICESTool 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

integer
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.
object
required
Audio file to compare against library voices.
number
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENREADER_GET_SINGLE_USE_TOKENTool 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

string ("realtime_scribe" | "tts_websocket")
required
The type of token to create. Use ‘realtime_scribe’ for real-time transcription or ‘tts_websocket’ for text-to-speech websocket connections.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENREADER_GET_SPEECH_HISTORYTool 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

string
Search term used for filtering
string
Source of the generated history item
string
Model ID to filter history items by.
string
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.
integer
How many history items to return at maximum. Cannot exceed 1000, defaults to 100.
string ("asc" | "desc")
Sort direction for history items.
string
Unix timestamp to filter history items after this date (inclusive).
string
Unix timestamp to filter history items before this date (exclusive).
string
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENREADER_GET_SPEECH_HISTORY_ITEM_BY_IDTool 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

string
required
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENREADER_GET_TEST_INVOCATIONTool 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

string
required
The id of a test invocation. This is returned when tests are run.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENREADER_GET_TOOLRetrieve a conversational AI tool by ID, including available configuration, usage statistics, and access information. The returned webhook API schema and dynamic-variable configuration may be incomplete.

Input Parameters

string
required
ID of the requested tool.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENREADER_GET_TOOL_DEPENDENT_AGENTSTool 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

string
Used for fetching next page. Cursor is returned in the response.
string
required
ID of the requested tool.
integer
How many documents to return at maximum. Cannot exceed 100, defaults to 30.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENREADER_GET_TOOLS_ROUTETool 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

string
If present, the endpoint will return only tools of the given types.
string
Used for fetching next page. Cursor is returned in the response.
string
If specified, the endpoint returns only tools whose names start with this string.
string
The field to sort the results by
integer
How many documents to return at maximum. Cannot exceed 100, defaults to 30.
string ("asc" | "desc")
Sort direction for tool listing.
boolean
If set to true, the endpoint will return only tools owned by you (and not shared from somebody else).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENREADER_GET_TRANSCRIPT_BY_IDTool 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

string
required
The unique ID of the transcript to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENREADER_GET_USAGE_CHARACTERSTool 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

string ("credits" | "tts_characters" | "minutes_used" | "request_count" | "ttfb_avg" | "ttfb_p95" | "fiat_units_spent" | "concurrency" | "concurrency_average")
Metric type to aggregate.
integer
required
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.
integer
required
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.
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")
Type of breakdown for usage statistics.
string ("hour" | "day" | "week" | "month" | "cumulative")
Time interval for aggregating usage data.
string
Aggregation bucket size in seconds. Overrides the aggregation interval.
boolean
Whether or not to include the statistics of the entire workspace.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENREADER_GET_USER_INFOTool 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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENREADER_GET_USER_SUBSCRIPTION_INFOTool 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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENREADER_GET_USER_VOICES_V2Tool 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

string ("created_at_unix" | "name")
Field to sort voices by.
string
Search term to filter voices by. Searches in name, description, labels, category.
string ("premade" | "cloned" | "generated" | "professional")
Category of voice to filter by.
integer
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.
string
Voice IDs to lookup by. Maximum 100 voice IDs.
string ("personal" | "community" | "default" | "workspace" | "non-default" | "saved")
Type of voice to filter by.
string
Collection ID to filter voices by.
string ("asc" | "desc")
Sort direction for voice listing.
string
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.
string ("draft" | "not_verified" | "not_started" | "queued" | "fine_tuning" | "fine_tuned" | "failed" | "delayed")
State of voice fine tuning.
boolean
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENREADER_GET_VOICE_BY_IDRetrieve details for a specific voice by ID, including its settings, category, verification status, and metadata.

Input Parameters

string
required
Voice ID to be used, you can use https://api.elevenlabs.io/v1/voices to list all the available voices.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENREADER_GET_VOICE_SETTINGSTool 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

string
required
Voice ID to be used, you can use https://api.elevenlabs.io/v1/voices to list all the available voices.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENREADER_GET_VOICE_SETTINGS_DEFAULTTool 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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENREADER_GET_WORKSPACE_BATCH_CALLSTool to get all batch calls for a workspace. Use when you need to retrieve a list of batch calls with pagination support.

Input Parameters

integer
Maximum number of batch calls to return. Defaults to 100.
string
Document ID to paginate from. Use the next_doc value from a previous response to fetch the next page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENREADER_GET_WORKSPACE_SERVICE_ACCOUNTSTool to retrieve all service accounts in the workspace. Use when you need to list service accounts for workspace management or API key administration.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENREADER_HANDLE_SIP_TRUNK_OUTBOUND_CALLTool 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

string
required
The ID of the conversational agent to use for this call.
string
required
The destination phone number to call in E.164 format (e.g., +14155551234).
string
required
The ID of the agent’s phone number to use for this outbound call.
object
Client data for conversation initiation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENREADER_IMPORT_PHONE_NUMBERTool 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

string
Twilio Account SID for authentication. Required for Twilio phone numbers.
string
required
A custom label to identify this phone number.
string
Twilio Auth Token for authentication. Required for Twilio phone numbers.
string
Provider name (e.g., ‘twilio’, ‘sip_trunk’).
string
required
The phone number to import in E.164 format (e.g., +14155552468).
object
Optional region-specific configuration for Twilio phone numbers.
boolean
Whether the phone number supports inbound calls.
boolean
Whether the phone number supports outbound calls.
object
Configuration for inbound SIP trunk. Used for SIP trunk phone numbers.
object
Configuration for outbound SIP trunk. Used for SIP trunk phone numbers.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENREADER_ISOLATE_AUDIO_STREAMTool 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

object
required
The audio file from which vocals/speech will be isolated. Minimum duration: 4.6 seconds.
string ("pcm_s16le_16" | "other")
Audio file format options

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENREADER_LIST_AGENT_BRANCHESList branches for a specific agent, with an option to include archived branches and a result limit. A non-versioned agent is returned as an empty result.

Input Parameters

integer
How many results at most should be returned
string
required
The id of an agent. This is returned on agent creation.
boolean
Whether archived branches should be included

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENREADER_LIST_AGENT_RESPONSE_TESTSTool to list agent response tests from ElevenLabs conversational AI. Use when you need to retrieve available tests for agent conversations or testing.

Input Parameters

string
Used for fetching next page. Cursor is returned in the response.
string
Search query to filter tests by name.
integer
How many Tests to return at maximum. Can not exceed 100, defaults to 30.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENREADER_LIST_AGENTSTool 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

string
Used for fetching next page. Cursor is returned in the response.
string
Search by agent name
string
The field to sort the results by
boolean
Filter agents by archived status. Set to true to show archived agents.
integer
How many agents to return at maximum. Cannot exceed 100, defaults to 30.
string ("asc" | "desc")
Sort direction for agent listing.
boolean
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENREADER_LIST_DUBSTool 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

string
Used for fetching next page. Cursor is returned in the response.
string
The field to use for ordering results from this query
integer
How many dubs to return at maximum. Cannot exceed 200, defaults to 100.
string ("dubbing" | "dubbed" | "failed")
Status of the dubbing process.
string ("DESCENDING" | "ASCENDING")
Order direction for results.
string ("personal" | "others" | "all")
Filter for who created the resources.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENREADER_LIST_KNOWLEDGE_BASESTool 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

string
If present, the endpoint will return only documents of the given types.
string
Used for fetching next page. Cursor is returned in the response.
string
If specified, the endpoint returns only such knowledge base documents whose names start with this string.
string
The field to sort the results by
integer
How many documents to return at maximum. Cannot exceed 100, defaults to 30.
boolean
Whether folders should be returned first in the list of documents.
string ("asc" | "desc")
Sort direction for knowledge base listing.
string
If set, the endpoint will return only documents that are direct children of the given folder.
string
If set, the endpoint will return only documents that are descendants of the given folder.
boolean
If set to true, the endpoint will return only documents owned by you (and not shared from somebody else).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENREADER_LIST_MCP_SERVERSTool 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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENREADER_LIST_PHONE_NUMBERSTool to list all phone numbers available in your ElevenLabs ConvAI workspace. Use when you need to retrieve configured phone numbers for agents.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENREADER_LIST_TEST_INVOCATIONSList paginated test invocation summaries for a specific conversational AI agent, including test run and pass/fail counts.

Input Parameters

string
Used for fetching next page. Cursor is returned in the response.
string
required
Filter by agent ID. This is required to retrieve test invocations for a specific agent.
integer
How many Tests to return at maximum. Can not exceed 100, defaults to 30.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENREADER_LIST_WHATSAPP_ACCOUNTSTool to list all WhatsApp accounts available in your ElevenLabs ConvAI workspace. Use when you need to retrieve configured WhatsApp accounts for agents.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENREADER_LIST_WORKSPACE_WEBHOOKSTool 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

boolean
Whether to include active usages of the webhook, only usable by admins

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENREADER_MOVE_KNOWLEDGE_BASE_ENTITIESTool 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

string
The ID of the folder to move the entities to. If not set, the entities will be moved to the root folder.
array
required
The IDs of documents or folders from the knowledge base to move. Must contain between 1 and 20 IDs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENREADER_MOVE_KNOWLEDGE_BASE_ENTITYTool 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

string
The folder to move the entities to. If not set, the entities will be moved to the root folder.
string
required
The id of a document from the knowledge base. This is returned on document addition.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENREADER_PATCH_AGENT_SETTINGSTool 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

string
A name to make the agent easier to find
array
Tags to help classify and filter the agent
string
required
The id of an agent. This is returned on agent creation.
object
Agent workflow configuration including nodes and edges defining the agent’s conversation flow
array
List of procedure refs used for this agent version
object
Platform settings for the agent are all settings that aren’t related to the conversation orchestration and content
object
Conversation configuration for an agent including agent, asr, conversation, tts, turn, and vad settings
string
Description for this version when publishing changes (only applicable for versioned agents)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENREADER_PATCH_PRONUNCIATION_DICTIONARYTool to update a pronunciation dictionary. Use when you need to modify the name or archive status of an existing pronunciation dictionary.

Input Parameters

string
The name of the pronunciation dictionary, used for identification only
boolean
Whether to archive the pronunciation dictionary
string
required
The ID of the pronunciation dictionary to update

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENREADER_POST_AGENT_AVATARTool 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

string
required
The id of an agent. This is returned on agent creation.
object
required
An image file to be used as the agent’s avatar.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENREADER_REGISTER_TWILIO_CALLTool 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

string
required
ID of the conversational AI agent to use for the call.
string ("inbound" | "outbound")
Direction of the call: inbound or outbound.
string
required
Phone number the call is to in E.164 format (e.g., +14155555678).
string
required
Phone number the call is from in E.164 format (e.g., +14155551234).
object
Client data for conversation initiation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENREADER_REMOVE_PRONUNCIATION_DICTIONARY_RULESTool 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

array
required
List of rule strings to remove from the pronunciation dictionary.
string
required
The ID of the pronunciation dictionary from which to remove rules.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENREADER_RESUBMIT_TESTSTool 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

string
required
Agent ID to resubmit tests for
string
ID of the branch to run the tests on. If not provided, the tests will be run on the agent default configuration.
array
required
List of test run IDs to resubmit. Must contain 1-200 test run IDs.
string
required
The id of a test invocation. This is returned when tests are run.
object
Configuration overrides to use for testing. If not provided, the agent’s default configuration will be used.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENREADER_RETRY_BATCH_CALLTool 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

string
required
The unique identifier of the batch call to retry

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENREADER_RUN_AGENT_TEST_SUITETool 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

array
required
List of tests to run on the agent. Must contain 1-200 tests.
string
required
The ID of the agent to run tests on. This is returned on agent creation.
string
ID of the branch to run the tests on. If not provided, the tests will be run on the agent default configuration.
object
Configuration overrides to use for testing. If not provided, the agent’s default configuration will be used.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENREADER_RUN_CONVERSATION_SIMULATIONSimulate a conversation between an agent and an AI user to test agent behavior, with options for simulated-user settings, conversation history, dynamic variables, tool mocks, and evaluation criteria. Set the new-turn limit to at most 100; the default of 10,000 exceeds the current API maximum. DEPRECATED: Use Create test and Run tests on the agent instead.

Input Parameters

string
required
The id of an agent. This is returned on agent creation.
integer
Maximum number of new turns to generate in the conversation simulation.
object
required
A specification that will be used to simulate a conversation between an agent and an AI user.
array
A list of evaluation criteria to test during the conversation simulation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENREADER_SIMULATE_CONVERSATION_STREAMSimulate a conversation with an AI agent to test its behavior, using configurable simulated-user settings, language, and conversation history. The streaming endpoint’s response is returned as collected text. Set the new-turn limit to at most 100; the default of 10,000 exceeds the current API maximum. DEPRECATED: Use Create test and Run tests on the agent instead.

Input Parameters

string
required
The ID of the agent to simulate a conversation with. This is returned on agent creation.
integer
Maximum number of new turns to generate in the conversation simulation.
object
required
A specification that will be used to simulate a conversation between an agent and an AI user.
array
A list of evaluation criteria to test during the conversation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENREADER_UPDATE_AGENT_RESPONSE_TESTTool 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

string
required
Name of the test. This field is required.
string
Type of the test (e.g., ‘response’, ‘tool_call’, ‘simulation’)
string
required
The ID of the test to update. This is returned on test creation.
array
List of chat messages to test the agent with
array
Examples of failure responses for response unit tests. Can be strings or objects with ‘response’ and ‘type’ fields
array
Examples of successful responses for response unit tests. Can be strings or objects with ‘response’ and ‘type’ fields
object
Dynamic variables to use in the test
string
Condition that defines success for the test
string
Scenario description for simulation tests
integer
Maximum number of turns for simulation tests
string
Parameters for tool call verification
string
Check if any tool matches the specified criteria
string
Metadata from the conversation

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENREADER_UPDATE_AUDIO_NATIVE_PROJECT_CONTENTUpdate an Audio Native project’s content using a TXT or HTML file, with optional automatic audio conversion and publication of the new snapshot.

Input Parameters

object
Either txt or HTML input file containing the article content. HTML should be formatted as follows ‘<html><body><div><p>Your content</p><h5>More of your content</h5><p>Some more of your content</p></div></body></html>’.
string
required
The ID of the Studio project.
boolean
Whether to auto convert the project to audio or not.
boolean
Whether to auto publish the new project snapshot after it’s converted.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENREADER_UPDATE_CONVAI_SETTINGSTool 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

object
Webhook configuration for ConvAI conversations.
boolean
Whether the workspace can use MCP servers
string ("standard" | "static")
Type of LiveKit stack to use.
integer
Number of days to retain RAG (Retrieval-Augmented Generation) data. Must be between 1 and 30 days.
object
Webhook configuration for conversation initiation client data.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENREADER_UPDATE_DASHBOARD_SETTINGS_ROUTETool 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

array
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENREADER_UPDATE_DOCUMENTTool to update a document in the ElevenLabs knowledge base. Use when you need to modify the name of an existing document.

Input Parameters

string
required
A custom, human-readable name for the document.
string
required
The id of a document from the knowledge base. This is returned on document addition.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENREADER_UPDATE_PHONE_NUMBERUpdate a phone number’s configuration in ElevenLabs ConvAI, including its label, assigned agent, or SIP trunk settings.

Input Parameters

string
A label to identify this phone number
string
The id of an agent to assign to this phone number. Set to null to unassign.
string
LiveKit stack type for this phone number. Only applicable for SIP trunk phone numbers.
string
required
The id of the phone number to update. This is returned when listing phone numbers.
object
Inbound SIP Trunk configuration.
object
Outbound SIP Trunk configuration.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENREADER_UPDATE_SECRET_ROUTEUpdate a ConvAI workspace secret by ID, supplying both its name and value.

Input Parameters

string
required
The updated name for the secret
string ("update")
Must be ‘update’ for PATCH requests
string
required
The updated value for the secret
string
required
The ID of the secret to update

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENREADER_UPDATE_TOOLTool to update a conversational AI tool configuration. Use when you need to modify tool settings like name, description, or API schema.

Input Parameters

string
required
ID of the tool to update.
object
required
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not