Elevenreader

elevenreader

ElevenReader is an AI-powered text-to-speech application by ElevenLabs that converts written content into natural-sounding audio

Artificial Intelligence Video & Audio Web del proveedor

Acciones

125

Triggers

Autenticación

—

OAuth gestionado

Información técnica: el detalle de parámetros, schemas y triggers de esta página está pensado para equipos de integración. Si solo necesitas saber si tu herramienta favorita está disponible, basta con ver la lista de acciones.

Acciones disponibles (125)

Cada acción es una operación que el agente puede ejecutar contra este conector. Haz clic en una acción para ver sus parámetros.

Add Documentation To Knowledge BaseELEVENREADER_ADD_DOCUMENTATION_TO_KNOWLEDGE_BASEAcción

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.

Parámetros de entrada

urlstring
URL to a page of documentation that the agent will have access to. Either file or url must be provided, but not both.
fileobject
Documentation file to upload. FileUploadable object where 'name' should be the filename (e.g., 'documentation.pdf'). Either file or url must be provided, but not both.
namestring
A custom, human-readable name for the document.
agent_idstring
The ID of the agent to add the documentation to.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Add Pronunciation Dictionary From FileELEVENREADER_ADD_PRONUNCIATION_DICTIONARY_FROM_FILEAcción

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.

Parámetros de entrada

fileobject
A lexicon .pls file which will be used to initialize the pronunciation dictionary. FileUploadable object where 'name' is the filename (e.g., 'pronunciations.pls').
namestringObligatorio
The name of the pronunciation dictionary, used for identification only.
descriptionstring
A description of the pronunciation dictionary, used for identification only.
workspace_accessstringenum
Workspace access level for the pronunciation dictionary.
admineditorviewer

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Add Pronunciation Dictionary From RulesELEVENREADER_ADD_PRONUNCIATION_DICTIONARY_FROM_RULESAcción

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).

Parámetros de entrada

namestringObligatorio
The name of the pronunciation dictionary, used for identification only.
rulesarrayObligatorio
List of pronunciation rules. Each rule can be either an alias rule (string replacement) or a phoneme rule (phonetic pronunciation).
descriptionstring
A description of the pronunciation dictionary, used for identification only.
workspace_accessstringenum
Workspace access level for the pronunciation dictionary.
admineditorviewer

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Add Pronunciation Dictionary RulesELEVENREADER_ADD_PRONUNCIATION_DICTIONARY_RULESAcción

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.

Parámetros de entrada

rulesarrayObligatorio
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_idstringObligatorio
The ID of the pronunciation dictionary to add rules to.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Add Shared VoiceELEVENREADER_ADD_SHARED_VOICEAcción

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.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Add ToolELEVENREADER_ADD_TOOLAcción

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.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Calculate Public LLM Expected CostELEVENREADER_CALCULATE_PUBLIC_LLM_EXPECTED_COSTAcción

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.

Parámetros de entrada

rag_enabledbooleanObligatorio
Whether RAG (Retrieval-Augmented Generation) is enabled
prompt_lengthintegerObligatorio
Length of the prompt in characters
number_of_pagesintegerObligatorio
Pages of content in PDF documents or URLs in the agent's knowledge base

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Cancel batch callELEVENREADER_CANCEL_BATCH_CALLAcción

Tool to cancel an active batch call operation. Use when you need to stop a scheduled or in-progress batch calling campaign.

Parámetros de entrada

batch_idstringObligatorio
The unique identifier of the batch call to cancel.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Compute RAG IndexELEVENREADER_COMPUTE_RAG_INDEXAcción

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.

Parámetros de entrada

modelstringObligatorioenum
Embedding model to use for RAG index computation.
e5_mistral_7b_instructmultilingual_e5_large_instruct
documentation_idstringObligatorio
The id of a document from the knowledge base. This is returned on document addition.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create AgentELEVENREADER_CREATE_AGENTAcción

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.

Parámetros de entrada

namestring
A name to make the agent easier to find.
tagsstring[]
Tags to help classify and filter the agent.
conversation_configobjectObligatorio
Configuration for the conversational agent including TTS, ASR, and agent behavior settings.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create Agent Response TestELEVENREADER_CREATE_AGENT_RESPONSE_TESTAcción

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.

Parámetros de entrada

namestringObligatorio
Name of the test
typestringObligatorioenum
Type of test to create: 'llm' for response tests, 'tool' for tool call tests, 'simulation' for simulation tests
llmtoolsimulation
chat_historyobject[]
List of chat messages representing the conversation history
failure_examplesobject[]
Examples of failed responses. Used for 'llm' test type
success_examplesobject[]
Examples of successful responses. Used for 'llm' test type
dynamic_variablesobject
Dynamic variables to use in the test
success_conditionstring
Condition that defines a successful test. Used for 'llm' and 'simulation' test types
simulation_scenariostring
Scenario to simulate in the test. Used for 'simulation' test type
simulation_max_turnsinteger
Maximum number of turns in the simulation. Used for 'simulation' test type
tool_call_parametersany
Parameters for the tool call. Used for 'tool_call' test type
check_any_tool_matchesany
Flag to check if any tool matches. Used for 'tool_call' test type
from_conversation_metadataany
Metadata from the conversation

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create Audio Native ProjectELEVENREADER_CREATE_AUDIO_NATIVE_PROJECTAcción

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.

Parámetros de entrada

fileobject
File to upload containing the article content (TXT or HTML). FileUploadable object where 'name' should be the filename (e.g., 'article.txt', 'content.html'). HTML should be formatted as '<html><body><div><p>Your content</p><h3>More content</h3></div></body></html>'.
namestringObligatorio
Project name for the Audio Native project.
imagestring
(Deprecated) Image URL used in the player. If not provided, default image set in the Player settings is used.
smallboolean
(Deprecated) Whether to use small player or not. If not provided, default value set in the Player settings is used.
titlestring
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.
authorstring
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_idstring
TTS Model ID used in the player. If not provided, default model ID set in the Player settings is used.
voice_idstring
Voice ID used to voice the content. If not provided, default voice ID set in the Player settings is used.
text_colorstring
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_convertboolean
Whether to automatically convert the project to audio after creation.
sessionizationinteger
(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_colorstring
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_normalizationstringenum
Text normalization modes for audio conversion.
autoonoffapply_english
pronunciation_dictionary_locatorsstring[]
List of pronunciation dictionary locators (pronunciation_dictionary_id, version_id) encoded as JSON strings for pronunciation dictionaries to be applied to the text.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create Batch CallELEVENREADER_CREATE_BATCH_CALLAcción

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.

Parámetros de entrada

agent_idstringObligatorio
ID of the conversational AI agent to use for the calls.
timezonestring
Timezone for the scheduled time (e.g., 'America/New_York', 'UTC').
call_namestringObligatorio
Name for the batch call campaign.
recipientsobject[]Obligatorio
List of recipients for the batch call. Maximum 10,000 recipients.
whatsapp_paramsobject
WhatsApp-specific parameters for batch calls.
scheduled_time_unixinteger
Unix timestamp for when to schedule the batch call. If not provided, calls start immediately.
agent_phone_number_idstring
ID of the phone number to use for making the calls.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create File DocumentELEVENREADER_CREATE_FILE_DOCUMENTAcción

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.

Parámetros de entrada

fileobjectObligatorio
Documentation file that the agent will have access to in order to interact with users. FileUploadable object where 'name' is the filename (e.g., 'document.txt', 'manual.pdf').
namestring
A custom, human-readable name for the document. If not provided, the filename will be used.
parent_folder_idstring
If set, the created document will be placed inside the given folder.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create FolderELEVENREADER_CREATE_FOLDERAcción

Tool to create a folder in the ElevenLabs knowledge base. Use when you need to organize documents into folders for better structure and management.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create Convai Workspace SecretELEVENREADER_CREATE_SECRETAcción

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.

Parámetros de entrada

namestringObligatorio
Name of the secret for identification purposes.
typestringObligatorioenum
Type of secret. Must be 'new' for creating a new secret.
new
valuestringObligatorio
The secret value to store securely.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create Text DocumentELEVENREADER_CREATE_TEXT_DOCUMENTAcción

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.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create URL DocumentELEVENREADER_CREATE_URL_DOCUMENTAcción

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.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete AgentELEVENREADER_DELETE_AGENTAcción

Tool to permanently delete an agent from ElevenLabs. Use when you need to remove an agent that is no longer needed.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete Batch CallELEVENREADER_DELETE_BATCH_CALLAcción

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"

Parámetros de entrada

batch_idstringObligatorio
The unique identifier of the batch call to delete

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete Agent Response TestELEVENREADER_DELETE_CHAT_RESPONSE_TESTAcción

Tool to delete an agent response test. Use when you need to remove a test that is no longer needed.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete ConversationELEVENREADER_DELETE_CONVERSATIONAcción

Tool to delete a conversation by its unique ID. Use when you need to permanently remove a conversation from the system.

Parámetros de entrada

conversation_idstringObligatorio
The id of the conversation you're taking the action on.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete DubbingELEVENREADER_DELETE_DUBBINGAcción

Tool to permanently delete a dubbing project by its ID. Use when you need to remove a dubbing project that is no longer needed.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete Knowledge Base DocumentELEVENREADER_DELETE_KNOWLEDGE_BASE_DOCUMENTAcción

Tool to permanently delete a document from the knowledge base. Use when you need to remove documentation that is no longer needed.

Parámetros de entrada

forceboolean
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_idstringObligatorio
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.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete Phone NumberELEVENREADER_DELETE_PHONE_NUMBERAcción

Tool to permanently delete a phone number from ElevenLabs ConvAI. Use when you need to remove a phone number that is no longer needed.

Parámetros de entrada

phone_number_idstringObligatorio
The id of a phone number. This is returned when listing phone numbers. WARNING: This permanently deletes the phone number and cannot be undone.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete RAG IndexELEVENREADER_DELETE_RAG_INDEXAcción

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.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete Convai Workspace SecretELEVENREADER_DELETE_SECRET_ROUTEAcción

Tool to delete a specific Convai workspace secret. Use when you need to permanently remove a secret by its ID.

Parámetros de entrada

secret_idstringObligatorio
The unique identifier of the secret to delete

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete Speech History ItemELEVENREADER_DELETE_SPEECH_HISTORY_ITEMAcción

Tool to permanently delete a speech history item by its ID. Use when you need to remove a specific history item from ElevenLabs.

Parámetros de entrada

history_item_idstringObligatorio
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.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete ToolELEVENREADER_DELETE_TOOL_ROUTEAcción

Tool to permanently delete a conversational AI tool from ElevenLabs. Use when you need to remove a tool that is no longer needed.

Parámetros de entrada

tool_idstringObligatorio
ID of the requested tool to be deleted.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete Transcript By IdELEVENREADER_DELETE_TRANSCRIPT_BY_IDAcción

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.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Download Speech History ItemsELEVENREADER_DOWNLOAD_SPEECH_HISTORY_ITEMSAcción

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.

Parámetros de entrada

output_formatstring
Output format to transcode the audio file. Must be 'wav' or None. If not specified or None, uses the original format.
history_item_idsstring[]Obligatorio
A list of history item IDs to download. You can get IDs of history items and other metadata using the List Speech History endpoint.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Duplicate AgentELEVENREADER_DUPLICATE_AGENTAcción

Tool to duplicate an existing agent. Use when you need to create a copy of an agent with all its configuration.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Edit VoiceELEVENREADER_EDIT_VOICEAcción

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.

Parámetros de entrada

namestringObligatorio
The name that identifies this voice. This will be displayed in the dropdown of the website.
filesobject[]
Audio files to add to the voice. List of FileUploadable objects where 'name' is the audio filename (e.g., 'sample1.mp3', 'voice_sample.wav').
labelsany
Labels for the voice. Can be a dictionary with keys like language, accent, gender, or age, or a JSON string.
voice_idstringObligatorio
Voice ID to be used, you can use https://api.elevenlabs.io/v1/voices to list all the available voices.
descriptionstring
A description of the voice.
remove_background_noiseboolean
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.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Edit Voice SettingsELEVENREADER_EDIT_VOICE_SETTINGSAcción

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.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Generate Composition PlanELEVENREADER_GENERATE_COMPOSITION_PLANAcción

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.

Parámetros de entrada

promptstringObligatorio
A simple text prompt to compose a plan from. Describe the desired music style, tempo, mood, and structure.
model_idstringenum
Model ID for music generation
music_v1
music_length_msinteger
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_planobject
Source composition plan structure

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get agentELEVENREADER_GET_AGENTAcción

Tool to retrieve complete details for a specific conversational AI agent by ID. Use when you need agent configuration, workflow, platform settings, or metadata.

Parámetros de entrada

agent_idstringObligatorio
The id of an agent. This is returned on agent creation.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Agent Knowledge Base SizeELEVENREADER_GET_AGENT_KNOWLEDGE_BASE_SIZEAcción

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.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Agent Shareable LinkELEVENREADER_GET_AGENT_LINKAcción

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.

Parámetros de entrada

agent_idstringObligatorio
The id of an agent. This is returned on agent creation.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Calculate Agent LLM Expected CostELEVENREADER_GET_AGENT_LLM_EXPECTED_COST_CALCULATIONAcción

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.

Parámetros de entrada

agent_idstringObligatorio
Unique identifier for the conversational AI agent
rag_enabledboolean
Whether RAG (Retrieval-Augmented Generation) is enabled
prompt_lengthinteger
Length of the prompt in characters
number_of_pagesinteger
Pages of content in pdf documents OR urls in agent's Knowledge Base

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Agent Response TestELEVENREADER_GET_AGENT_RESPONSE_TESTAcción

Tool to retrieve agent response test details by test ID. Use when you need to fetch test configuration and parameters.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Agent Response Tests SummariesELEVENREADER_GET_AGENT_RESPONSE_TESTS_SUMMARIESAcción

Tool to retrieve agent response test summaries by test IDs. Use when you need to fetch summary information for specific agent tests.

Parámetros de entrada

test_idsstring[]Obligatorio
List of test IDs to fetch. No duplicates allowed.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Agent SummariesELEVENREADER_GET_AGENT_SUMMARIESAcción

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.

Parámetros de entrada

agent_idsstring[]Obligatorio
List of agent IDs to fetch summaries for. Each agent ID should be a unique identifier.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Agent Widget ConfigELEVENREADER_GET_AGENT_WIDGET_ROUTEAcción

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.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Audio From History ItemELEVENREADER_GET_AUDIO_FULL_FROM_SPEECH_HISTORY_ITEMAcción

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.

Parámetros de entrada

history_item_idstringObligatorio
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.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Audio Native Project SettingsELEVENREADER_GET_AUDIO_NATIVE_PROJECT_SETTINGSAcción

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.

Parámetros de entrada

project_idstringObligatorio
The ID of the Studio project.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Batch Call By IdELEVENREADER_GET_BATCH_CALLAcción

Tool to retrieve a batch call by its ID. Use when you need to check the status and details of a specific batch call.

Parámetros de entrada

batch_idstringObligatorio
The unique identifier of the batch call to retrieve.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get conversation historyELEVENREADER_GET_CONVERSATION_HISTORYAcción

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.

Parámetros de entrada

conversation_idstringObligatorio
The id of the conversation you're taking the action on.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get ConversationsELEVENREADER_GET_CONVERSATIONSAcción

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.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Conversation Signed LinkELEVENREADER_GET_CONVERSATION_SIGNED_LINKAcción

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.

Parámetros de entrada

agent_idstringObligatorio
The id of the agent you're taking the action on.
branch_idstring
The ID of the branch to use
include_conversation_idboolean
Whether to include a conversation_id with the response. If included, the conversation_signature cannot be used again.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get ConvAI dashboard settingsELEVENREADER_GET_DASHBOARD_SETTINGS_ROUTEAcción

Tool to retrieve ConvAI dashboard settings including configured charts. Use when you need to view dashboard configuration or check which charts are enabled.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Documentation From Knowledge BaseELEVENREADER_GET_DOCUMENTATION_FROM_KNOWLEDGE_BASEAcción

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.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Dubbed FileELEVENREADER_GET_DUBBED_FILEAcción

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.

Parámetros de entrada

dubbing_idstringObligatorio
ID of the dubbing project.
language_codestringObligatorio
ID of the language for the dubbed file (e.g., 'es' for Spanish, 'fr' for French).

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Dubbing MetadataELEVENREADER_GET_DUBBED_METADATAAcción

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.

Parámetros de entrada

dubbing_idstringObligatorio
ID of the dubbing project.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Dubbed TranscriptELEVENREADER_GET_DUBBED_TRANSCRIPT_FILEAcción

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.

Parámetros de entrada

dubbing_idstringObligatorio
ID of the dubbing project.
format_typestringenum
Format type for the transcript output.
srtwebvttjson
language_codestringObligatorio
ISO-693 language code to retrieve the transcript for. Use 'source' to fetch the transcript of the original media.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Dubbing TranscriptsELEVENREADER_GET_DUBBING_TRANSCRIPTSAcción

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.

Parámetros de entrada

dubbing_idstringObligatorio
ID of the dubbing project.
format_typestringObligatorioenum
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.
srtwebvttjson
language_codestringObligatorio
ISO-639 language code to retrieve the transcript for. Use 'source' to fetch the transcript of the original media.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Generate Voice ParametersELEVENREADER_GET_GENERATE_VOICE_PARAMETERSAcción

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.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Knowledge Base ContentELEVENREADER_GET_KNOWLEDGE_BASE_CONTENTAcción

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.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Knowledge Base Dependent AgentsELEVENREADER_GET_KNOWLEDGE_BASE_DEPENDENT_AGENTSAcción

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.

Parámetros de entrada

cursorstring
Used for fetching next page. Cursor is returned in the response.
page_sizeinteger
How many documents to return at maximum. Cannot exceed 100, defaults to 30.
dependent_typestringenum
Type of dependent agents to return.
directtransitiveall
documentation_idstringObligatorio
The id of a document from the knowledge base. This is returned on document addition.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Knowledge Base Source File URLELEVENREADER_GET_KNOWLEDGE_BASE_SOURCE_FILE_URLAcción

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.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Knowledge Base SummariesELEVENREADER_GET_KNOWLEDGE_BASE_SUMMARIESAcción

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.

Parámetros de entrada

document_idsstring[]Obligatorio
List of knowledge base document IDs to fetch summaries for. Each document ID should be a unique identifier.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Library VoicesELEVENREADER_GET_LIBRARY_VOICESAcción

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.

Parámetros de entrada

agestring
Age used for filtering
pageinteger
Page number for pagination
sortstring
Sort criteria
accentstring
Accent used for filtering
genderstring
Gender used for filtering
localestring
Locale used for filtering
searchstring
Search term used for filtering
categorystringenum
Voice category for filtering shared voices.
professionalfamoushigh_quality
featuredboolean
Filter featured voices
languagestring
Language used for filtering
owner_idstring
Filter voices by public owner ID
page_sizeinteger
How many shared voices to return at maximum. Cannot exceed 100, defaults to 30.
use_casesstring
Use-case used for filtering
descriptivesstring
Descriptive terms used for filtering
reader_app_enabledboolean
Filter voices that are enabled for the reader app
include_custom_ratesstring
Include/exclude voices with custom rates
include_live_moderatedstring
Include/exclude voices that are live moderated
min_notice_period_daysstring
Filter voices with a minimum notice period of the given number of days

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Live CountELEVENREADER_GET_LIVE_COUNTAcción

Tool to retrieve the count of active ongoing conversations. Use when you need to monitor live conversation activity for analytics purposes.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get ModelsELEVENREADER_GET_MODELSAcción

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.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Or Create RAG IndexesELEVENREADER_GET_OR_CREATE_RAG_INDEXESAcción

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.

Parámetros de entrada

itemsobject[]Obligatorio
List of requested RAG indexes. Must contain at least 1 and at most 100 items.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get phone numberELEVENREADER_GET_PHONE_NUMBERAcción

Tool to retrieve details for a specific phone number by ID. Use when you need phone number configuration, provider settings, or assigned agent information.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Pronunciation DictionariesELEVENREADER_GET_PRONUNCIATION_DICTIONARIES_METADATAAcción

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.

Parámetros de entrada

sortstringenum
Field to sort pronunciation dictionaries by.
creation_time_unixname
cursorstring
Used for fetching next page. Cursor is returned in the response.
page_sizeinteger
How many pronunciation dictionaries to return at maximum. Cannot exceed 100, defaults to 30.
sort_directionstringenum
Direction to sort the results in.
ascendingdescending

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Pronunciation Dictionary MetadataELEVENREADER_GET_PRONUNCIATION_DICTIONARY_METADATAAcción

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.

Parámetros de entrada

pronunciation_dictionary_idstringObligatorio
The id of the pronunciation dictionary

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Pronunciation Dictionary Version PLSELEVENREADER_GET_PRONUNCIATION_DICTIONARY_VERSION_PLSAcción

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.

Parámetros de entrada

version_idstringObligatorio
The id of the pronunciation dictionary version
dictionary_idstringObligatorio
The id of the pronunciation dictionary

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get RAG IndexesELEVENREADER_GET_RAG_INDEXESAcción

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.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get RAG Index OverviewELEVENREADER_GET_RAG_INDEX_OVERVIEWAcción

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.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Resource MetadataELEVENREADER_GET_RESOURCE_METADATAAcción

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.

Parámetros de entrada

resource_idstringObligatorio
The ID of the target resource.
resource_typestringObligatorioenum
Resource type of the target resource.
voicevoice_collectionpronunciation_dictionarydubbingprojectconvai_agentsconvai_knowledge_base_documentsconvai_toolsconvai_settingsconvai_secretsworkspace_auth_connectionsconvai_phone_numbers+19

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get ConvAI workspace secretsELEVENREADER_GET_SECRETS_ROUTEAcción

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.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get ConvAI workspace settingsELEVENREADER_GET_SETTINGS_ROUTEAcción

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.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Signed URL (Deprecated)ELEVENREADER_GET_SIGNED_URL_DEPRECATEDAcción

Tool to get a signed URL for an agent conversation. Use when you need to generate a signed URL for agent interactions. Note: This endpoint is deprecated.

Parámetros de entrada

agent_idstringObligatorio
The id of the agent you're taking the action on.
branch_idstring
The ID of the branch to use
include_conversation_idboolean
Whether to include a conversation_id with the response. If included, the conversation_signature cannot be used again.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Similar Library VoicesELEVENREADER_GET_SIMILAR_LIBRARY_VOICESAcción

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.

Parámetros de entrada

top_kinteger
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_fileobjectObligatorio
Audio file to compare against library voices. FileUploadable object where 'name' is the audio filename (e.g., 'sample.wav', 'voice.mp3').
similarity_thresholdnumber
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.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Single Use TokenELEVENREADER_GET_SINGLE_USE_TOKENAcción

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.

Parámetros de entrada

token_typestringObligatorioenum
The type of token to create. Use 'realtime_scribe' for real-time transcription or 'tts_websocket' for text-to-speech websocket connections.
realtime_scribetts_websocket

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Speech HistoryELEVENREADER_GET_SPEECH_HISTORYAcción

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.

Parámetros de entrada

searchstring
Search term used for filtering
sourcestring
Source of the generated history item
model_idstring
Model ID to filter history items by.
voice_idstring
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_sizeinteger
How many history items to return at maximum. Cannot exceed 1000, defaults to 100.
sort_directionstringenum
Sort direction for history items.
ascdesc
date_after_unixstring
Unix timestamp to filter history items after this date (inclusive).
date_before_unixstring
Unix timestamp to filter history items before this date (exclusive).
start_after_history_item_idstring
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.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get speech history item by IDELEVENREADER_GET_SPEECH_HISTORY_ITEM_BY_IDAcción

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.

Parámetros de entrada

history_item_idstringObligatorio
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.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Test InvocationELEVENREADER_GET_TEST_INVOCATIONAcción

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.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get toolELEVENREADER_GET_TOOLAcción

Tool to retrieve complete details for a specific conversational AI tool by ID. Use when you need tool configuration, usage statistics, or access information.

Parámetros de entrada

tool_idstringObligatorio
ID of the requested tool.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Tool Dependent AgentsELEVENREADER_GET_TOOL_DEPENDENT_AGENTSAcción

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.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get ConvAI ToolsELEVENREADER_GET_TOOLS_ROUTEAcción

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.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Transcript By IDELEVENREADER_GET_TRANSCRIPT_BY_IDAcción

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.

Parámetros de entrada

transcription_idstringObligatorio
The unique ID of the transcript to retrieve

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Characters Usage MetricsELEVENREADER_GET_USAGE_CHARACTERSAcción

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.

Parámetros de entrada

metricstringenum
Metric type to aggregate.
creditstts_charactersminutes_usedrequest_countttfb_avgttfb_p95fiat_units_spentconcurrencyconcurrency_average
end_unixintegerObligatorio
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_unixintegerObligatorio
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_typestringenum
Type of breakdown for usage statistics.
nonevoicevoice_multiplierusergroupsapi_keysall_api_keysproduct_typemodelresourcerequest_queueregion+4
aggregation_intervalstringenum
Time interval for aggregating usage data.
hourdayweekmonthcumulative
aggregation_bucket_sizestring
Aggregation bucket size in seconds. Overrides the aggregation interval.
include_workspace_metricsboolean
Whether or not to include the statistics of the entire workspace.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get User InfoELEVENREADER_GET_USER_INFOAcción

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.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get User Subscription InfoELEVENREADER_GET_USER_SUBSCRIPTION_INFOAcción

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.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get User Voices V2ELEVENREADER_GET_USER_VOICES_V2Acción

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.

Parámetros de entrada

sortstringenum
Field to sort voices by.
created_at_unixname
searchstring
Search term to filter voices by. Searches in name, description, labels, category.
categorystringenum
Category of voice to filter by.
premadeclonedgeneratedprofessional
page_sizeinteger
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_idsstring
Voice IDs to lookup by. Maximum 100 voice IDs.
voice_typestringenum
Type of voice to filter by.
personalcommunitydefaultworkspacenon-defaultsaved
collection_idstring
Collection ID to filter voices by.
sort_directionstringenum
Sort direction for voice listing.
ascdesc
next_page_tokenstring
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_statestringenum
State of voice fine tuning.
draftnot_verifiednot_startedqueuedfine_tuningfine_tunedfaileddelayed
include_total_countboolean
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.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Voice by IDELEVENREADER_GET_VOICE_BY_IDAcción

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.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Voice SettingsELEVENREADER_GET_VOICE_SETTINGSAcción

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.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Default Voice SettingsELEVENREADER_GET_VOICE_SETTINGS_DEFAULTAcción

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.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Workspace Batch CallsELEVENREADER_GET_WORKSPACE_BATCH_CALLSAcción

Tool to get all batch calls for a workspace. Use when you need to retrieve a list of batch calls with pagination support.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Workspace Service AccountsELEVENREADER_GET_WORKSPACE_SERVICE_ACCOUNTSAcción

Tool to retrieve all service accounts in the workspace. Use when you need to list service accounts for workspace management or API key administration.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Handle SIP Trunk Outbound CallELEVENREADER_HANDLE_SIP_TRUNK_OUTBOUND_CALLAcción

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.

Parámetros de entrada

agent_idstringObligatorio
The ID of the conversational agent to use for this call.
to_numberstringObligatorio
The destination phone number to call in E.164 format (e.g., +14155551234).
agent_phone_number_idstringObligatorio
The ID of the agent's phone number to use for this outbound call.
conversation_initiation_client_dataobject
Client data for conversation initiation.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Import Phone NumberELEVENREADER_IMPORT_PHONE_NUMBERAcción

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.

Parámetros de entrada

sidstring
Twilio Account SID for authentication. Required for Twilio phone numbers.
labelstringObligatorio
A custom label to identify this phone number.
tokenstring
Twilio Auth Token for authentication. Required for Twilio phone numbers.
providerstring
Provider name (e.g., 'twilio', 'sip_trunk').
phone_numberstringObligatorio
The phone number to import in E.164 format (e.g., +14155552468).
region_configobject
Optional region-specific configuration for Twilio phone numbers.
supports_inboundboolean
Whether the phone number supports inbound calls.
supports_outboundboolean
Whether the phone number supports outbound calls.
inbound_trunk_configobject
Configuration for inbound SIP trunk. Used for SIP trunk phone numbers.
outbound_trunk_configobject
Configuration for outbound SIP trunk. Used for SIP trunk phone numbers.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Isolate Audio StreamELEVENREADER_ISOLATE_AUDIO_STREAMAcción

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.

Parámetros de entrada

audioobjectObligatorio
The audio file from which vocals/speech will be isolated. FileUploadable object where 'name' should be the audio filename (e.g., 'audio.wav', 'speech.mp3'). Minimum duration: 4.6 seconds.
file_formatstringenum
Audio file format options
pcm_s16le_16other

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List Agent BranchesELEVENREADER_LIST_AGENT_BRANCHESAcción

Tool to list all branches for a specific agent. Use when you need to retrieve branch information for an agent.

Parámetros de entrada

limitinteger
How many results at most should be returned
agent_idstringObligatorio
The id of an agent. This is returned on agent creation.
include_archivedboolean
Whether archived branches should be included

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List Agent Response TestsELEVENREADER_LIST_AGENT_RESPONSE_TESTSAcción

Tool to list agent response tests from ElevenLabs conversational AI. Use when you need to retrieve available tests for agent conversations or testing.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List AgentsELEVENREADER_LIST_AGENTSAcción

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.

Parámetros de entrada

cursorstring
Used for fetching next page. Cursor is returned in the response.
searchstring
Search by agent name
sort_bystring
The field to sort the results by
archivedboolean
Filter agents by archived status. Set to true to show archived agents.
page_sizeinteger
How many agents to return at maximum. Cannot exceed 100, defaults to 30.
sort_directionstringenum
Sort direction for agent listing.
ascdesc
show_only_owned_agentsboolean
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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List DubsELEVENREADER_LIST_DUBSAcción

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.

Parámetros de entrada

cursorstring
Used for fetching next page. Cursor is returned in the response.
order_bystring
The field to use for ordering results from this query
page_sizeinteger
How many dubs to return at maximum. Cannot exceed 200, defaults to 100.
dubbing_statusstringenum
Status of the dubbing process.
dubbingdubbedfailed
order_directionstringenum
Order direction for results.
DESCENDINGASCENDING
filter_by_creatorstringenum
Filter for who created the resources.
personalothersall

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List Knowledge BasesELEVENREADER_LIST_KNOWLEDGE_BASESAcción

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.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List MCP ServersELEVENREADER_LIST_MCP_SERVERSAcción

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.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List Phone NumbersELEVENREADER_LIST_PHONE_NUMBERSAcción

Tool to list all phone numbers available in your ElevenLabs ConvAI workspace. Use when you need to retrieve configured phone numbers for agents.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List Test InvocationsELEVENREADER_LIST_TEST_INVOCATIONSAcción

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.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List WhatsApp AccountsELEVENREADER_LIST_WHATSAPP_ACCOUNTSAcción

Tool to list all WhatsApp accounts available in your ElevenLabs ConvAI workspace. Use when you need to retrieve configured WhatsApp accounts for agents.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List Workspace WebhooksELEVENREADER_LIST_WORKSPACE_WEBHOOKSAcción

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.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Bulk Move Knowledge Base EntitiesELEVENREADER_MOVE_KNOWLEDGE_BASE_ENTITIESAcción

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.

Parámetros de entrada

move_tostring
The ID of the folder to move the entities to. If not set, the entities will be moved to the root folder.
document_idsstring[]Obligatorio
The IDs of documents or folders from the knowledge base to move. Must contain between 1 and 20 IDs.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Move Knowledge Base EntityELEVENREADER_MOVE_KNOWLEDGE_BASE_ENTITYAcción

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.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Patch Agent SettingsELEVENREADER_PATCH_AGENT_SETTINGSAcción

Tool to patch (partially update) an agent's settings. Use when you need to update specific fields of an agent without replacing all settings.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update Pronunciation DictionaryELEVENREADER_PATCH_PRONUNCIATION_DICTIONARYAcción

Tool to update a pronunciation dictionary. Use when you need to modify the name or archive status of an existing pronunciation dictionary.

Parámetros de entrada

namestring
The name of the pronunciation dictionary, used for identification only
archivedboolean
Whether to archive the pronunciation dictionary
pronunciation_dictionary_idstringObligatorio
The ID of the pronunciation dictionary to update

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Post Agent AvatarELEVENREADER_POST_AGENT_AVATARAcción

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.

Parámetros de entrada

agent_idstringObligatorio
The id of an agent. This is returned on agent creation.
avatar_fileobjectObligatorio
An image file to be used as the agent's avatar. FileUploadable object where 'name' is the image filename (e.g., 'avatar.png', 'profile.jpg').

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

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.

Parámetros de entrada

agent_idstringObligatorio
ID of the conversational AI agent to use for the call.
directionstringenum
Direction of the call: inbound or outbound.
inboundoutbound
to_numberstringObligatorio
Phone number the call is to in E.164 format (e.g., +14155555678).
from_numberstringObligatorio
Phone number the call is from in E.164 format (e.g., +14155551234).
conversation_initiation_client_dataobject
Client data for conversation initiation.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Remove Pronunciation Dictionary RulesELEVENREADER_REMOVE_PRONUNCIATION_DICTIONARY_RULESAcción

Tool to remove rules from a pronunciation dictionary. Use when you need to delete specific pronunciation rules from a dictionary by their rule strings.

Parámetros de entrada

rule_stringsstring[]Obligatorio
List of rule strings to remove from the pronunciation dictionary.
pronunciation_dictionary_idstringObligatorio
The ID of the pronunciation dictionary from which to remove rules.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Resubmit TestsELEVENREADER_RESUBMIT_TESTSAcción

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.

Parámetros de entrada

agent_idstringObligatorio
Agent ID to resubmit tests for
branch_idstring
ID of the branch to run the tests on. If not provided, the tests will be run on the agent default configuration.
test_run_idsstring[]Obligatorio
List of test run IDs to resubmit. Must contain 1-200 test run IDs.
test_invocation_idstringObligatorio
The id of a test invocation. This is returned when tests are run.
agent_config_overrideobject
Configuration overrides to use for testing. If not provided, the agent's default configuration will be used.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Retry batch callELEVENREADER_RETRY_BATCH_CALLAcción

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.

Parámetros de entrada

batch_idstringObligatorio
The unique identifier of the batch call to retry

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Run Agent Test SuiteELEVENREADER_RUN_AGENT_TEST_SUITEAcción

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.

Parámetros de entrada

testsobject[]Obligatorio
List of tests to run on the agent. Must contain 1-200 tests.
agent_idstringObligatorio
The ID of the agent to run tests on. This is returned on agent creation.
branch_idstring
ID of the branch to run the tests on. If not provided, the tests will be run on the agent default configuration.
agent_config_overrideobject
Configuration overrides to use for testing. If not provided, the agent's default configuration will be used.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Run Conversation SimulationELEVENREADER_RUN_CONVERSATION_SIMULATIONAcción

Tool to simulate a conversation between an agent and an AI user. Use when testing agent behavior in conversation scenarios.

Parámetros de entrada

agent_idstringObligatorio
The id of an agent. This is returned on agent creation.
new_turns_limitinteger
Maximum number of new turns to generate in the conversation simulation.
simulation_specificationobjectObligatorio
A specification that will be used to simulate a conversation between an agent and an AI user.
extra_evaluation_criteriastring[]
A list of evaluation criteria to test during the conversation simulation.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Simulate Conversation (Stream)ELEVENREADER_SIMULATE_CONVERSATION_STREAMAcción

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.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update Agent Response TestELEVENREADER_UPDATE_AGENT_RESPONSE_TESTAcción

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.

Parámetros de entrada

namestringObligatorio
Name of the test. This field is required.
typestring
Type of the test (e.g., 'response', 'tool_call', 'simulation')
test_idstringObligatorio
The ID of the test to update. This is returned on test creation.
chat_historyobject[]
List of chat messages to test the agent with
failure_examplesarray
Examples of failure responses for response unit tests. Can be strings or objects with 'response' and 'type' fields
success_examplesarray
Examples of successful responses for response unit tests. Can be strings or objects with 'response' and 'type' fields
dynamic_variablesobject
Dynamic variables to use in the test
success_conditionstring
Condition that defines success for the test
simulation_scenariostring
Scenario description for simulation tests
simulation_max_turnsinteger
Maximum number of turns for simulation tests
tool_call_parametersany
Parameters for tool call verification
check_any_tool_matchesany
Check if any tool matches the specified criteria
from_conversation_metadataany
Metadata from the conversation

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update Audio Native Project ContentELEVENREADER_UPDATE_AUDIO_NATIVE_PROJECT_CONTENTAcción

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.

Parámetros de entrada

fileobject
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>'. FileUploadable object where 'name' is the filename.
project_idstringObligatorio
The ID of the Studio project.
auto_convertboolean
Whether to auto convert the project to audio or not.
auto_publishboolean
Whether to auto publish the new project snapshot after it's converted.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update ConvAI SettingsELEVENREADER_UPDATE_CONVAI_SETTINGSAcción

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.

Parámetros de entrada

webhooksobject
Webhook configuration for ConvAI conversations.
can_use_mcp_serversboolean
Whether the workspace can use MCP servers
default_livekit_stackstringenum
Type of LiveKit stack to use.
standardstatic
rag_retention_period_daysinteger
Number of days to retain RAG (Retrieval-Augmented Generation) data. Must be between 1 and 30 days.
conversation_initiation_client_data_webhookobject
Webhook configuration for conversation initiation client data.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update ConvAI dashboard settingsELEVENREADER_UPDATE_DASHBOARD_SETTINGS_ROUTEAcción

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.

Parámetros de entrada

chartsarray
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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update DocumentELEVENREADER_UPDATE_DOCUMENTAcción

Tool to update a document in the ElevenLabs knowledge base. Use when you need to modify the name of an existing document.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update Phone NumberELEVENREADER_UPDATE_PHONE_NUMBERAcción

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.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update Convai Workspace SecretELEVENREADER_UPDATE_SECRET_ROUTEAcción

Tool to update a Convai workspace secret by ID. Use when you need to modify the name or value of an existing secret.

Parámetros de entrada

namestringObligatorio
The updated name for the secret
typestringenum
Must be 'update' for PATCH requests
update
valuestringObligatorio
The updated value for the secret
secret_idstringObligatorio
The ID of the secret to update

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update ToolELEVENREADER_UPDATE_TOOLAcción

Tool to update a conversational AI tool configuration. Use when you need to modify tool settings like name, description, or API schema.

Parámetros de entrada

tool_idstringObligatorio
ID of the tool to update.
tool_configobjectObligatorio
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.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not