Skip to main content
ElevenLabs logo
  • Category: audio & speech
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 396
  • Triggers: 0
  • Slug: ELEVENLABS
  • Version: 20261101_00
  • Instant: Supported on the latest version. Support varies by tool.

Tools

Slug: ELEVENLABS_ADD_A_PRONUNCIATION_DICTIONARYAdds a new pronunciation dictionary from a lexicon file to improve speech synthesis accuracy.

Input Parameters

object
A lexicon file (typically .pls XML) containing pronunciation rules.
string
A descriptive name for the pronunciation dictionary.
string
Optional detailed description of the pronunciation dictionary and its purpose.
string ("admin" | "editor" | "viewer")
Access level for the pronunciation dictionary within the workspace (admin, editor, or viewer).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_ADD_GROUP_MEMBERAdd an existing workspace member to a group by email. Requires group_members_manage permission and your own ElevenLabs connection.

Input Parameters

string
required
The email of the target workspace member.
string
required
The ID of the target group.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_ADD_OUTBOUND_PHONE_NUMBERTool to import/register a Twilio phone number or SIP trunk into ElevenLabs Agents Platform. Use when you need to provision a phone number for outbound calls and ELEVENLABS_GET_AGENT_DETAILS returns empty phone_numbers. This does NOT purchase a new number; it imports an existing provider configuration into your ElevenLabs workspace.

Input Parameters

string
Twilio Account SID (required when provider is ‘twilio’)
string
required
Descriptive label for the phone number
string
Twilio Auth Token (required when provider is ‘twilio’)
string
required
Provider type: ‘twilio’ or ‘sip_trunk’
string
required
Phone number to import in E.164 format
object
Region configuration for Twilio phone number.
boolean
Enable inbound call capability for this number
boolean
Enable outbound call capability for this number
object
Inbound configuration for SIP trunk.
object
Outbound configuration for SIP trunk.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_ADD_PROJECTUse to create a new ElevenLabs project for text-to-speech synthesis (e.g., audiobooks); a project name is required by the API for creation, and content can be initialized using from_url or from_document.

Input Parameters

string
A unique name for the project, crucial for its identification and management.
string
Optional title for the project, distinct from name (e.g., for a book title).
string
Optional author for the project (e.g., for a book).
string
URL to extract content for initializing the project. Use instead of from_document.
string
Optional ISBN for the project, typically for audiobooks.
string
Optional URL for a POST request with project conversion status updates.
object
Document file (e.g..txt.epub.pdf) to upload for initializing project content. Use instead of from_url.
string ("standard" | "high" | "ultra" | "ultra_lossless")
Output quality of generated audio.
string
Model ID for synthesis (e.g., ‘eleven_multilingual_v2’; see GET /v1/models); uses default model if unspecified.
boolean
Apply general volume normalization to audio output.
string
Voice ID for titles (see GET /v1/voices); uses ElevenLabs default if unspecified.
boolean
Apply ACX (Audiobook Creation Exchange) volume normalization to audio output.
string
Voice ID for paragraphs (see GET /v1/voices); uses ElevenLabs default if unspecified.
array
List of pronunciation dictionary locators (format: ‘dictionary_id@version_id’) for custom pronunciations.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_ADD_PRONUNCIATION_DICTIONARY_FROM_RULESTool to create a new pronunciation dictionary from provided rules for ElevenLabs text-to-speech. Use when you need to define custom pronunciations for specific words or phrases to improve speech accuracy. Supports both alias rules (simple text replacements) and phoneme rules (IPA phonetic notation).

Input Parameters

string
required
The name of the pronunciation dictionary, used for identification only
array
required
List of pronunciation rules defining text replacements. Each rule can be either an alias rule (simple text replacement) or a phoneme rule (phonetic pronunciation using IPA or other alphabet). Minimum 1 rule required.
string
A description of the pronunciation dictionary, used for identification only
string ("admin" | "editor" | "viewer")
Valid workspace access levels for pronunciation dictionaries.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_ADD_RULES_TO_THE_PRONUNCIATION_DICTIONARYAdds one or more custom pronunciation rules (alias or phoneme) to an existing pronunciation dictionary.

Input Parameters

array
required
List of pronunciation rule objects, each defining an ‘alias’ or ‘phoneme’ transformation for a specific string. - Alias Rule: Use type: "alias", string_to_replace, and alias (replacement text). Example: {"type": "alias", "string_to_replace": "ASAP", "alias": "as soon as possible"}. - Phoneme Rule: Use type: "phoneme", string_to_replace, phoneme (phonetic transcription), and alphabet (e.g., ‘ipa’). Example: {"type": "phoneme", "string_to_replace": "gnocchi", "phoneme": "ˈɲɔkki", "alphabet": "ipa"}.
string
required
Identifier of an existing pronunciation dictionary to which rules will be added.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_ADD_SHARING_VOICEAdds an existing, shareable voice to a specified user’s ElevenLabs account library under a new custom name, requiring the user’s public ID and the voice ID.

Input Parameters

string
required
Name to assign the shared voice in the user’s library, displayed on the ElevenLabs website.
string
required
Unique identifier of the shared voice to be added.
string
required
Public user ID of the ElevenLabs user to whom the shared voice will be added.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_ADD_TRANSCRIPT_SEGMENTAdd a source transcript segment to an Enterprise dubbing project. The span must lie within the source media, last 0.1–25 seconds, and not overlap another segment by the same speaker. Bumps the revision, discards affected translations in every target language, and marks completed targets stale. Audio changes only after regenerating a target. Requires your own ElevenLabs connection.

Input Parameters

string
required
The text of the new segment.
number
required
End time of the segment, in seconds.
number
required
Start time of the segment, in seconds.
string
required
Identifier of the dubbing project.
string
required
Identifier of the segment’s speaker.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_ADD_VOICEAdds a custom voice by uploading audio samples for voice cloning. Requires a name and at least one audio file. Recommended: 1-2 minutes of clear audio without background noise. Supported formats: mp3, wav, ogg. Returns a voice_id that can be used for text-to-speech after processing completes.

Input Parameters

string
required
Name for the new voice, used as its identifier in the platform.
array
required
List of audio files for voice cloning. Each file should be a Supported formats: mp3, wav, ogg. At least one file is required, and 1-2 minutes of clear audio without background noise is recommended.
string
Optional stringified JSON object of key-value pairs for categorizing the voice. Example: {“accent”: “American”, “style”: “narration”}
string
Optional description for the voice, detailing its characteristics or intended use cases.
boolean
If set to true, will remove background noise from voice samples using the audio isolation model. Only use if samples contain background noise; using it on clean audio can reduce quality.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_ADD_VOICE_SAMPLESAdd audio samples to an existing professional voice clone (PVC). Requires your own ElevenLabs connection. Returns the added sample metadata.

Input Parameters

array
required
Audio files used to create the voice.
string
required
ID of the professional voice clone to add samples to.
boolean
Remove background noise using audio isolation. May reduce quality when samples have no background noise.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_ADD_VOICE_TO_COLLECTIONAdd a voice to a collection you can edit. Adding an existing member succeeds without changes. Requires your own ElevenLabs connection.

Input Parameters

string
required
Voice ID to add. Use the list voices endpoint to find available voices.
string
required
Collection ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_ALIGN_AUDIO_AND_TRANSCRIPTAlign an audio file to a supplied transcript and return character and word timestamps with alignment loss scores. Diarization is not supported. Requires your own ElevenLabs connection.

Input Parameters

object
required
The file to align. All major audio formats are supported. The file size must be less than 1GB.
string
required
The text to align with the audio. The input text can be in any format, however diarization is not supported at this time.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_APPROVE_MCP_TOOLAdd approval for a specific MCP tool when using per-tool approval mode. Requires your own ElevenLabs connection; returns the updated server configuration.

Input Parameters

string
required
The name of the MCP tool.
object
Original input schema on the MCP server, before ElevenLabs processing. Omit to use the provider default.
string
required
ID of the MCP Server.
string ("auto_approved" | "requires_approval")
Tool-level approval policy.
string
required
The description of the MCP tool.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_ASSIGN_CONVERSATION_TAGSAssign 1–50 existing workspace tags to a conversation. Already assigned tags are ignored. Requires your own ElevenLabs connection.

Input Parameters

array
required
Tag IDs to add. Tags must belong to the same workspace; already assigned tags are ignored.
string
required
ID of the conversation to tag.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_ATTACH_PHONE_NUMBER_TO_AGENTAssign or unassign an imported phone number to a Conversational AI agent. Omitting the agent ID sends a null assignment, unassigning the number.

Input Parameters

string
Descriptive label for the phone number
string
ID of the agent to assign to the phone number. Set to null to unassign the phone number from any agent.
string ("standard" | "static")
Type of LiveKit stack to use
string
required
The unique identifier of the phone number to update

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_BULK_DELETE_DOCUMENTSDelete 1–20 knowledge-base documents or folders, with independent outcomes per ID. Force also removes agent references and recursively deletes folder contents. Requires your own ElevenLabs connection.

Input Parameters

boolean
Delete even when used by agents, removing the resources from dependent agents. For non-empty folders, also delete all child documents and folders.
array
required
Unique IDs of 1–20 documents or folders from the knowledge base.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_CALCULATE_CONVAI_AGENT_LLM_USAGEEstimate LLM costs for a conversational AI agent based on knowledge base size, prompt length, and RAG configuration. Returns model pricing per minute.

Input Parameters

string
required
Unique identifier for the agent
boolean
Whether RAG is enabled
integer
Length of the prompt in characters
integer
Pages of content in pdf documents OR urls in agent’s Knowledge Base

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_CALCULATE_CONVAI_LLM_USAGETool to calculate expected LLM usage costs for conversational AI agents. Use when you need to estimate pricing for different LLM models based on prompt length, knowledge base size, and RAG configuration.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_CANCEL_CONVAI_BATCH_CALLTool to cancel a running batch call and set all recipients to cancelled status. Use when you need to stop an ongoing batch calling campaign.

Input Parameters

string
required
Unique identifier of the batch call to cancel

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_CANCEL_CRAWL_JOBCancel a crawl job and delete all associated documents and folders. Requires your own ElevenLabs connection.

Input Parameters

string
required
The ID of the crawl job to cancel.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_CANCEL_TEST_INVOCATIONCancel all pending runs in a test invocation using its ID from a test run. Requires your own ElevenLabs connection.

Input Parameters

string
required
The ID of a test invocation, returned when tests are run.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_COMMENT_ON_TICKETAppend a resolution comment to a ticket and return the updated ticket. Requires viewer access to the ticket’s agent and your own ElevenLabs connection.

Input Parameters

string
required
A comment discussing how to resolve the ticket.
string
required
ID of the ticket to comment on.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_COMMENT_ON_TURNAppend a comment about a transcript turn to a triage ticket and return the updated ticket. Requires viewer access to the ticket’s agent and your own ElevenLabs connection.

Input Parameters

string
required
What went wrong at this turn.
integer
required
Zero-based index of the transcript turn this comment refers to.
string
required
ID of the triage ticket to comment on.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_COMPOSE_MUSICCompose a song from a prompt or composition plan and return audio plus its song ID. Requires your own ElevenLabs connection.

Input Parameters

integer
Random generation seed; cannot be combined with prompt. Exact reproducibility is not guaranteed.
string
Text prompt; cannot be combined with composition_plan.
string ("music_v1" | "music_v2" | "music_v2_5")
Music generation model.
string
Finetune ID to use for generation.
string
Lyrics text for generation.
object
Deprecated music prompt; use composition_plan instead.
string ("auto" | "mp3_48000_128" | "mp3_48000_192" | "mp3_48000_240" | "mp3_48000_320" | "mp3_22050_32" | "mp3_24000_48" | "mp3_44100_32" | "mp3_44100_64" | "mp3_44100_96" | "mp3_44100_128" | "mp3_44100_192" | "pcm_8000" | "pcm_16000" | "pcm_22050" | "pcm_24000" | "pcm_32000" | "pcm_44100" | "pcm_48000" | "ulaw_8000" | "alaw_8000" | "opus_48000_32" | "opus_48000_64" | "opus_48000_96" | "opus_48000_128" | "opus_48000_192")
Audio codec_sample_rate_bitrate. Auto selects mp3_44100_128 for v1 and mp3_48000_192 for v2.
boolean
Disable for enterprise-only zero retention mode.
boolean
Sign the generated song with C2PA; MP3 files only.
string ("track" | "loop" | "ambience" | "video_to_music")
Generation mode hint; only usable with prompt.
integer
Song length in milliseconds; only with prompt. If omitted the model chooses a length.
string
Detailed plan; MusicPrompt for music_v1, CompositionPlan for music_v2/music_v2_5. Cannot be combined with prompt.
number
Finetune influence, meaningful only with finetune_id.
boolean
Guarantee instrumental output; only usable with prompt.
boolean
Phonetically spell proper names in lyrics and restore originals in word timestamps.
boolean
Store the generated song for inpainting.
boolean
Enforce music_v1 composition section durations. Ignored for v2/v2_5, which always enforce durations.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_COMPOSE_MUSIC_WITH_METADATACompose music from a prompt or composition plan and return downloadable audio plus structured song metadata. Optional word timestamps and waveform preview. Requires your own ElevenLabs connection.

Input Parameters

integer
Random seed, cannot be combined with prompt. Reproducibility is not guaranteed.
string
Text prompt; cannot be combined with composition_plan or seed.
string ("music_v1" | "music_v2" | "music_v2_5")
Music generation model.
string
Finetune ID to use for generation.
string
Lyrics text to use for generation.
object
Deprecated music prompt; use composition_plan instead.
string ("auto" | "mp3_48000_128" | "mp3_48000_192" | "mp3_48000_240" | "mp3_48000_320" | "mp3_22050_32" | "mp3_24000_48" | "mp3_44100_32" | "mp3_44100_64" | "mp3_44100_96" | "mp3_44100_128" | "mp3_44100_192" | "pcm_8000" | "pcm_16000" | "pcm_22050" | "pcm_24000" | "pcm_32000" | "pcm_44100" | "pcm_48000" | "ulaw_8000" | "alaw_8000" | "opus_48000_32" | "opus_48000_64" | "opus_48000_96" | "opus_48000_128" | "opus_48000_192")
Audio codec_sample_rate_bitrate. Auto chooses mp3_44100_128 for v1 and mp3_48000_192 for v2.
boolean
False enables enterprise-only zero retention mode.
boolean
Sign with C2PA; applicable only to MP3 files.
string ("track" | "loop" | "ambience" | "video_to_music")
Generation mode hint; only with prompt.
integer
Song length in milliseconds, only with prompt; omitted lets the model choose.
boolean
Return word timestamps.
string
Detailed plan, mutually exclusive with prompt. MusicPrompt is for music_v1; CompositionPlan for music_v2/music_v2_5.
number
Finetune influence; only meaningful with finetune_id.
boolean
Guarantee instrumental output; only with prompt.
string ("music" | "sfx")
Model style prefix.
boolean
Phonetically spell proper names for pronunciation; restore originals in timestamps.
boolean
Store the generated song for inpainting.
boolean
Return a waveform preview.
boolean
Enforce music_v1 plan section durations. False permits adjustments preserving total length; ignored for v2, which always enforces durations.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_COMPUTE_DOCUMENT_RAG_INDEXTrigger RAG indexing for a knowledge-base document, or return its current status if already indexed. Requires your own ElevenLabs connection.

Input Parameters

string ("e5_mistral_7b_instruct" | "multilingual_e5_large_instruct")
required
Embedding model to index the document with.
string
required
Knowledge-base document ID returned when the document was added.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_CONVERT_CHAPTERConverts the textual content of a chapter, identified by chapter_id within a project_id, into audio format.

Input Parameters

string
required
Identifier of the chapter to be converted.
string
required
Identifier of the project containing the chapter to be converted.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_CONVERT_PROJECTConverts an existing ElevenLabs Studio project, including all its chapters and using its configured settings and voices, into speech.

Input Parameters

string
required
Identifier of the project to convert; find available IDs via the GET /v1/studio/projects endpoint.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_CONVERT_VOICETransform audio into a target voice while preserving emotion, timing and delivery. Upload the source audio and choose a target voice ID. Requires your own ElevenLabs connection.

Input Parameters

integer
Best-effort deterministic sampling seed between 0 and 4294967295; determinism is not guaranteed.
object
required
Audio file whose content and emotion control the generated speech.
string
Model ID supporting can_do_voice_conversion; discover models with GET /v1/models.
string
required
Target voice ID; list available voices with GET /v1/voices.
string ("pcm_s16le_16" | "other")
Input format. pcm_s16le_16 requires 16-bit mono little-endian PCM at 16kHz; other accepts encoded audio.
string ("alaw_8000" | "mp3_22050_32" | "mp3_24000_48" | "mp3_44100_128" | "mp3_44100_192" | "mp3_44100_32" | "mp3_44100_64" | "mp3_44100_96" | "opus_48000_128" | "opus_48000_192" | "opus_48000_32" | "opus_48000_64" | "opus_48000_96" | "pcm_16000" | "pcm_22050" | "pcm_24000" | "pcm_32000" | "pcm_44100" | "pcm_48000" | "pcm_8000" | "ulaw_8000" | "wav_16000" | "wav_22050" | "wav_24000" | "wav_32000" | "wav_44100" | "wav_48000" | "wav_8000")
Output codec_sample_rate_bitrate. MP3 192kbps needs Creator or above; PCM/WAV 44.1kHz needs Pro or above.
boolean
Enable request logging. False selects enterprise-only zero retention and disables history and stitching.
string
JSON-encoded voice settings overriding stored settings for this request only.
boolean
Remove background noise using the audio isolation model.
integer
Deprecated latency optimization level, 0 (default) through 4 (maximum, disables text normalization).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_CREATE_AGENT_BRANCHCreate an ElevenLabs agent branch from an existing agent version.

Input Parameters

string
required
Branch name, unique within the agent.
string
required
Agent ID.
object
Updated workflow with typed edges and discriminated node variants.
string
required
Branch description.
boolean
Whether to use the caller’s draft procedure set instead of the branch tip. The parent version must be the branch tip when enabled.
string
required
ID of the version to branch from.
object
Changes to apply to platform settings.
object
Changes to apply to the conversation configuration.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_CREATE_AGENT_BRANCH_PROCEDURECreate a procedure in an ElevenLabs agent branch draft working set.

Input Parameters

string
Procedure name.
string
Initial procedure content.
string
Optional text describing when the agent uses the procedure.
string
required
Agent ID.
string
required
Agent branch ID.
string ("free_form" | "deterministic" | "folder")
Procedure type.
string
Parent folder procedure ID, or null for the root.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_CREATE_AGENT_DRAFTCreate a new draft for an existing agent branch with conversation config, platform settings, workflow, name and optional tags. Requires your own ElevenLabs connection.

Input Parameters

string
required
Name for the draft.
array
Tags to help classify and filter the agent; may be null.
string
required
The ID returned when the agent was created.
object
required
Workflow for the draft.
string
required
The ID of the agent branch to use.
object
required
Platform settings for the draft.
object
required
Conversation config for the draft.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_CREATE_AGENT_TICKETRaise a manual follow-up ticket against an agent, without a conversation. Requires viewer access to the agent and your own ElevenLabs connection. When title is omitted it is derived from qa_comment.

Input Parameters

string
One-line headline; when omitted, derived from qa_comment.
string
required
Agent to raise the follow-up ticket against.
string ("low" | "medium" | "high" | "urgent")
How urgently the ticket needs attention.
string
required
What the ticket is about, e.g. a follow-up task for the agent.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_CREATE_A_PREVIOUSLY_GENERATED_VOICEFinalizes the creation of a voice using its generated_voice_id from a previous generation step by assigning a name, description, and optional labels.

Input Parameters

object
Key-value metadata to associate with the voice.
string
required
Name for the newly created voice.
string
required
Detailed description for the newly created voice, its characteristics, or intended use.
string
required
Identifier of a previously generated voice (e.g., from POST /v1/voice-generation/generate-voice), used to finalize its creation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_CREATE_ASYNC_SPEECH_GENERATIONQueue speech synthesis with Flash v2.5, Multilingual v2 or Eleven v3. Returns a pending generation ID for polling via the corresponding GET endpoint; optional flows webhooks deliver completion or failure. Charged per character by ElevenLabs. Requires your own ElevenLabs connection.

Input Parameters

string
required
Speech generation options for the selected model.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_CREATE_CHAPTERCreate a blank Studio chapter or initialize it from a URL in an existing project. Requires your own ElevenLabs connection.

Input Parameters

string
required
The chapter name, used for identification only.
string
Optional URL from which to extract chapter content. Omit or pass null to create a blank chapter.
string
required
The ID of the Studio project.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_CREATE_CONVAI_AGENT_TESTINGCreate a Conversational AI agent test for response validation, tool execution verification, or conversation simulation. The accepted test types are ‘llm’, ‘tool’, and ‘simulation’.

Input Parameters

string
required
Name for the test case to identify it later
string ("llm" | "tool" | "simulation")
required
Type of test to create: ‘llm’ for response testing, ‘tool’ for tool execution testing, or ‘simulation’ for conversation simulation testing
array
Array of messages representing the conversation history to test against. Each message must include role (‘user’ or ‘agent’), time_in_call_secs (float), and optional message text content.
array
Examples of failed or incorrect agent responses for LLM tests
array
Examples of successful agent responses for LLM tests
object
Key-value pairs of variables to be dynamically injected into the test context
string
Required for ‘llm’ and ‘simulation’ types. Natural language description of what constitutes a successful agent response
string
Required for ‘simulation’ type. Natural language description of the scenario to simulate in the conversation
integer
For ‘simulation’ type tests: Maximum number of conversation turns to simulate
string
For ‘tool_call’ type tests: Expected parameters for the tool that should be called by the agent
string
For ‘tool_call’ type tests: Whether to check if any tool matches the expected call pattern
string
Metadata from a previous conversation to use as context for this test

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_CREATE_CONVAI_KNOWLEDGE_BASEDeprecated by the provider; no sunset date is announced. Add documentation to ElevenLabs Conversational AI knowledge base by uploading a file or referencing a webpage URL. Use when you need to provide reference materials or documentation that agents can access during conversations. Exactly one of ‘file’ or ‘url’ must be specified.

Input Parameters

string
URL to a documentation webpage that the agent will have access to. Either ‘file’ or ‘url’ must be provided, but not both.
object
Documentation file to upload. Supported formats: PDF, TXT, DOC, DOCX. Either ‘file’ or ‘url’ must be provided, but not both.
string
Custom, human-readable name for the document in the knowledge base
string
Specific agent ID to associate this knowledge base document with

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_CREATE_CONVAI_KNOWLEDGE_BASE_FILECreate a knowledge base document from an uploaded file for ElevenLabs Conversational AI agents, optionally naming it or placing it in a folder.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_CREATE_CONVAI_KNOWLEDGE_BASE_FOLDERTool to create a folder in the ElevenLabs ConvAI knowledge base for organizing documents. Use when you need to group related documents together in a hierarchical structure.

Input Parameters

string
required
A custom, human-readable name for the folder
string
If set, the created folder will be placed inside the given parent folder. Leave empty to create at root level.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_CREATE_CONVAI_KNOWLEDGE_BASE_RAG_INDEXRetrieve or request creation of RAG indexes for up to 100 knowledge base documents in a batch. Each item specifies an embedding model and whether to create an index if missing; results are returned per document.

Input Parameters

array
required
List of requested RAG indexes to create or retrieve (1-100 items)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_CREATE_CONVAI_KNOWLEDGE_BASE_TEXTTool to create a knowledge base document with text content in ElevenLabs Conversational AI. Use when you need to add text-based information to the knowledge base for agent reference.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_CREATE_CONVAI_KNOWLEDGE_BASE_URLTool to create a knowledge base document by scraping the given webpage. Use when you need to add a web page as a knowledge source for a conversational AI agent.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_CREATE_CONVAI_SECRETTool to create a new secret for the ElevenLabs ConvAI workspace. Use when you need to securely store API keys, tokens, or other sensitive values that your conversational AI agents can reference.

Input Parameters

string
required
Name identifier for the secret. Must be unique within the workspace.
string ("new")
required
Type of secret to create. Currently only ‘new’ is supported by the API.
string
required
The secret value to store securely in the workspace.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_CREATE_CONVAI_TOOLTool to create a new conversational AI tool in ElevenLabs workspace. Use when adding custom tools for agents to execute during conversations. Supports webhook (external HTTP APIs), client (client-side execution), system (built-in), and MCP (Model Context Protocol) tool types.

Input Parameters

string
required
Tool name. Must match pattern ^[a-zA-Z0-9_-]{1,64}$ (alphanumeric, hyphens, underscores only, no spaces, 1-64 characters)
object
System tool parameters (required for system tools)
string ("webhook" | "client" | "system" | "mcp")
required
Type of tool to create: ‘webhook’ for HTTP endpoints, ‘client’ for client-side execution, ‘system’ for built-in tools, or ‘mcp’ for MCP integration
object
API schema configuration (required for webhook tools). Should include endpoint URL and HTTP method details
object
Tool parameters schema (for client and MCP tools)
array
Tool assignments for routing to specific conversations
string
required
Tool description explaining what it does
string
MCP server ID (required for MCP tools)
string
MCP tool name (required for MCP tools)
string ("immediate" | "post_tool_speech" | "async")
Execution mode for the tool.
string ("always" | "never" | "ask")
MCP approval policy.
string
MCP server name (required for MCP tools)
string
Sound to play during tool call
boolean
Whether the client tool expects a response (for client tools)
string ("mcp")
Integration type for MCP tools.
object
MCP input schema (for MCP tools)
object
Dynamic variables configuration (for webhook and client tools)
string
MCP tool description (required for MCP tools)
boolean
Whether to disable interruptions during tool execution
boolean
Force speech before tool execution
integer
Response timeout in seconds
string ("auto" | "always")
Sound behavior during tool calls.
string ("auto" | "summarized" | "passthrough" | "hide")
How to handle tool execution errors.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_CREATE_CONVERSATIONAL_AGENTTool to create a new ElevenLabs Conversational AI agent with specified configuration. Use when you need to programmatically set up an agent with custom prompts, voice settings, and behavior. After creating the agent, you can chain other tools to attach phone numbers or configure additional settings.

Input Parameters

string
Human-readable name for the agent
array
List of tags to organize and categorize the agent
object
Workflow configuration defining conditional logic, tool execution modes, and conversation flow patterns for the agent
string
Platform-specific settings including evaluation criteria, widget configuration, data collection schemas, auth requirements, call limits, and privacy settings. For widget.variant, valid values are: ‘tiny’, ‘compact’, ‘full’, or ‘expandable’.
object
required
Configuration object defining the agent’s conversational behavior. Must include agent settings (prompt, llm, language, first_message), and can optionally include asr, tts, turn, conversation, and vad settings. Example: {‘agent’: {‘prompt’: {‘prompt’: ‘You are a helpful assistant’, ‘llm’: ‘gpt-4o’}}}

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_CREATE_CRAWL_JOBCreate a knowledge-base crawl job from a documentation URL, optionally filtering pages or enabling auto-sync. Returns the job ID and initial status, not the completed crawl. Requires your own ElevenLabs connection.

Input Parameters

string
required
URL to documentation that the agent can access.
string
Only include URLs matching this pattern, if set.
integer
Deprecated no-op; will be removed by the provider in a future version.
integer
Maximum number of pages to crawl (1–10,000); defaults to 1000.
boolean
Automatically remove unavailable URL documents; applies only with auto-sync enabled.
array
URLs to crawl from a sitemap; overrides automatic URL discovery.
boolean
Discover and add newly linked pages during auto-sync; requires enable_auto_sync=true.
boolean
Whether to enable auto-sync for this URL document.
array
Skip URLs matching any of these patterns, even if they match pattern.
string
Place the created document or folder inside this folder.
integer
Refresh interval in days (1–180), only for auto-sync. Defaults to 7, tightened by a stricter parent folder; the actual interval can be shorter, never longer.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_CREATE_DEPLOYMENTCreate or update an agent’s deployment using branch traffic percentages. Requires your own ElevenLabs connection.

Input Parameters

string
required
The ID of an agent, returned on agent creation.
object
required
Request to create a new deployment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_CREATE_DIALOGUEConvert ordered text and voice pairs into one downloadable dialogue audio file using your own ElevenLabs connection. Requests support up to 10 unique voices and 2,000 total text characters.

Input Parameters

integer
Seed for best-effort deterministic generation.
array
required
Ordered dialogue turns. Use at most 10 unique voice IDs and at most 2,000 total characters across all turn text.
string
Text-to-speech model ID used for all dialogue turns.
object
Settings controlling dialogue generation.
string
Text immediately after this generation for prosodic continuity.
object
Optional filter, distance, environment, noise, reverb, and pan effects.
string
ISO 639-1 language code used for language enforcement and normalization.
string ("alaw_8000" | "mp3_22050_32" | "mp3_24000_48" | "mp3_44100_32" | "mp3_44100_64" | "mp3_44100_96" | "mp3_44100_128" | "mp3_44100_192" | "opus_48000_32" | "opus_48000_64" | "opus_48000_96" | "opus_48000_128" | "opus_48000_192" | "pcm_8000" | "pcm_16000" | "pcm_22050" | "pcm_24000" | "pcm_32000" | "pcm_44100" | "pcm_48000" | "ulaw_8000" | "wav_8000" | "wav_16000" | "wav_22050" | "wav_24000" | "wav_32000" | "wav_44100" | "wav_48000")
Generated audio format as codec_sample-rate_bitrate.
string
Text immediately before this generation for prosodic continuity.
boolean
Whether ElevenLabs stores request history. Setting false uses zero retention mode, which is available only to enterprise customers.
boolean
Use the instant-voice-clone version of a professional voice.
array
Up to three later dialogue request IDs, closest audio first.
array
Up to three earlier dialogue request IDs, closest audio last.
string ("auto" | "on" | "off")
Text normalization mode: automatic, always on, or off.
array
Up to three pronunciation dictionaries, applied in order.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_CREATE_DUBBING_LANGUAGEAdd a language target and queue a billed dub of an existing project. Generation starts when the project is ready and inherits its model. Requires your own ElevenLabs connection; enterprise translations can replace machine translation. Returns the queued target, not completed audio. Projects with webhooks emit dubbing_language_completed with output URLs.

Input Parameters

string
required
Identifier of the parent dubbing project.
object
Enterprise only. Source segment external_id (or id) to translated text; cover every segment exactly once. At most 20,000 entries and 4 MiB total text.
object
Voice settings applied to every speaker; omit to use defaults.
string
required
BCP-47 language tag, such as fr or es-MX, supported by the project’s dubbing model. Region-qualified tags must be supported dialects.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_CREATE_DUBBING_PROJECTCreate an asynchronous dubbing project from uploaded media or a public URL. Incurs a minimum charge of one language before output exists. Returns a queued project; use webhooks to track preparation. Requires your own ElevenLabs connection.

Input Parameters

object
Source audio/video upload, at most 3 GiB. Supply this or source_url, not both.
array
Transcription/translation key terms, at most 1000, each at most 50 characters and 5 words; no <>{}[]. Sent as a JSON array; provider trims and deduplicates.
string
Dubbing model, dubbing_v1 or dubbing_v2 (default). Fixed at creation; schema permits future string IDs.
string
Free-form project identifier echoed verbatim; at most 500 characters.
string
Public HTTP(S) media URL, subject to upload size/format limits. Supply this or file.
object
Enterprise JSON transcript upload: segments document, at most 20000 segments and 4 MiB. Requires source_language. Translated segments require target_language and translations on every segment.
array
At most 3 configured workspace webhook IDs, sent as a JSON array. Receive project ready/failed and language completed/failed events; delivery may repeat.
string
Supported transcription BCP-47 language; region/script ignored. Omit to auto-detect.
string
Optional supported dubbing BCP-47 language/dialect to queue as the first target, consuming the minimum charge. Its ID appears in language_ids.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_CREATE_ENVIRONMENTCreate a workspace environment. Variables without a value for it fall back to their production value. Requires your own ElevenLabs connection.

Input Parameters

string
required
Unique name of the environment, e.g. ‘staging’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_CREATE_ENVIRONMENT_VARIABLECreate a workspace environment variable containing strings or references to existing secrets/auth connections. Requires your own ElevenLabs connection.

Input Parameters

string
required
Variable definition, including its type, unique label and environment values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_CREATE_IMAGE_GENERATIONQueue an image generation using a selected model and optional reference images. Returns a pending generation ID; retrieve output with the image-generation GET endpoint. Requires your own ElevenLabs connection. ByteDance models require support approval.

Input Parameters

string
required
Model-specific image generation request. Select options supported by the chosen model.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_CREATE_MCP_SERVERCreate an MCP server configuration using an HTTPS URL or existing workspace references. Requires your own ElevenLabs connection. Credential tokens and custom request headers/metadata are excluded by owner policy; configure those outside this tool. Existing auth-connection IDs remain supported.

Input Parameters

object
required
Configuration details for the new MCP server.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_CREATE_MUSIC_FINETUNECreate a music finetune from uploaded audio, with a name, genre, optional tags and visibility. Requires your own ElevenLabs connection.

Input Parameters

string
required
Name for the finetune (5-200 characters).
array
Tags to associate with the finetune.
array
Audio files to train on.
string ("music_v1" | "music_v2" | "music_v2_5")
The model to create a finetune for.
string ("private" | "workspace")
Finetune visibility. Only private and workspace can be set.
string
required
Primary musical genre of the finetune.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_CREATE_MUSIC_FROM_VIDEOGenerate background music from ordered video uploads, optionally guided by text, style tags or the video’s audio. Returns audio or a ZIP of separate tracks. Requires your own ElevenLabs connection and an eligible subscription.

Input Parameters

array
Up to ten optional style tags, such as upbeat or cinematic.
array
required
One to ten videos combined in order; total at most 200 MB and 600 seconds. Combine beforehand to reduce processing time.
boolean
Incorporate sound-effect cues from the video.
string ("music_v1" | "music_v2" | "music_v2_5")
Music generation model. The documented default music_v1 is deprecated by the provider.
string
Optional description of the desired music, one to 4100 characters, or null.
string ("mp3_22050_32" | "mp3_24000_48" | "mp3_44100_32" | "mp3_44100_64" | "mp3_44100_96" | "mp3_44100_128" | "mp3_44100_192" | "pcm_8000" | "pcm_16000" | "pcm_22050" | "pcm_24000" | "pcm_32000" | "pcm_44100" | "pcm_48000" | "ulaw_8000" | "alaw_8000" | "opus_48000_32" | "opus_48000_64" | "opus_48000_96" | "opus_48000_128" | "opus_48000_192")
Audio codec_sample_rate_bitrate. MP3 192kbps requires Creator or above; PCM 44.1kHz requires Pro or above.
boolean
Enable request logging. False selects zero retention, available only to enterprise customers.
boolean
Sign the generated song with C2PA; applicable only to MP3 files.
boolean
Return a ZIP containing separate music and SFX tracks instead of one mixed audio file.
boolean
Use the video’s audio genres, BPM, instrumentation, mood and arc as generation references.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_CREATE_MUSIC_PLANTool to generate a music composition plan from a text prompt using ElevenLabs Music API. Use when you need to create a structured plan for music generation with defined styles, sections, and durations. The generated plan can be used as input for actual music generation or as a template for variations.Instant: Supported on the latest version.Instant pricing: $0 per request

Input Parameters

string
required
A simple text prompt to compose a plan from. Describe the musical style, mood, instruments, or other characteristics you want in the composition.
string ("music_v1")
The model to use for the generation.
integer
The length of the composition plan to generate in milliseconds. Must be between 3000ms (3 seconds) and 600000ms (10 minutes). If not provided, the model will choose a length based on the prompt.
object
Optional source composition plan for generating variations.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_CREATE_PODCASTCreate and auto-convert a Studio podcast from text or URLs with one or two voices. Audio generation incurs charges. Returns the project, not audio bytes. Requires your own ElevenLabs connection.

Input Parameters

string
required
Conversation between two voices or a bulletin monologue.
string
Intro text always added to the beginning of the podcast.
string
Outro text always added to the end of the podcast.
string
required
One text or URL source, or a list of text and URL sources.
string
Two-letter ISO 639-1 project language code.
string
required
Studio model ID; list available models with GET /v1/models.
array
Content highlights; each highlight must be 10–70 characters.
string
URL called with project/chapter conversion status, snapshot ID, and error details after conversion.
string ("short" | "default" | "long")
Short: under 3 minutes; default: roughly 3–7 minutes; long: over 7 minutes.
string ("standard" | "high" | "ultra" | "ultra_lossless")
Audio quality; omitted defaults to the highest available on your subscription tier.
string
Moderation identifier; your workspace must be allowlisted to use this header.
string
Additional instructions for the podcast’s style and tone.
string ("auto" | "on" | "off" | "apply_english")
Automatically choose normalization, always normalize, skip, or normalize assuming English.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_CREATE_PRODUCTION_ORDERCreate a Productions order in the workspace in the open state, ready to configure with items before submission. Optionally create a sandbox order that auto-progresses without producer intervention. Requires your own ElevenLabs connection.

Input Parameters

object
Optional order configuration. Omit for a standard order, or set sandbox to true for automatic sandbox progression.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_CREATE_PROFESSIONAL_VOICECreate a professional voice clone with metadata but no samples. Returns its voice ID; samples must be added separately. Requires your own ElevenLabs connection.

Input Parameters

string
required
The name that identifies this voice, displayed in the website dropdown.
object
Labels for the voice. Keys can be language, accent, gender, or age.
string
required
Language used in the samples.
string
Description to use for the created voice.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_CREATES_AUDIONATIVE_ENABLED_PROJECTCreates an ElevenLabs AudioNative project, generating an embeddable audio player from a provided content file using text-to-speech, allowing customization of player appearance, audio settings, and conversion options.

Input Parameters

object
Content file (e.g., TXT, HTML) to be converted into audio.
string
User-defined name for the AudioNative project.
string
URL for an image in the AudioNative player; a default or no image is used if omitted.
boolean
Set to True for a compact player; False (default) for standard size.
string
Title of the content, for display in the AudioNative player.
string
Author of the content, for display in the AudioNative player.
string
Identifier for the ElevenLabs TTS model. Allowed models for AudioNative: ‘eleven_multilingual_v2’, ‘eleven_turbo_v2_5’, ‘eleven_turbo_v2’, ‘eleven_monolingual_v1’, ‘eleven_multilingual_v1’. A default is used if omitted.
string
Identifier for the ElevenLabs voice; a default is used if omitted. See ‘/v1/voices’ for available IDs.
string
Hex color code for player text (must start with ’#’, e.g., ‘#FFFFFF’ for white, ‘#000000’ for black).
boolean
If True, automatically converts content to audio after project creation; False (default).
integer
Interval in days for automatic audio reconversion; 0 (default) disables it (e.g., 1 daily, 7 weekly).
string
Hex color code for player background (must start with ’#’, e.g., ‘#000000’ for black, ‘#FFFFFF’ for white).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_CREATE_SERVICE_ACCOUNTCreate a service account in your ElevenLabs workspace with optional default sharing groups. Workspaces support 20 service accounts by default; Enterprise customers may request up to 100. Requires your own ElevenLabs connection.

Input Parameters

string
required
The name of the new service account.
array
Groups and permission levels to share with by default; may be omitted or null.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_CREATE_SIMILAR_VOICESReturns a list of shared voices similar to the provided audio sample. Use when you need to find voice matches based on audio characteristics. If neither similarity_threshold nor top_k is provided, default values will be applied.

Input Parameters

integer
Number of most similar voices to return. If similarity_threshold is provided, fewer voices may be returned. Values range from 1 to 100. Default values will be applied if not specified.
object
required
Audio file to find similar voices for. Supported formats: mp3, wav, ogg.
number
Threshold for voice similarity between provided sample and library voices. Values range from 0 to 2. The smaller the value, the more similar voices will be returned. Default values will be applied if not specified.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_CREATE_SINGLE_USE_TOKENGenerates a time-limited single-use token for realtime Scribe transcription or text-to-speech WebSocket connections, suitable for frontend clients.

Input Parameters

string ("realtime_scribe" | "tts_websocket")
required
Type of single-use token to generate. Options: ‘realtime_scribe’ for real-time transcription, ‘tts_websocket’ for text-to-speech WebSocket connections.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_CREATE_SPEECH_ENGINECreate a Speech Engine resource connecting an upstream transcript WebSocket to configurable ASR, TTS and turn detection. Requires your own ElevenLabs connection.

Input Parameters

object
ASR configuration; omit for defaults.
object
TTS configuration; omit for defaults.
object
Voice activity detection; omit for defaults.
string
Speech engine name.
array
Categorization tags; omit for defaults.
object
Turn detection configuration; omit for defaults.
object
Recording, retention and PII settings; omit for defaults.
string
Speech engine language.
object
Client conversation initiation overrides; omit for defaults.
object
Concurrency and daily limits; omit for defaults.
object
Conversation settings; omit for defaults.
object
required
Upstream speech engine WebSocket configuration.
number
Upstream response timeout before retry, between 2 and 15 seconds.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_CREATE_TAGCreate a conversation tag for the workspace, with a title and optional description. Requires your own ElevenLabs connection.

Input Parameters

string
required
Display title of the tag.
string
Optional free-text description.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_CREATE_TEST_FOLDERCreate a folder for organizing agent tests, optionally under a parent folder. Requires your own ElevenLabs connection.

Input Parameters

string
required
The name of the folder to create.
string
The ID of the parent folder. If omitted, create at the root level.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_CREATE_TIMESTAMPED_DIALOGUEGenerate multi-voice dialogue with base64 audio, character timestamps and speaker segments. Requires your own ElevenLabs connection.

Input Parameters

integer
Best-effort deterministic seed between 0 and 4294967295; determinism is not guaranteed.
array
required
Dialogue lines with text and voice IDs; at most 10 unique voices. Keep total text at or below 2,000 characters for reliable generation.
string
Speech-capable model ID from GET /v1/models.
object
Dialogue generation settings.
string
Immediately following text for prosodic continuity; not supported by every model.
object
Audio effects; unknown IDs return 404. Reverb or nonzero pan produces stereo and is rejected for ulaw, alaw and pcm formats.
string
ISO 639-1 language code; ignored if unsupported, not supported for multilingual_v2.
string ("wav_8000" | "wav_16000" | "wav_22050" | "wav_24000" | "wav_32000" | "wav_44100" | "wav_48000" | "mp3_22050_32" | "mp3_24000_48" | "mp3_44100_32" | "mp3_44100_64" | "mp3_44100_96" | "mp3_44100_128" | "mp3_44100_192" | "pcm_8000" | "pcm_16000" | "pcm_22050" | "pcm_24000" | "pcm_32000" | "pcm_44100" | "pcm_48000" | "ulaw_8000" | "alaw_8000" | "opus_48000_32" | "opus_48000_64" | "opus_48000_96" | "opus_48000_128" | "opus_48000_192")
Audio codec_sample_rate_bitrate. MP3 192kbps requires Creator+; PCM/WAV 44.1kHz requires Pro+.
string
Immediately preceding text for prosodic continuity; not supported by every model.
boolean
False enables enterprise-only zero retention, disabling history and request stitching.
boolean
Use the IVC version of a professional voice; may improve expressiveness and latency.
array
Up to three following dialogue request IDs, closest first; not supported by every model.
array
Up to three preceding dialogue request IDs, closest last; not supported by every model.
string ("auto" | "on" | "off")
Automatically choose, always apply, or skip text normalization.
array
Up to three pronunciation dictionary locators, applied in order.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_CREATE_TOOL_OVERRIDECreate configuration overrides for one named MCP tool on an existing server. Returns the updated server configuration; an existing override produces HTTP 409. Requires your own ElevenLabs connection.

Input Parameters

string
required
Name of the MCP tool.
array
Dynamic variable assignments for this tool.
string
Environment resolving server URL, headers and auth connection variables; defaults to production.
string
required
ID of the MCP server.
string ("immediate" | "post_tool_speech" | "async")
Override when the tool executes.
array
Mock responses, evaluated top to bottom; first match wins.
object
Map JSON paths to input override configurations.
string ("auto" | "force" | "off")
Override server pre-tool speech mode.
string
Sound name, off for silence, or null to inherit the server default.
string ("allow" | "disable_during_tool" | "disable_during_tool_and_turn")
Override the server interruption mode.
boolean
Deprecated: use interruption_mode. Override interruption suppression.
boolean
Deprecated: use pre_tool_speech. Override server pre-tool speech.
integer
Override response timeout in seconds, between 5 and 300 inclusive.
string ("auto" | "always")
Override sound playback behavior.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_CREATE_TRIAGE_TICKETRaise a ticket about an agent’s conversation performance for triage with Architect. Provide overall and/or turn-level comments. An existing open ticket can receive the comments and a higher priority. Requires your own ElevenLabs connection.

Input Parameters

string
One-line headline; defaults to a headline derived from comments or the conversation summary. Ignored when adding to an open ticket.
string ("low" | "medium" | "high" | "urgent")
Urgency; raises an existing open ticket’s priority when lower.
string
The issue covering the whole conversation rather than a single turn.
array
Optional turn-level comments on what went wrong.
string
required
Conversation this ticket is about.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_CREATE_VIDEO_GENERATIONQueue a video generation using Veo, Seedance, or Creatify Aurora and return its pending ID. Retrieve output with the corresponding GET endpoint. ByteDance models require support approval. Requires your own ElevenLabs connection.

Input Parameters

string
required
Model-specific video generation settings.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_CREATE_VOICE_COLLECTIONCreate a voice collection with a title and icon; you become its admin. Requires your own ElevenLabs connection.

Input Parameters

string
required
Icon of the voice collection to create.
string
required
Title of the voice collection to create.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_CREATE_VOICE_FROM_PREVIEWCreate a saved voice from a previously generated voice preview. First obtain generated_voice_id through voice design or remix; provide a name and a 20–1000 character description. Requires your own ElevenLabs connection.

Input Parameters

object
Optional metadata to add to the created voice.
string
required
Name to use for the created voice.
string
required
Description to use for the created voice.
string
required
Generated preview ID from POST /v1/text-to-voice/design or POST /v1/text-to-voice/:voice_id/remix, or preview-generation response headers.
array
IDs of voices played but not selected, used for reinforcement learning from human feedback.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_CREATE_WORKSPACE_WEBHOOKTool to create a new webhook for the workspace with specified authentication type. Use when you need to configure a webhook endpoint to receive notifications from ElevenLabs. The webhook_secret returned should be stored securely for verifying webhook authenticity.

Input Parameters

object
required
Webhook configuration settings including auth_type, name, and webhook_url

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_DELETE_AGENT_DRAFTDelete the draft for the specified agent branch. Requires your own ElevenLabs connection.

Input Parameters

string
required
The id of an agent. This is returned on agent creation.
string
required
The ID of the agent branch to use.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_DELETE_AGENT_HOLD_AUDIORemove an agent’s custom hold audio so queued callers hear the default hold tone again. Requires your own ElevenLabs connection.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_DELETE_ASSETDelete an asset by ID. Requires your own ElevenLabs connection.

Input Parameters

string
required
ID of the asset.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_DELETE_CHAPTERIrreversibly deletes a specific, existing chapter from an existing project, typically to remove unwanted or obsolete content.

Input Parameters

string
required
Identifier of the chapter to be deleted. To find available chapter_ids for a project, you can query GET https://api.elevenlabs.io/v1/studio/projects/{project_id}/chapters.
string
required
Identifier of the project. To find available project_ids, you can query GET https://api.elevenlabs.io/v1/studio/projects.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_DELETE_CONVAI_AGENTTool to permanently delete a Conversational AI agent by its unique identifier. Use when you need to remove an agent configuration from the ElevenLabs workspace.

Input Parameters

string
required
The unique identifier of the agent to delete. This is returned on agent creation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_DELETE_CONVAI_AGENT_TESTINGTool to delete an agent response test by ID. Use when you need to remove a test result or clean up test data.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_DELETE_CONVAI_BATCH_CALLINGTool to permanently delete a batch call and all associated recipient records. Conversations remain in history. Use when cleaning up completed or cancelled batch calls.

Input Parameters

string
required
The unique identifier of the batch call to permanently delete. Format: btcal_<alphanumeric>

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_DELETE_CONVAI_CONVERSATIONTool to delete a particular Conversational AI conversation by ID. Use when you need to remove a conversation from the system for cleanup, compliance, or data management purposes.

Input Parameters

string
required
The unique identifier of the conversation to delete.

Output

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

Input Parameters

boolean
If set to true, the document or folder will be deleted regardless of whether it is used by any agents and it will be removed from the dependent agents. For non-empty folders, this will also delete all child documents and folders.
string
required
The id of a document from the knowledge base. This is returned on document addition.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_DELETE_CONVAI_KNOWLEDGE_BASE_RAG_INDEXTool to delete RAG index for a knowledge base document. Use when you need to remove semantic search indexing from a document to free up resources or when the document no longer needs to be indexed.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_DELETE_CONVAI_SECRETTool to delete a workspace secret if it’s not in use. Use when you need to remove unused secrets from the conversational AI workspace for security or cleanup purposes.

Input Parameters

string
required
The unique identifier of the workspace secret to delete. This ID is returned when creating or listing secrets.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_DELETE_CONVAI_TOOLTool to delete a conversational AI tool from the workspace by ID. Use when you need to remove a tool configuration that is no longer needed or to clean up outdated tool definitions.

Input Parameters

string
required
ID of the requested tool.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_DELETE_CONVERSATION_FILERemove an uploaded file from a conversation before it has been used in that conversation. Requires your own ElevenLabs connection.

Input Parameters

string
required
The ID of the uploaded file to remove.
string
required
The conversation containing the uploaded file.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_DELETE_DUBBING_LANGUAGEDelete a dubbing language target and its outputs, preserving the project and other languages. This cannot be undone; a running dub is still billed. Requires your own ElevenLabs connection.

Input Parameters

string
required
Identifier of the parent dubbing project.
string
required
Identifier of the language target to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_DELETE_DUBBING_PROJECTPermanently deletes a dubbing project by its ID; this action is irreversible and the project cannot be recovered.

Input Parameters

string
required
The unique identifier for the dubbing project to be deleted. This ID is typically obtained when the dubbing project is created or listed.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_DELETE_DUBBING_STUDIO_PROJECTPermanently delete a dubbing project, every language target, and their stored media and outputs. This cannot be undone; an already running dub is still billed. Requires your own ElevenLabs connection.

Input Parameters

string
required
Identifier of the dubbing project to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_DELETE_ENVIRONMENTDelete a workspace environment and remove its values from all environment variables. The ‘production’ environment cannot be deleted. Requires your own ElevenLabs connection.

Input Parameters

string
required
Name of the environment to delete, e.g. ‘staging’. The ‘production’ environment cannot be deleted.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_DELETE_ENVIRONMENT_VARIABLEDelete an environment variable and its values in all environments. Agents are not checked: deleting a variable still used by an agent causes its conversations to fail. Deletion is rejected while tools, MCP servers, or the workspace conversation initiation webhook use the variable. Requires your own ElevenLabs connection.

Input Parameters

string
required
ID of the environment variable to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_DELETE_HISTORY_ITEMPermanently deletes a specific history item (including its audio file and metadata) using its history_item_id; this operation is irreversible and should be used with caution.

Input Parameters

string
required
Unique identifier of the history item to be deleted. This ID is obtainable by listing history items, for example, via the GET /v1/history endpoint.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_DELETE_INVITATIONInvalidate an existing workspace email invitation. The delivered email remains in the recipient’s inbox, but its invitation can no longer be activated. Requires workspace members invite permission and your own ElevenLabs connection.

Input Parameters

string
required
The email of the customer whose invitation to invalidate.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_DELETE_ISOLATION_HISTORY_ITEMDelete an audio isolation history item and its associated media files. Requires your own ElevenLabs connection.

Input Parameters

string
required
Identifier of the audio isolation history item to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_DELETE_MCP_SERVERTool to delete a specific MCP server configuration from the workspace. Use when you need to remove an MCP server that is no longer needed or to clean up outdated configurations.

Input Parameters

string
required
ID of the MCP Server to delete from the workspace.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_DELETE_MUSIC_FINETUNEDelete a music finetune by ID and return its details. Requires your own ElevenLabs connection.

Input Parameters

string
required
ID of the music finetune to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_DELETE_PHONE_NUMBERTool to delete an imported phone number from the ElevenLabs workspace by ID. Use when you need to remove a phone number configuration for cleanup or to avoid stale configurations in automated environments.

Input Parameters

string
required
The ID of the phone number to delete. This is returned on phone number creation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_DELETE_PROCEDURE_DRAFTDelete the user’s procedure draft, resetting to the committed version. Requires your own ElevenLabs connection.

Input Parameters

string
required
Agent ID to get the procedure draft from.
string
required
Branch ID to get the procedure draft from.
string
required
The procedure ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_DELETE_PROJECTUse to irreversibly delete a specific project by its project_id; the project must exist and be accessible, and this action cannot be undone.

Input Parameters

string
required
Identifier of the project to delete. Obtain by listing projects (e.g., via GET /v1/studio/projects).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_DELETE_SAMPLEPermanently deletes a specific voice sample for a given voice ID; this action is irreversible.

Input Parameters

string
required
Voice ID to be used, you can use https://api.elevenlabs.io/v1/voices to list all the available voices.
string
required
Sample ID to be used, you can use GET https://api.elevenlabs.io/v1/voices/&#123;voice_id&#125; to list all the available samples for a voice.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_DELETE_SAVED_TRANSCRIPTDelete a previously generated, saved transcript by its ID. Requires your own ElevenLabs connection.

Input Parameters

string
required
The unique ID of the transcript to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_DELETE_SPEECH_ENGINEDelete a Speech Engine resource by its seng_ or agent_ ID. Requires your own ElevenLabs connection. Successful deletion returns no content.

Input Parameters

string
required
The speech engine ID (accepts seng_ or agent_ prefix).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_DELETE_TAGDelete a conversation tag. Restricted to the tag owner or a workspace admin. Requires your own ElevenLabs connection.

Input Parameters

string
required
The ID of the conversation tag to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_DELETE_TEST_FOLDERDelete an agent test folder by ID. Set force=true to delete a non-empty folder and all its contents. Requires your own ElevenLabs connection.

Input Parameters

boolean
Force delete a non-empty folder and all its contents. Defaults to false.
string
required
The folder ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_DELETE_TOOL_OVERRIDERemove configuration overrides for one MCP tool and return the updated server configuration. Requires your own ElevenLabs connection.

Input Parameters

string
required
Name of the MCP tool to remove config overrides for.
string
required
ID of the MCP Server.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_DELETE_TRANSCRIPT_SEGMENTRemove a source transcript segment from an Enterprise dubbing project. Bumps the project’s revision, discards the affected translations in every language target, and marks completed targets stale. Audio changes only after regenerating a target. Requires your own ElevenLabs connection.

Input Parameters

string
required
Identifier of the dubbing project.
string
required
Identifier of the segment to remove.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_DELETE_TRIAGE_TICKETDelete an agent conversation ticket. Restricted to the ticket creator or a workspace admin. Requires your own ElevenLabs connection.

Input Parameters

string
required
The ID of the agent conversation ticket to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_DELETE_VOICEPermanently and irreversibly deletes a specific custom voice using its voice_id; the voice must exist and the authenticated user must have permission to delete it.

Input Parameters

string
required
The unique identifier of the voice to be deleted.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_DELETE_VOICE_COLLECTIONDelete a voice collection. Requires admin access to the collection. The voices in the collection are not deleted.

Input Parameters

string
required
Collection ID to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_DELETE_VOICE_SAMPLEDelete a sample from a professional voice clone (PVC) using its voice and sample IDs. Requires your own ElevenLabs connection.

Input Parameters

string
required
The professional voice ID. List available voices using GET /v1/voices.
string
required
The sample ID to delete from the voice.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_DELETE_WHATSAPP_ACCOUNTDelete a WhatsApp account by phone number ID. Requires your own ElevenLabs connection.

Input Parameters

string
required
The phone number ID of the WhatsApp account to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_DELETE_WORKSPACE_WEBHOOKTool to delete a specified workspace webhook by its ID. Use when you need to remove a webhook configuration that is no longer needed or to clean up webhook integrations.

Input Parameters

string
required
The unique ID for the webhook

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_DESIGN_VOICEDesign voice previews from a descriptive prompt using your own ElevenLabs connection. Returns generated IDs and preview audio; save the preferred preview through /v1/text-to-voice to create a voice.

Input Parameters

integer
Random seed; identical inputs and seed produce the same voice.
string
Text to generate, between 100 and 1000 characters.
number
Higher values improve voice quality but reduce variety.
number
Volume: -1 is quietest, 1 loudest, and 0 roughly -24 LUFS.
string ("eleven_multilingual_ttv_v2" | "eleven_ttv_v3")
Model to use for voice generation.
string ("mp3_22050_32" | "mp3_24000_48" | "mp3_44100_32" | "mp3_44100_64" | "mp3_44100_96" | "mp3_44100_128" | "mp3_44100_192" | "pcm_8000" | "pcm_16000" | "pcm_22050" | "pcm_24000" | "pcm_32000" | "pcm_44100" | "pcm_48000" | "ulaw_8000" | "alaw_8000" | "opus_48000_32" | "opus_48000_64" | "opus_48000_96" | "opus_48000_128" | "opus_48000_192")
Audio codec_sample_rate_bitrate. MP3 192kbps requires Creator tier or above; PCM 44.1kHz requires Pro tier or above.
number
How closely the AI follows the prompt; high values can sound artificial. Longer detailed prompts are recommended at lower values.
boolean
Enhance the voice description using AI to add detail and improve generation quality.
number
Prompt versus reference audio balance: 0 minimizes prompt influence, 1 minimizes reference audio influence. Only eleven_ttv_v3 supports this.
boolean
Return generated IDs for later streaming through /v1/text-to-voice/:generated_voice_id/stream instead of including preview audio.
string
required
Description to use for the created voice.
boolean
Automatically generate text suitable for the voice description.
string
The remixing session ID.
string
Base64 reference audio, supported only by eleven_ttv_v3.
string
Iteration to attach generations to; if omitted, a new iteration is created.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_DOWNLOAD_HISTORY_ITEMSDownloads audio clips from history by ID(s), returning a single file or a ZIP archive, with an optional output format (e.g., ‘wav’); provides only audio content, no metadata.

Input Parameters

string
Optional. Specifies the desired output audio format. Accepts ‘wav’ to convert the audio to WAV format. If omitted, the audio is returned in its original synthesized format (e.g., mp3). This formatting applies to each audio file, even when multiple files are downloaded and returned as a ZIP archive.
array
required
A list of unique string identifiers for the history items to be downloaded. These IDs can be obtained using the GET /v1/history endpoint.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_DRY_RUN_PROCEDURE_COMPILATIONLegacy dry-run compilation of a branch’s current procedure drafts into a workflow without persisting anything. Prefer saving an agent draft or publishing an agent: those operations compile automatically and return validation errors. This legacy endpoint remains available for existing callers and will eventually be deprecated. Requires your own ElevenLabs connection.

Input Parameters

string
required
Agent ID to get the procedure draft from.
string
required
Branch ID to get the procedure draft from.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_DUB_A_VIDEO_OR_AN_AUDIO_FILEDub a video or audio file into a specified target language, requiring ‘file’ or ‘source_url’, ‘target_lang’, and ‘csv_file’ if ‘mode’ is ‘manual’.

Input Parameters

object
Video or audio file to dub. Required if ‘source_url’ is not provided.
string
Specifies dubbing mode: ‘automatic’ for AI-driven dubbing, or ‘manual’ using a .csv file for timestamped transcriptions. API defaults to ‘automatic’ if unspecified.
string
Name for the dubbing project.
object
CSV file with guidance for ‘manual’ mode dubbing. Required if ‘mode’ is ‘manual’.
integer
End time (seconds) for the audio portion to dub. API defaults to audio end if unspecified.
boolean
Include a watermark in the dubbed audio.
string
URL of the video or audio file to dub. Required if ‘file’ is not provided.
integer
Start time (seconds) for the audio portion to dub. API defaults to audio start if unspecified.
string
Language of the original audio. Use ‘auto’ for automatic detection or provide a language code (e.g., ‘en’, ‘es’).
string
Required target language code for dubbing (e.g., ‘en’, ‘es’).
integer
Number of speakers in the audio. Use 0 for automatic detection; otherwise, model attempts to differentiate this many speakers.
boolean
Enable Dubbing Studio features for advanced editing capabilities, if available.
boolean
Process dubbing at highest possible resolution; may increase processing time.
object
Background audio track for ‘manual’ mode with a CSV file.
object
Foreground audio track for ‘manual’ mode with a CSV file.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_DUPLICATE_CONVAI_AGENTTool to create a new agent by duplicating an existing one. Use when you need to clone an agent’s configuration. The new agent will inherit all settings from the original agent but can be given a new name.

Input Parameters

string
A name to make the agent easier to find
string
required
The id of an agent. This is returned on agent creation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_DUPLICATE_SPEECH_ENGINECreate a new speech engine by duplicating an existing seng_ or agent_ resource, optionally choosing a new name. Returns the new resource’s ID and configuration. Requires your own ElevenLabs connection.

Input Parameters

object
Optional duplication settings; omit to use the source name.
string
required
The speech engine ID (accepts seng_ or agent_ prefix).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_EDIT_PROFESSIONAL_VOICEEdit an existing professional voice’s name, language, description, or labels. Requires your own ElevenLabs connection.

Input Parameters

string
The name identifying this voice in the website dropdown. Omit to leave unchanged.
object
Voice labels such as language, accent, gender, or age. Omit to leave unchanged; accepts null.
string
Language used in the samples. Omit to leave unchanged.
string
required
The ID of the professional voice to edit.
string
Description to use for the voice. Omit to leave unchanged; accepts null.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_EDIT_VOICEUpdates the name, audio files, description, or labels for an existing voice model. The voice_id must be for a voice owned by you (cloned voices). Premade/default voices cannot be edited. The ‘name’ field is required for all edit operations. This endpoint uses multipart/form-data format for the request body.

Input Parameters

string
required
Name for the voice model. This is a required field.
array
Optional list of audio files to add to the voice model. Each file should be a Supported formats: mp3, wav, ogg.
string
JSON string of key-value pairs for categorization; new labels overwrite existing ones. Example: {“accent”: “American”, “gender”: “male”}
string
required
Identifier of the voice to be edited; retrieve available IDs via the /v1/voices endpoint. Only voices owned by you can be edited.
string
New description for the voice model.
boolean
If set to true, will remove background noise from voice samples. Only use if samples contain background noise; using it on clean audio can reduce quality.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_EDIT_VOICE_SETTINGSEdits key voice settings (e.g., stability, similarity enhancement, style exaggeration, speaker boost) for an existing voice, affecting all future audio generated with that voice ID.

Input Parameters

number
Controls the speech rate and pacing of the generated audio. Value typically between 0.25 and 4.0.
number
Adjusts the style exaggeration and expressiveness of the voice. Value between 0.0 and 1.0. Available for V2+ models. Generally recommended to keep at 0.
string
required
Identifier of the voice whose settings are to be modified. Obtain available voice IDs via the GET /v1/voices endpoint.
number
Controls voice consistency and randomness between generations. Value between 0.0 and 1.0. Lower values introduce broader emotional range, higher values result in more monotonous voice.
number
Determines how closely the AI should adhere to the original voice when attempting to replicate it. Value between 0.0 and 1.0.
boolean
Boosts the similarity to the original speaker. The differences are generally subtle. Not available for Eleven v3 model.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_EXPORT_BATCH_CALLSDownload recipients and conversation results for a terminal batch call as CSV. Optionally limit recipients to preview columns. Requires your own ElevenLabs connection.

Input Parameters

integer
Only export the first N recipients to preview columns. Omit to export every recipient.
string
required
The ID of the terminal batch call to export.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_GENERATE_A_RANDOM_VOICEGenerates a unique, random ElevenLabs text-to-speech voice based on input text and specified voice characteristics.

Input Parameters

string ("middle_aged" | "old" | "young")
required
Specifies the age category of the generated voice. Possible values are ‘young’, ‘middle_aged’, or ‘old’.
string
required
The text to be synthesized into speech. The length of the text must be between 100 and 1000 characters, inclusive.
string
required
Specifies the accent of the generated voice. Accepted values include ‘american’, ‘british’, ‘african’, ‘australian’, ‘indian’.
string ("female" | "male")
required
Specifies the gender of the generated voice. Possible values are ‘female’ or ‘male’.
number
required
Controls the strength of the accent for the generated voice. Must be a numeric value between 0.3 and 2.0, inclusive.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_GENERATE_SOUND_EFFECTSGenerate a downloadable sound effect from a text description, with optional duration and seamless looping. Requires your own ElevenLabs connection and consumes provider credits.

Input Parameters

boolean
Create a sound effect that loops smoothly.
string
required
Text description of the sound effect to generate.
string ("eleven_text_to_sound_v2" | "eleven_text_to_sound_v3")
Sound effects model to use.
string ("alaw_8000" | "mp3_22050_32" | "mp3_24000_48" | "mp3_44100_128" | "mp3_44100_192" | "mp3_44100_32" | "mp3_44100_64" | "mp3_44100_96" | "opus_48000_128" | "opus_48000_192" | "opus_48000_32" | "opus_48000_64" | "opus_48000_96" | "pcm_16000" | "pcm_22050" | "pcm_24000" | "pcm_32000" | "pcm_44100" | "pcm_48000" | "pcm_8000" | "ulaw_8000" | "wav_16000" | "wav_22050" | "wav_24000" | "wav_32000" | "wav_44100" | "wav_48000" | "wav_8000")
Audio codec, sample rate and bitrate. MP3 at 192kbps requires Creator tier or above; PCM/WAV at 44.1kHz requires Pro tier or above.
boolean
Enable request logging. Setting false uses zero retention mode, available only to enterprise customers.
number
Duration in seconds, from 0.5 to 30. Omit or pass null to let the model choose.
number
Prompt adherence from 0 to 1; higher values follow the prompt more closely and reduce variation. Defaults to 0.3.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_GET_AGENT_BRANCHGet metadata and recent versions for one Conversational AI agent branch.

Input Parameters

string
required
Agent ID returned when the agent was created.
string
required
Unique agent branch ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_GET_AGENT_BRANCH_PROCEDURERetrieve a procedure from an ElevenLabs agent branch HEAD or version.

Input Parameters

string
required
Agent ID.
string
required
Agent branch ID.
string
Procedure version ID; omit to read branch HEAD.
string
required
Procedure ID.
string
Agent version whose attached procedure should be resolved.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_GET_AGENT_BRANCH_PROCEDURE_DRAFTRetrieve a user’s procedure draft, falling back to branch HEAD when none exists.

Input Parameters

string
required
Agent ID.
string
required
Agent branch ID.
string
required
Procedure ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_GET_AGENT_DETAILSTool to retrieve available Conversational AI agents and outbound-capable Twilio phone numbers. Use when selecting an agent and phone number for outbound calls. Always reference agents by agent_id (stable identifier), not agent_name (mutable). Returns basic metadata only — conversation_config and webhook settings require a separate ConvAI agent API call. Pass agent_id and agent_phone_number_id directly to ELEVENLABS_OUTBOUND_CALL; IDs must be current and owned by the authenticated account.

Input Parameters

string
Cursor for pagination. Used to fetch the next page of agents. Returned in previous response as next_cursor.
integer
Maximum number of agents to return per page. Cannot exceed 100, defaults to 30.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_GET_AGENT_VERSION_METADATARead a specific agent version’s commit, branch, ancestry and access metadata. Requires your own ElevenLabs connection.

Input Parameters

string
required
The ID of the agent, returned on creation.
string
required
Unique identifier for the version.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_GET_A_PROFILE_PAGERetrieves the profile information for the authenticated ElevenLabs user (identified by API key).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_GET_ASSETRetrieve an asset by ID, including metadata and its temporary signed content URL (null while processing). Requires your own ElevenLabs connection.

Input Parameters

string
required
ID of the asset.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_GET_ASYNC_SPEECH_GENERATIONRetrieve an asynchronous speech generation’s status and its signed output URL once completed. Requires your own ElevenLabs connection.

Input Parameters

string
required
The speech generation ID to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_GET_AUDIO_FROM_HISTORY_ITEMRetrieves the audio content for a specific history item from ElevenLabs, using a history_item_id that must correspond to a previously generated audio.

Input Parameters

string
required
The unique identifier for the history item. This ID can be obtained by listing your history items (e.g., via an action that calls GET /v1/history).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_GET_AUDIO_FROM_SAMPLERetrieves the audio for a given sample_id that must belong to the specified voice_id.

Input Parameters

string
required
Identifier for the voice. A list of available voice IDs can be obtained from the GET https://api.elevenlabs.io/v1/voices endpoint.
string
required
Identifier for the sample. A list of available sample IDs for a specific voice can be obtained from the GET https://api.elevenlabs.io/v1/voices/&#123;voice_id&#125; endpoint.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_GET_AUDIO_NATIVE_SETTINGSTool to retrieve player settings for a specific Audio Native project. Use when you need to check the current configuration of an audio-native project, including display settings, colors, and status.

Input Parameters

string
required
The ID of the Studio project. Use the audio-native project ID from when you created the project.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_GET_AUDIT_LOGSRead one page of workspace audit logs with optional time, actor and event filters. Requires enterprise tier and audit_log_read permission. Pass next_cursor as cursor to retrieve another page. Requires your own ElevenLabs connection.

Input Parameters

integer
Maximum entries per page (1–100).
string
Next-page cursor from the previous response.
string
Filter by actor user ID.
string
Filter by OCSF event class name, e.g. Account Change.
string
Filter by activity name, e.g. Subscription Creation.
integer
Include events at or before this Unix timestamp in milliseconds.
integer
Include events at or after this Unix timestamp in milliseconds.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_GET_CHAPTER_BY_IDFetches comprehensive details for a specific chapter within a given project, including its metadata (name, ID), conversion status, progress, download availability, and content statistics.

Input Parameters

string
required
Identifier of the chapter. You can find chapter_id by listing all available chapters for a project via the /v1/studio/projects/{project_id}/chapters endpoint.
string
required
Identifier of the project. You can find project_id by listing all available projects via the /v1/studio/projects endpoint.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_GET_CHAPTERSRetrieves a list of all chapters, their details, and conversion status for a project, useful for managing content or tracking progress.

Input Parameters

string
required
Identifier of the Studio project for which to retrieve chapters. You can find available project_ids by listing all projects (e.g., via GET https://api.elevenlabs.io/v1/studio/projects).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_GET_CHAPTER_SNAPSHOTGet a Studio chapter snapshot’s metadata and character timing alignments by project, chapter and snapshot IDs. Requires your own ElevenLabs connection.

Input Parameters

string
required
The ID of the chapter.
string
required
The ID of the Studio project.
string
required
The ID of the chapter snapshot.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_GET_CHAPTER_SNAPSHOTSRetrieves all saved version snapshots for a specific chapter within a given project, enabling review of its history or reversion to prior states.

Input Parameters

string
required
Identifier of the chapter for which snapshots are to be retrieved.
string
required
Identifier of the project containing the chapter.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_GET_CONVAI_AGENTRetrieve a Conversational AI agent by ID to inspect its settings, workflow, conversation configuration, and assigned channels. Optionally select a branch or version.

Input Parameters

string
required
The ID of the agent. This is returned on agent creation.
string
The ID of the branch to use. If not specified, uses the main branch.
string
The ID of the agent version to use. If not specified, uses the latest version.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_GET_CONVAI_AGENT_KNOWLEDGE_BASE_SIZETool to retrieve the number of pages in a conversational AI agent’s knowledge base. Use when you need to check the size of an agent’s knowledge base content.

Input Parameters

string
required
The unique identifier of the conversational AI agent.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_GET_CONVAI_AGENTS_SUMMARIESTool to retrieve summaries for specified Conversational AI agents. Use when you need to fetch metadata such as name, tags, creation time, access level, and archival status for one or more agents.

Input Parameters

array
required
List of agent IDs to fetch summaries for. At least one agent ID is required.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_GET_CONVAI_AGENTS_WIDGETTool to retrieve the widget configuration for a Conversational AI agent. Use when you need to fetch display settings, colors, text content, and behavior options for an agent’s embedded widget.

Input Parameters

string
required
The id of an agent. This is returned on agent creation.
string
An expiring token that enables a websocket conversation to start. These can be generated for an agent using the /v1/convai/conversation/get-signed-url endpoint

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_GET_CONVAI_AGENT_TESTING_BY_IDTool to retrieve an ElevenLabs Conversational AI agent response test by its ID. Use when you need to fetch details of a specific test including its configuration, type, and test parameters.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_GET_CONVAI_ANALYTICS_LIVE_COUNTTool to retrieve the live count of active ongoing Conversational AI conversations. Use when monitoring real-time conversation activity or checking current load.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_GET_CONVAI_BATCH_CALLINGTool to get detailed information about a batch call including all recipients. Use when you need to check the status, progress, or results of a previously submitted batch calling job.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_GET_CONVAI_BATCH_CALLING_WORKSPACEList a page of batch calls for the current workspace, including campaign names, agents and statuses. Use pagination to retrieve further results.

Input Parameters

integer
Maximum number of batch calls to return per page.
string
Document ID for pagination. Use the ‘next_doc’ value from a previous response to get the next page of results.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_GET_CONVAI_CONVERSATIONSTool to retrieve all conversations of agents that user owns. Use when you need to list conversations, optionally filtered by agent, time range, duration, rating, or other criteria. Supports pagination via cursor.

Input Parameters

string
Used for fetching next page. Cursor is returned in the response.
Full-text or fuzzy search over transcript messages.
string
Filter conversations by the user ID who initiated them.
string
The id of the agent you’re taking the action on. Use this to restrict results to a specific agent.
string
Filter conversations by branch ID.
integer
How many conversations to return at maximum. Can not exceed 100, defaults to 30.
string
Maximum overall rating (1-5).
string
Minimum overall rating (1-5).
string
Filter conversations by tool names used during the call.
string ("exclude" | "include")
Summary mode for conversation responses.
string
Filter conversations by detected main language (language code).
string
The result of the success evaluation. Filter by success status.
array
Evaluation filters. Supports multiple values (repeated query params). Format per value: criteria_id:result. Example: [‘value_framing:success’, ‘tone:professional’]
string
Filter conversations with user feedback comments.
string
Unix timestamp (in seconds) to filter conversations after to this start date.
string
Maximum call duration in seconds.
string
Minimum call duration in seconds.
string
Unix timestamp (in seconds) to filter conversations up to this start date.
array
Data collection filters. Supports multiple values (repeated query params). Format per value: id:op:value where op is one of eq|neq|gt|gte|lt|lte|in|exists|missing. For in, pipe-delimit values.
string
Filter conversations by initiation source.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_GET_CONVAI_KNOWLEDGE_BASETool to retrieve a list of available knowledge base documents. Use when you need to browse, search, or filter knowledge base documents by name, type, folder, or ownership. Supports pagination via cursor for large result sets.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_GET_CONVAI_KNOWLEDGE_BASE_CONTENTTool to retrieve the entire content of a document from the knowledge base. Use when you need to access or read the full text content of a knowledge base document.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_GET_CONVAI_KNOWLEDGE_BASE_DEPENDENT_AGENTSTool to retrieve a list of agents depending on a specific knowledge base document. Use when you need to identify which agents are using a particular document, either directly or transitively.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_GET_CONVAI_KNOWLEDGE_BASE_DOCUMENTATIONTool to get details about a specific documentation making up the agent’s knowledge base. Use when you need to retrieve information about a knowledge base document, including its content, type, and metadata.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_GET_CONVAI_KNOWLEDGE_BASE_RAG_INDEXTool to retrieve RAG index overview including total size and usage information. Use when you need to check storage limits, monitor usage, or understand which embedding models are consuming space in knowledge base documents.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_GET_CONVAI_KNOWLEDGE_BASE_RAG_INDEXESTool to retrieve all RAG indexes for a specified knowledge base document. Use when you need to view the indexing status, models used, and usage statistics for a document’s semantic search capabilities.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_GET_CONVAI_KNOWLEDGE_BASE_SOURCE_FILE_URLTool to get a signed URL to download the original source file of a file-type document from the knowledge base. Use when you need to download the original file that was uploaded to create a knowledge base document.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_GET_CONVAI_KNOWLEDGE_BASE_SUMMARIESTool to retrieve knowledge base document summaries by their IDs. Use when you need to get summaries for multiple knowledge base documents in a single request.

Input Parameters

array
required
The IDs of knowledge base documents to retrieve summaries for.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_GET_CONVAI_MCP_SERVERTool to retrieve a specific MCP server configuration from the workspace. Use when you need to inspect details of an existing MCP server including its URL, transport type, approval policies, and dependent agents.

Input Parameters

string
required
ID of the MCP Server.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_GET_CONVAI_MCP_SERVERSTool to retrieve all MCP (Model Context Protocol) server configurations available in the workspace. Use when you need to list all registered MCP servers or check which servers are available for conversational AI agents.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_GET_CONVAI_MCP_SERVER_TOOLSTool to retrieve all tools available for a specific MCP server configuration. Use when you need to inspect what tools an MCP server provides or verify tool availability before using them.

Input Parameters

string
required
ID of the MCP Server.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_GET_CONVAI_PHONE_NUMBER_BY_IDTool to retrieve detailed configuration for a specific phone number by ID. Use when you need to inspect a phone number’s provider details, capabilities, agent assignments, or SIP trunk configuration.

Input Parameters

string
required
The ID of the phone number. This is returned on phone number creation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_GET_CONVAI_SECRETSTool to retrieve all workspace secrets for the user. Use when you need to list stored secrets that can be used for authentication and integration with conversational AI agents. Supports pagination.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_GET_CONVAI_SETTINGSTool to retrieve Convai settings for the workspace. Use when you need to inspect webhook configurations, RAG retention settings, or MCP server capabilities.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_GET_CONVAI_SETTINGS_DASHBOARDTool to retrieve Convai dashboard settings for the workspace. Use when you need to inspect configured dashboard charts for monitoring conversational AI performance.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_GET_CONVAI_TEST_INVOCATIONSTool to list all test invocations for a specific conversational AI agent with pagination support. Use when you need to retrieve test invocation history, check test results, or paginate through large sets of test runs.

Input Parameters

string
Cursor for pagination. Use the next_cursor value from a previous response to fetch the next page of results.
string
required
Filter test invocations by agent ID. This is required to fetch test invocations for a specific agent.
integer
How many test invocations to return at maximum. Cannot exceed 100. Defaults to 30 if not specified.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_GET_CONVAI_TOOLTool to retrieve the complete configuration for a specific conversational AI tool by ID. Use when you need to inspect a tool’s settings, type, or usage statistics from the workspace.

Input Parameters

string
required
ID of the requested tool.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_GET_CONVAI_TOOLSTool to retrieve all available tools in the workspace. Use when you need to list, search, or discover tools that can be used with Conversational AI agents.

Input Parameters

string
Filter tools by type. Comma-separated list of tool types.
string
Cursor for pagination. Used to fetch the next page of results.
string
Filter tools whose names start with this string.
string
The field to sort the results by.
integer
How many tools to return at maximum. Cannot exceed 100, defaults to 30.
string ("asc" | "desc")
Sort direction options for listing tools.
boolean
If set to true, return only tools owned by you (not shared from others).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_GET_CONVAI_TOOLS_DEPENDENT_AGENTSTool to retrieve a list of agents depending on a specific tool. Use when you need to identify which agents are using a particular tool in their configuration.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_GET_CONVERSATION_AUDIODownload the audio recording of a particular conversation as a file. Requires your own ElevenLabs connection.

Input Parameters

string
required
The ID of the conversation whose audio recording to download.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_GET_CONVERSATION_BY_IDTool to fetch full details for a single Conversational AI conversation by ID. Use when you need transcript-level analysis, metadata, or audio status flags for a specific conversation.

Input Parameters

string
required
The unique identifier of the conversation to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_GET_CONVERSATION_SIGNED_URLTool to get a signed URL to start a conversation with an agent that requires authorization. Use when you need to obtain a secure WebSocket URL for initiating a conversation session.

Input Parameters

string
required
The id of the agent you’re taking the action on.
string
The ID of the branch to use
boolean
Whether to include a conversation_id with the response. If included, the conversation_signature cannot be used again.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_GET_CONVERSATION_SIP_MESSAGESGet a page of SIP messages associated with a conversation’s phone call. Pass next_cursor as cursor to retrieve subsequent pages. Requires your own ElevenLabs connection.

Input Parameters

string
Cursor returned by the previous page, if any.
integer
Maximum number of SIP messages per page (1–20).
string
required
The ID of the conversation whose phone call to inspect.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_GET_CONVERSATION_SUMMARYGet a lightweight conversation summary, success result and short chat transcript. Tool calls, tool results and contextual updates are excluded. Use the full conversation endpoint for a complete transcript. Requires your own ElevenLabs connection.

Input Parameters

integer
Maximum number of chat turns to include; longer conversations omit messages.
string
required
The ID of the conversation to summarize.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_GET_CONVERSATION_TOPICSGet an agent’s latest discovered conversation topics or aggregate daily discovery runs over a time window. Rank topics by volume, sentiment, success rate or frustration; pass next_cursor as cursor to page. Requires your own ElevenLabs connection.

Input Parameters

string
Cursor returned in the preceding response to fetch the next page.
string ("conversations" | "sentiment" | "success_rate" | "frustration")
Column to rank topics by. Topics without scores rank last.
string
required
ID of the agent.
integer
Number of top-level topic groups to return (1–100).
integer
End of the window in Unix seconds.
integer
Start of the window, floored to its UTC day. With to_unix_secs, aggregates completed daily discovery runs in the range. Omit both bounds for the latest run.
string ("asc" | "desc")
Sort direction. Use sentiment ascending for most negative topics or frustration descending for most frustrated.
boolean
Include per-criteria evaluation breakdowns. The weighted success_rate is returned either way.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_GET_CRAWL_JOBGet a knowledge-base crawl job’s configuration, status and page progress by ID. Requires your own ElevenLabs connection.

Input Parameters

string
required
The ID of the crawl job to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_GET_DEFAULT_VOICE_SETTINGSRetrieves the ElevenLabs text-to-speech service’s default voice settings (stability, similarity boost, style, speaker boost) that are applied when no voice-specific or request-specific settings are provided.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_GET_DELIVERABLESRetrieve a production order’s delivered files and time-limited download URLs. Returns an empty list if the order is not yet completed. Requires your own ElevenLabs connection.

Input Parameters

string
required
The ID of the production order.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_GET_DOCUMENT_DEPENDENCIES_IN_BULKList agents depending on any of up to twenty knowledge-base documents or folders. Filter direct/transitive dependencies and paginate with next_cursor. Requires your own ElevenLabs connection.

Input Parameters

string
Continuation cursor returned by the previous page.
integer
Maximum results per page (1–100).
array
required
One to twenty unique knowledge-base document or folder IDs.
string ("direct" | "transitive" | "all")
Type of dependent agents to return.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_GET_DUBBED_FILERetrieves an existing dubbed audio file for a specific dubbing_id and language_code.

Input Parameters

string
required
The unique identifier for the dubbing project from which to retrieve the audio.
string
required
The language code specifying the desired language of the dubbed audio file (e.g., ‘en’, ‘es’, ‘de-DE’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_GET_DUBBING_LANGUAGEGet a dubbing language target’s status, revisions, warnings and signed output URLs. URLs expire after one hour; re-read to refresh them. Prefer project webhooks over polling for completion. Requires your own ElevenLabs connection.

Input Parameters

string
required
Identifier of the parent dubbing project.
string
required
Identifier of the language target to fetch.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_GET_DUBBING_PROJECTGet full dubbing project details, including language target IDs and source preparation status. Prefer a webhook subscription to polling for ready status. Requires your own ElevenLabs connection.

Input Parameters

string
required
Identifier of the dubbing project to fetch.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_GET_DUBBING_PROJECT_METADATARetrieves metadata and status for a specific dubbing project by its ID.

Input Parameters

string
required
The unique identifier of the dubbing project whose metadata is to be retrieved.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_GET_DUBBING_TRANSCRIPTGet a dubbing project’s source transcript as editable segments, with speaker IDs, timings and revision. Available once the project is ready. Requires your own ElevenLabs connection.

Input Parameters

string
required
Identifier of the dubbing project.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_GET_DUBBING_TRANSCRIPTS_FORMATRetrieves the transcript for a specific dubbing project and language in the requested format (SRT, WebVTT, or JSON). Use this when you need subtitles or detailed transcript data with timing information for a dubbed video or audio.

Input Parameters

string
required
ID of the dubbing project.
string ("srt" | "webvtt" | "json")
required
Format to return transcript in. For subtitles use either ‘srt’ or ‘webvtt’, and for a full transcript use ‘json’. The ‘json’ format is not yet supported for Dubbing Studio.
string
required
ISO-693 language code to retrieve the transcript for. Use ‘source’ to fetch the transcript of the original media.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_GET_ENVIRONMENT_VARIABLERetrieve one environment variable by ID, including its named values or secret/authentication references. Requires your own ElevenLabs connection.

Input Parameters

string
required
ID of the environment variable to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_GET_GENERATED_ITEMSRetrieves metadata for a list of generated audio items from history, supporting pagination and optional filtering by voice ID.

Input Parameters

string
Filters the history items to only include those generated with the specified voice ID. You can obtain voice IDs by listing available voices (e.g., using an action to get voices from https://api.elevenlabs.io/v1/voices).
integer
Specifies the maximum number of history items to return per page. The value must be between 1 and 1000, inclusive.
string
The ID of the history item to start fetching results after, for pagination. If not provided, items are fetched from the most recent, ordered by creation date in descending order.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_GET_HISTORY_ITEM_BY_IDRetrieves detailed information (excluding the audio file) for a specific audio generation history item from ElevenLabs, using its unique ID.

Input Parameters

string
required
Unique identifier of the history item to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_GET_IMAGE_GENERATIONRetrieve an image generation’s status and its signed output URL when completed. Requires your own ElevenLabs connection.

Input Parameters

string
required
The ID of the image generation to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_GET_ISOLATION_HISTORYList your audio isolation generations with optional title/text search and pagination. Page numbers apply only when search is provided. Requires your own ElevenLabs connection.

Input Parameters

integer
1-based page number. Only used when search is provided.
string
Optional search term filtering audio isolation history by title/text.
integer
Maximum number of history items to return (1–1000; default 100).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_GET_MCP_TOOL_CONFIGTool to retrieve configuration overrides for a specific MCP tool within an MCP server. Use when you need to inspect the custom execution settings for individual tools.

Input Parameters

string
required
Name of the MCP tool to retrieve config overrides for
string
required
ID of the MCP Server

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_GET_MEDIA_INFORMATIONRetrieve metadata and a time-limited download URL for previously uploaded order media. Requires your own ElevenLabs connection.

Input Parameters

string
required
The ID of the media file.
string
required
The ID of the order.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_GET_METADATA_FOR_A_PRONUNCIATION_DICTIONARYRetrieves metadata for a specific, existing pronunciation dictionary from ElevenLabs using its ID.

Input Parameters

string
required
The unique identifier of the pronunciation dictionary for which to retrieve metadata.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_GET_MODELSRetrieves a detailed list of all available ElevenLabs text-to-speech (TTS) models and their capabilities.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_GET_MUSIC_FINETUNERetrieve a music finetune by ID, including training status, progress and failure reason. Requires your own ElevenLabs connection.

Input Parameters

string
required
The ID of the music finetune to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_GET_MUTED_TRACKSList chapter IDs with muted tracks in a Studio project. Returns the full list without pagination. Requires your own ElevenLabs connection.

Input Parameters

string
required
The ID of the Studio project.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_GET_PHONE_SIP_MESSAGESGet one page of SIP messages for an imported phone number. Pass next_cursor as cursor to fetch another page. Requires your own ElevenLabs connection.

Input Parameters

string
Cursor returned by a previous page for fetching the next page.
integer
Number of SIP messages per page (1–20).
string
required
The phone number ID returned when a phone number is imported.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_GET_PRODUCTION_ORDERRetrieve full Productions order details, including item configurations and available quotes. Quotes may require polling before they become available. Requires your own ElevenLabs connection.

Input Parameters

string
required
The ID of the Productions order.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_GET_PROJECT_BY_IDUse to retrieve all details for a specific project, including its chapters and their conversion statuses, by providing the project’s unique ID.

Input Parameters

string
required
Unique identifier for the project. To list all available projects and their IDs, you can use the endpoint that lists all projects (e.g., GET /v1/projects).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_GET_PROJECTSFetches a list of all projects and their details associated with the user’s ElevenLabs account; this is a read-only operation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_GET_PROJECT_SNAPSHOTGet a Studio project snapshot’s metadata, audio duration, and character alignments. Requires your own ElevenLabs connection.

Input Parameters

string
required
The ID of the Studio project.
string
required
The ID of the Studio project snapshot.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_GET_PROJECT_SNAPSHOTSRetrieves all available snapshots (saved states or versions) for an existing project, enabling history tracking, version comparison, or accessing specific states for playback/processing, particularly in text-to-speech workflows.

Input Parameters

string
required
Identifier of the project for which to retrieve snapshots. You can obtain project_ids by querying the GET /v1/studio/projects endpoint to list all available projects.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_GET_PRONUNCIATION_DICTIONARIESRetrieves a paginated list of pronunciation dictionaries, used to customize how specific words or phrases are pronounced by the text-to-speech (TTS) engine.

Input Parameters

string
Cursor for pagination, obtained from a previous response, to fetch the next set of pronunciation dictionaries. Omit or leave empty to retrieve the first page.
integer
The number of pronunciation dictionaries to retrieve per page, with a maximum value of 100.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_GET_PRONUNCIATION_DICT_VERSIONDownloads the Pronunciation Lexicon Specification (PLS) file for an existing version of a pronunciation dictionary from ElevenLabs, used to customize TTS pronunciation.

Input Parameters

string
required
The unique identifier of the specific version of the pronunciation dictionary.
string
required
The unique identifier of the pronunciation dictionary.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_GET_RAG_CHUNKRetrieve a specific RAG chunk’s ID, name and content from a knowledge-base document. Optionally select the embedding model used to retrieve it. Requires your own ElevenLabs connection.

Input Parameters

string
required
The ID of the document’s RAG chunk.
string ("e5_mistral_7b_instruct" | "multilingual_e5_large_instruct")
The embedding model used to retrieve the chunk.
string
required
The ID of a knowledge-base document, returned on document addition.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_GET_SAMPLE_AUDIORetrieve the first 30 seconds of a professional voice sample as base64 audio, optionally removing background noise. Requires your own ElevenLabs connection.

Input Parameters

string
required
Voice ID to be used; list available voices with GET /v1/voices.
string
required
Sample ID to be used.
boolean
Remove background noise using the audio isolation model. May worsen quality when samples contain no background noise.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_GET_SAMPLE_WAVEFORMRetrieve the visual waveform of a professional voice clone sample. Requires your own ElevenLabs connection.

Input Parameters

string
required
Voice ID to be used; list available voices with the voices endpoint.
string
required
Sample ID to be used.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_GET_SAVED_TRANSCRIPTRetrieve a previously generated transcript by ID, including text, word timings and available channel details. Requires your own ElevenLabs connection.

Input Parameters

string
required
The unique ID of the transcript to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_GET_SECRETRetrieve a workspace secret’s name, ID, and dependency previews by ID. Returns metadata only, never the raw secret value. Requires your own ElevenLabs connection.

Input Parameters

string
required
ID of the workspace secret to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_GET_SECRET_DEPENDENCIESList one page of resources that depend on a secret, filtered by tools, agents, or phone numbers. Pass next_cursor as cursor to continue. Requires your own ElevenLabs connection.

Input Parameters

string
Cursor from the previous page’s next_cursor.
integer
Maximum dependencies per page (1–100).
string
required
ID of the secret to inspect.
string ("tools" | "agents" | "phone_numbers")
required
Type of dependent resources to list.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_GET_SEPARATED_SPEAKER_AUDIORetrieve a speaker’s separated sample audio as base64, with media type and duration. Requires your own ElevenLabs connection.

Input Parameters

string
required
The professional voice clone’s voice ID.
string
required
The voice sample ID.
string
required
The separated speaker ID in the sample.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_GET_SERVICE_ACCOUNTSTool to list all service accounts in the workspace. Use when you need to view service accounts, their associated API keys, or manage workspace access.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_GET_SHARED_VOICESRetrieves a paginated and filterable list of shared voices from the ElevenLabs Voice Library.

Input Parameters

string
Filters voices by age group.
integer
Page number for pagination, starting from 0.
string ("created_date" | "usage_character_count_1y" | "trending" | "cloned_by_count")
Valid sort options for shared voices.
string
Filters voices by accent.
string
Filters voices by gender.
string
A search term to filter voices by name or description.
string
Filters voices by category.
Filters for voices that are marked as featured.
string
Filters voices by language (ISO 639-1 code).
string
Filters voices by the public ID of their owner.
integer
Maximum number of shared voices per page (max 100).
array
Filters voices by their intended use cases.
array
Filters voices by descriptive tags.
boolean
Filters for voices that are enabled for the reader application.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_GET_SPEAKER_SEPARATION_STATUSRetrieve a professional voice sample’s speaker separation status and detected speakers when complete. Requires your own ElevenLabs connection.

Input Parameters

string
required
ID of the professional voice containing the sample.
string
required
ID of the voice sample to inspect.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_GET_SPEECH_ENGINERetrieve one speech engine’s configuration, including ASR, TTS, turn detection, privacy and access settings. Accepts a seng_ or agent_ ID. Requires your own ElevenLabs connection.

Input Parameters

string
required
The speech engine ID (accepts seng_ or agent_ prefix).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_GET_SSO_PROVIDER_ADMINRetrieves the SSO provider configuration for a specified workspace, typically for review purposes, and will indicate if no configuration exists.

Input Parameters

string
required
The unique identifier of the workspace for which to retrieve the SSO provider configuration.
string
required
The admin URL prefix for the workspace. This is typically ‘v1’ for the standard API version.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_GET_STUDIO_PROJECTGet detailed information for one Studio project, including chapters, voices, assets, and conversion status. Supply its project ID and optionally its share ID. Requires your own ElevenLabs connection.

Input Parameters

string
The share ID of the project
string
required
The ID of the Studio project.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_GET_SUMMARIES_CONVAI_AGENT_TESTING_SUMMARIESTool to retrieve multiple agent response test summaries by their IDs. Use when you need to fetch summary information for multiple tests in a single request. Returns a dictionary mapping test IDs to their summary details including name, type, and timestamps.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_GET_TAGRetrieve a conversation tag by ID, including its title, description, owner and creation time. Requires your own ElevenLabs connection.

Input Parameters

string
required
The ID of the conversation tag to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_GET_TEMPLATERetrieve a flows template and its runnable versions’ input/output ports. Accepts accessible shared-link and Explore templates, even when absent from template listings. Requires your own ElevenLabs connection.

Input Parameters

string
required
Template ID from the app or GET /v1/flows/templates.
integer
Number of published runnable versions to return, newest first (1–10).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_GET_TEMPLATE_RUNRetrieve a template run’s aggregate status and individual outputs, including completed media download URLs. Requires your own ElevenLabs connection.

Input Parameters

string
required
The ID of the template run to retrieve.
string
required
The template ID shown in the ElevenLabs app or GET /v1/flows/templates.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_GET_TEST_FOLDERGet an agent test folder by ID, including its folder path and direct child count. Requires your own ElevenLabs connection.

Input Parameters

string
required
The folder ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_GET_TEST_INVOCATIONGet a test invocation by ID, including its test runs, results and bucketing status. Requires your own ElevenLabs connection.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_GET_TOOL_EXECUTIONSGet a page of execution history for a tool, optionally filtered by agent, branch, error status and time. Pass next_cursor as cursor to fetch subsequent pages. Requires your own ElevenLabs connection.

Input Parameters

string
Next-page cursor from a previous response.
string
required
ID of the requested tool.
string
Filter by agent ID.
number
Inclusive ending Unix timestamp.
boolean
Filter by error status; omit to return all executions.
string
Filter by agent branch ID.
integer
Maximum executions per page, from 1 to 100; defaults to 30.
number
Inclusive starting Unix timestamp.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_GET_TRANSCRIPT_FOR_DUBDeprecated by the provider; no sunset date is announced. Retrieves the textual transcript for a specified dubbing project and language, if one exists for that language in the project.

Input Parameters

string
required
The unique identifier for the dubbing project.
string
required
The ISO 639-1 language code for which to retrieve the transcript.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_GET_TRANSLATED_TRANSCRIPTGet a dubbing language target’s source segments and translations in playback order. Available once the target has produced output; returns a conflict during its first dub. Requires your own ElevenLabs connection.

Input Parameters

string
required
Identifier of the dubbing project.
string
required
Identifier of the language target.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_GET_TRIAGE_TICKETGet an agent conversation triage ticket by ID, including comments and status history. Requires your own ElevenLabs connection.

Input Parameters

string
required
ID of the conversation triage ticket.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_GET_USAGE_CHARACTER_STATSTool to retrieve usage metrics for the current user or entire workspace. Returns time-series data with configurable aggregation intervals and breakdown types. Use when analyzing character usage patterns, tracking consumption by voice, user, or other dimensions over time.

Input Parameters

string ("credits" | "tts_characters" | "minutes_used" | "request_count" | "ttfb_avg" | "ttfb_p95" | "fiat_units_spent" | "concurrency" | "concurrency_average")
Which metric to aggregate.
integer
required
UTC Unix timestamp for the end of the usage window, in milliseconds. To include the last day of the window, the timestamp should be at 23:59:59 of that day.
integer
required
UTC Unix timestamp for the start of the usage window, in milliseconds. To include the first day of the window, the timestamp should be at 00:00:00 of that day.
string ("none" | "voice" | "voice_multiplier" | "user" | "groups" | "api_keys" | "all_api_keys" | "product_type" | "model" | "resource" | "request_queue" | "region" | "subresource_id" | "reporting_workspace_id" | "has_api_key" | "request_source")
Breakdown type for usage statistics.
string ("hour" | "day" | "week" | "month" | "cumulative")
Aggregation interval for usage data over time.
string
Aggregation bucket size in seconds. Overrides the aggregation interval.
boolean
Whether or not to include the statistics of the entire workspace. Default is false.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_GET_USER_INFORetrieves detailed information about the authenticated ElevenLabs user’s account, including subscription, usage, and status.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_GET_USER_SUBSCRIPTION_INFORetrieves detailed subscription information for the currently authenticated ElevenLabs user.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_GET_VERIFICATION_CAPTCHAGet a captcha for professional voice clone (PVC) verification. The provider documents no response body. Requires your own ElevenLabs connection.

Input Parameters

string
required
Voice ID for professional voice clone verification. Use the list voices endpoint to find available IDs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_GET_VIDEO_GENERATIONRetrieve a video generation’s pending, generating, completed, or failed status. Completed generations include a signed output URL valid for about an hour. Requires your own ElevenLabs connection.

Input Parameters

string
required
The ID of the video generation to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_GET_VOICERetrieves comprehensive details for a specific, existing voice by its voice_id, optionally including its settings.

Input Parameters

string
required
Identifier of the voice. Use the GET /v1/voices endpoint to list available IDs.
boolean
If true, the response will include detailed settings information for the voice.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_GET_VOICE_COLLECTIONGet a voice collection you can access by its ID, including its title, icon, and your access role.

Input Parameters

string
required
The ID of the voice collection to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_GET_VOICESRetrieves a list of all available voices along with their detailed attributes and settings.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_GET_VOICE_SETTINGSRetrieves the stability, similarity, style, and speaker boost settings for a specific, existing ElevenLabs voice using its voice_id.

Input Parameters

string
required
Identifier of the voice for which to retrieve settings. A list of available voice IDs can be obtained from the /v1/voices endpoint.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_GET_WHATSAPP_ACCOUNTGet a WhatsApp account’s details, assigned agent and messaging settings by phone number ID. Requires your own ElevenLabs connection.

Input Parameters

string
required
The WhatsApp phone number ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_GET_WORKSPACE_RESOURCETool to get metadata of a workspace resource by ID and type. Use when you need access control information, creator details, or sharing options for a specific resource.

Input Parameters

string
required
The ID of the target resource.
string ("voice" | "voice_collection" | "pronunciation_dictionary" | "dubbing" | "dubbing_project" | "project" | "convai_agents" | "convai_knowledge_base_documents" | "convai_tools" | "convai_settings" | "convai_secrets" | "workspace_auth_connections" | "convai_phone_numbers" | "convai_mcp_servers" | "convai_api_integration_connections" | "convai_api_integration_trigger_connections" | "convai_batch_calls" | "convai_agent_response_tests" | "convai_test_suite_invocations" | "convai_crawl_jobs" | "convai_crawl_tasks" | "convai_whatsapp_accounts" | "convai_agent_versions" | "convai_agent_branches" | "convai_agent_versions_deployments" | "dashboard" | "dashboard_configuration" | "convai_agent_drafts" | "resource_locators" | "assets" | "content_generations" | "content_templates")
required
Resource type of the target resource.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_GET_WORKSPACE_USAGEGet workspace credit usage over time as a table, with optional grouping and filters. Requires your own ElevenLabs connection.

Input Parameters

array
Column comparisons restricting the usage query.
integer
required
End of the time range as a Unix timestamp in milliseconds; at least 2020-01-01.
array
Dimensions to group credit usage by.
string
IANA time zone (for example America/New_York) aligning eligible bucket boundaries. Week multiples start Monday at local midnight; whole-day multiples start at midnight; whole-hour multiples up to 24 hours align to local hours. Other sizes remain UTC-anchored.
integer
required
Start of the time range as a Unix timestamp in milliseconds; at least 2020-01-01.
integer
Bucket size in seconds. Week multiples start Monday at local midnight; whole-day multiples align to local midnight; whole-hour multiples up to 24 hours align to local hour boundaries. Other sizes remain UTC-anchored.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_GET_WORKSPACE_WEBHOOKSTool to list all webhooks configured for the workspace. Use when you need to view existing webhook configurations or verify webhook settings.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_INVITE_USEREmail an invitation to join your workspace. Acceptance consumes a subscription seat. Requires WORKSPACE_MEMBERS_INVITE permission and your own ElevenLabs connection; existing members return HTTP 400.

Input Parameters

string
required
The email of the customer to invite.
array
The group IDs of the user.
string ("workspace_admin" | "workspace_member" | "workspace_lite_member")
The seat type of the user.
integer
Monthly credit usage limit for the invitee. Omit or set to null for no custom cap.
string
Deprecated workspace permission of the user; use seat_type instead.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_INVITE_USERS_IN_BULKSend email invitations to multiple users to join your workspace. All addresses must belong to a verified domain. Accepting an invitation consumes a subscription seat; new users are prompted to create an account. Requires workspace member invite permission and your own ElevenLabs connection.

Input Parameters

array
required
Email addresses to invite to the workspace.
array
The group IDs of the invited users.
string ("workspace_admin" | "workspace_member" | "workspace_lite_member")
The seat type of the invited users.
integer
Monthly credit usage limit for each invitee. Omit or set to null for no custom cap.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_ISOLATE_AUDIORemove background noise from an audio file and download the isolated vocals/speech. Uses your own ElevenLabs connection.

Input Parameters

object
required
The audio file from which vocals/speech will be isolated.
string ("pcm_s16le_16" | "other")
Input audio format. Use pcm_s16le_16 for raw 16-bit PCM at 16 kHz, mono, little-endian (lower latency), or other for encoded waveform formats.
string
Optional base64 preview image for tracking this generation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_LIST_AGENT_BRANCHESList up to 100 agent branches. ElevenLabs returns a bounded result without a continuation parameter.

Input Parameters

integer
Maximum branches to return (2-100).
string
required
Agent ID returned when the agent was created.
boolean
Whether to include archived branches.
boolean
Whether to compute each branch’s commits ahead of and behind main.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_LIST_AGENT_BRANCH_PROCEDURESList procedure summaries attached to an ElevenLabs agent branch. Results omit procedure content; use Get Agent Branch Procedure with a returned procedure ID to read it.

Input Parameters

string
required
Agent ID.
string
required
Agent branch ID.
string
Published agent version to inspect; omit for draft-aware branch state.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_LIST_AGENT_TICKETSList an agent’s conversation performance triage tickets for Architect, not end-user support tickets. Filter or search tickets and paginate with next_cursor while has_more is true. Requires your own ElevenLabs connection.

Input Parameters

string
Filter by an exact label.
string
Next-page cursor returned by a previous response.
string
Case-insensitive search across title, description, comments, and turn comments.
string ("open" | "in_progress" | "resolved" | "cancelled" | "merged")
Filter tickets by status.
string ("created_at" | "priority")
Sort newest first, or most urgent first then newest first.
array
Filter by ticket sources; sent as repeated query parameters.
string
required
ID of the agent whose triage tickets to list.
integer
Number of tickets to return, from 1 to 100.
string ("knowledge_gap" | "incorrect_information" | "documentation_gap" | "product_feedback" | "platform_bug" | "tool_issue" | "missing_tool" | "unnecessary_escalation" | "wrong_action")
Filter by issue type.
array
Filter by priorities; sent as repeated query parameters.
string
Filter by creator; use ‘agent’ for agent-raised tickets.
string
Filter by conversation ID.
string
Filter by assignee; use ‘unassigned’ for tickets without an assignee.
string
Filter tickets merged into this ticket.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_LIST_API_REQUESTSList workspace API requests as a table, filtering by time, columns, or search. Supply at least one time bound in Unix milliseconds. Results are timestamp-ordered; use sort to override the default. Requires your own ElevenLabs connection.

Input Parameters

string ("asc" | "desc")
Timestamp order; defaults to desc when end_time is provided, otherwise asc.
integer
Maximum number of requests to return.
string
Search terms for API requests.
array
Column filters.
integer
End of the time range as a Unix timestamp in milliseconds.
integer
Start of the time range as a Unix timestamp in milliseconds.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_LIST_ASSETSList workspace assets, newest first, optionally searching names. Returns one page; pass next_cursor as cursor for subsequent pages. Requires your own ElevenLabs connection.

Input Parameters

string
Token from a previous response’s next_cursor. Omit to fetch the first page.
string
Optional free-text search filter over asset names.
integer
Number of assets to return.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_LIST_ASSIGNABLE_TICKET_USERSList non-service-account workspace members for an agent’s ticket assignment. Includes members without viewer access, flagged by has_access; grant access before assigning them. Requires your own ElevenLabs connection.

Input Parameters

string
required
The agent whose ticket assignees to list.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_LIST_ASYNC_SPEECH_GENERATIONSList speech generations created through the async API, newest first. Filter by status or model; pass next_cursor as cursor for subsequent pages. Requires your own ElevenLabs connection.

Input Parameters

string
Pagination cursor from the previous response’s next_cursor; omit for the first page.
string ("pending" | "generating" | "completed" | "failed")
Only return generations with this lifecycle status.
string
Only return generations of this model.
integer
How many generations to return per page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_LIST_AUDIO_EFFECTSList filter presets, reverb environments, and background noises usable in Text to Speech, Text to Dialogue, and agent audio_effects configurations. Requires your own ElevenLabs connection.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_LIST_CHAPTER_SNAPSHOTSList all snapshots of a Studio chapter, including IDs, names and creation times. Snapshots are created automatically when a chapter is converted and can be downloaded as audio using the snapshot audio actions. Requires your own ElevenLabs connection.

Input Parameters

string
required
The ID of the chapter.
string
required
The ID of the Studio project.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_LIST_CONVAI_AGENT_TESTINGTool to list all agent response tests with pagination support and optional search filtering. Use when you need to retrieve available tests, search tests by name, or paginate through large test collections.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_LIST_CONVAI_LLMSList language models available for configuring ElevenLabs Conversational AI agents.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_LIST_CONVERSATION_USERSList distinct conversation users with contact details and sentiment aggregates. Filter and sort results, then pass next_cursor as cursor to fetch another page. Requires your own ElevenLabs connection.

Input Parameters

string
Cursor returned by the previous page to fetch the next page.
string
Filter by user ID using an exact match.
string ("last_contact_unix_secs" | "conversation_count" | "average_sentiment_score")
Field to sort the users by.
string
Filter by agent ID (agent_…) or speech engine external ID (seng_).
string
Filter conversations by branch ID.
integer
Maximum users per page; defaults to 30.
string ("asc" | "desc")
Sort direction; defaults to descending.
integer
Filter conversations after this start date in Unix seconds.
integer
Filter conversations up to this start date in Unix seconds.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_LIST_CRAWL_JOBSList the user’s ongoing and recent knowledge-base crawl jobs. Pass next_cursor as cursor to fetch another page, and include_job_ids to include additional jobs. Requires your own ElevenLabs connection.

Input Parameters

string
Pagination cursor returned by the preceding response.
integer
Maximum jobs per page, from 1 to 100; defaults to 30.
array
IDs of additional crawl jobs to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_LIST_DEPLOYMENTSList an agent’s deployment traffic split history, newest first. Use page and page_size to paginate. Requires your own ElevenLabs connection.

Input Parameters

integer
Page number, starting at 1.
string
required
The agent ID returned on agent creation.
integer
Maximum results per page (1–100).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_LIST_DUBBING_LANGUAGESList a dubbing project’s language targets and statuses, with signed output URLs once available. Pass next_cursor as cursor to fetch the next page. Requires your own ElevenLabs connection.

Input Parameters

string
Pass next_cursor from the previous page; omit for the first page.
string
Filter by queued, processing, completed, stale, or failed; omit for all statuses.
integer
Number of language targets per page; the provider clamps to 1–100 rather than rejecting.
string
required
Identifier of the parent dubbing project.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_LIST_DUBBING_PROJECTSList accessible workspace dubbing projects with cursor pagination, newest first by default. Listed projects have no language IDs; fetch the project or list its language targets for those. Requires your own ElevenLabs connection.

Input Parameters

string
Opaque next_cursor from the previous page; omit for the first page.
string
Filter by queued, preparing, ready, or failed; omit for all statuses.
integer
Projects per page; the provider clamps this to between 1 and 100.
string ("ASCENDING" | "DESCENDING")
Creation-time sort order; newest first by default.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_LIST_DUBSTool to list dubbing projects you have access to. Use when you need to retrieve dubs, check their status, or paginate through available dubbing projects.

Input Parameters

string
Cursor for pagination. Use the next_cursor value from a previous response to fetch the next page.
string
The field to use for ordering results from this query.
integer
Number of dubs to return per page. Cannot exceed 200, defaults to 100.
string ("dubbing" | "dubbed" | "failed")
Status of the dubbing project.
string ("DESCENDING" | "ASCENDING")
Order direction for results.
string ("personal" | "others" | "all")
Filter for who created the dubbing projects.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_LIST_ENVIRONMENTSList workspace environments, including production, with optional last-update and creator details. Returns the full list without pagination. Requires your own ElevenLabs connection.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_LIST_ENVIRONMENT_VARIABLESList one page of workspace environment variables, optionally filtering by label, environment, or type. Use next_cursor to retrieve subsequent pages. Requires your own ElevenLabs connection.

Input Parameters

string ("string" | "secret" | "auth_connection")
Filter by variable type.
string
Filter by exact label match.
string
Pagination cursor from the previous response.
integer
Number of items to return (1-100).
string
Filter to variables with this environment; returned values only contain this environment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_LIST_IMAGE_GENERATIONSList image generations created through the API, newest first, with optional status and model filters. Pass next_cursor as cursor to retrieve another page. Requires your own ElevenLabs connection.

Input Parameters

string
Previous response’s next_cursor; omit for the first page.
string ("pending" | "generating" | "completed" | "failed")
Only return generations with this lifecycle status.
string
Only return generations of this model.
integer
Number of generations per page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_LIST_MEMBERSList all workspace members, including locked members, with their roles and owner status. Service accounts are excluded. Requires your own ElevenLabs connection.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_LIST_MUSIC_FINETUNESList your own, workspace-shared, and ElevenLabs-curated music finetunes with optional filters and sorting. Returns one page; pass next_cursor as cursor to continue. Requires your own ElevenLabs connection.

Input Parameters

string ("created_at" | "name")
Field used to sort the results.
string
Cursor returned by the previous page.
integer
Number of finetunes to return (1–150).
string ("self" | "workspace" | "elevenlabs")
Filter finetunes created by you, workspace teammates, or ElevenLabs; omit for all creators.
string ("private" | "workspace" | "public")
Filter private, workspace-shared, or public curated finetunes; omit for all accessible finetunes.
string ("asc" | "desc")
Ascending or descending sort direction.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_LIST_PHONE_NUMBERSTool to list all imported phone numbers in the workspace. Use when you need to find available phone numbers, check their capabilities (inbound/outbound), or verify which agent is assigned to a number.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_LIST_PRODUCTION_LANGUAGESList available production languages for dubbing, subtitles or transcription. Returns single languages or source-to-destination pairs. Requires your own ElevenLabs connection.

Input Parameters

string ("dub" | "subtitles" | "transcription")
required
The kind of production order item.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_LIST_PRODUCTION_ORDERSList Productions orders in your workspace, optionally filtering by statuses and creation dates. Use page_size and offset to paginate. Requires your own ElevenLabs connection.

Input Parameters

integer
Number of orders to skip for pagination.
array
Filter orders by one or more statuses.
string
Filter orders created on or before this date.
integer
Maximum number of orders to return per page.
string
Filter orders created on or after this date.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_LIST_RAG_CHUNKSList a page of RAG chunks for a knowledge base document and embedding model. Pass next_cursor as cursor to retrieve another page. Requires your own ElevenLabs connection.

Input Parameters

string
Cursor returned by the previous response for fetching the next page.
integer
Maximum documents to return; between 1 and 100, default 30.
string ("e5_mistral_7b_instruct" | "multilingual_e5_large_instruct")
required
The embedding model used to retrieve the chunks.
string
required
The ID of a knowledge base document, returned on document addition.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_LIST_SPEECH_ENGINESList a page of Speech Engines with voice, tags, timestamps and access information. Filter by name or sort results; pass next_cursor as cursor to retrieve the next page. Requires your own ElevenLabs connection.

Input Parameters

string
Next-page cursor returned by a previous response.
string
Filter engines by name.
string ("name" | "created_at" | "updated_at" | "call_count_7d")
Field by which to sort the results.
integer
Maximum results per page (at most 100).
string ("asc" | "desc")
Direction in which to sort the results.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_LIST_TAGSList workspace conversation tags, newest first. Returns one page; pass next_cursor as cursor to continue. Requires your own ElevenLabs connection.

Input Parameters

string
Cursor returned by the previous page; omit for the first page.
integer
How many conversation tags to return (1–100).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_LIST_TEMPLATE_RUNSList a template’s runs created through the public API, newest first. Use next_cursor as cursor to paginate and version_id to filter. Requires your own ElevenLabs connection.

Input Parameters

string
Previous page’s next_cursor; omit for the first page.
integer
Number of runs to return per page.
string
Only return runs of this template version ID.
string
required
Template ID from the app or GET /v1/flows/templates.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_LIST_TEMPLATESList published flow templates in your workspace and their runnable versions’ input/output schemas. Follow next_cursor while has_more is true, even for empty pages. Link-shared or other-workspace Explore templates are not listed. Requires your own ElevenLabs connection.

Input Parameters

string
Previous next_cursor; omit for the first page.
string
Filter template name or description by this text.
integer
Maximum templates per page.
integer
Published versions per template, newest first.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_LIST_VIDEO_GENERATIONSList video generations created through the API, newest first, optionally filtered by status or model. Pass next_cursor as cursor to fetch another page. Requires your own ElevenLabs connection.

Input Parameters

string
Pagination cursor from next_cursor on the previous page. Omit for the first page.
string ("pending" | "generating" | "completed" | "failed")
Only return generations with this lifecycle status.
string
Only return generations of this model.
integer
Number of generations per page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_LIST_VOICE_ACCENTSList available accents in the shared voice library, optionally filtered by language and model. Requires your own ElevenLabs connection.

Input Parameters

string
If provided, only accents for this language code are returned.
string
If provided, returns the accents available for this model. Defaults to the most complete accent list when omitted.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_LIST_VOICE_COLLECTIONSList all voice collections you can access, sorted by title, including your access role. The endpoint returns the full list without pagination.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_LIST_WHATSAPP_ACCOUNTSTool to list all WhatsApp accounts in the workspace. Use when you need to view available WhatsApp Business accounts, check which agents are assigned to WhatsApp numbers, or retrieve WhatsApp phone number details.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_LIST_WORKSPACE_GROUPSList all groups in the workspace, including membership, permissions, limits and SCIM details. Returns a map without pagination. Requires your own ElevenLabs connection.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_LIST_WORKSPACE_TICKETSList conversation triage tickets across the workspace, omitting agents you cannot access. Supports filters, search, sorting and cursor pagination. Requires your own ElevenLabs connection.

Input Parameters

string
Filter by an exact label.
string
Next-page cursor from the preceding response.
string
Case-insensitive search across title, description, comments and turn comments.
string ("open" | "in_progress" | "resolved" | "cancelled" | "merged")
Filter tickets by status.
string ("created_at" | "priority")
Sort newest first, or by urgency then newest first.
array
Filter by sources; sent as repeated query parameters.
string
Only tickets for this agent.
integer
Number of tickets to return (1–100).
string ("knowledge_gap" | "incorrect_information" | "documentation_gap" | "product_feedback" | "platform_bug" | "tool_issue" | "missing_tool" | "unnecessary_escalation" | "wrong_action")
Filter by issue type.
array
Filter by priorities; sent as repeated query parameters.
string
Filter by creator; use ‘agent’ for agent-raised tickets.
string
Filter by assignee; use ‘unassigned’ for unassigned tickets.
string
Filter tickets merged into this ticket.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_MERGE_BRANCHESMerge an agent’s source branch into a target branch. By default, archives the source after merging; force overrides timestamp-based conflict resolution. Requires your own ElevenLabs connection.

Input Parameters

boolean
Force source branch changes onto the target, overriding timestamp-based conflict resolution.
string
required
The ID of the agent returned on creation.
string
required
Unique identifier for the source branch to merge from.
string
required
The ID of the target branch to merge into.
boolean
Whether to archive the source branch after merging.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_MERGE_TICKETSMerge open tickets of the same agent into a pending, in-progress, or resolved ticket. Moves their conversations, raises priority to the highest, and preserves sources as merged. Requires viewer access to the agent and your own ElevenLabs connection.

Input Parameters

string
required
Destination ticket ID.
array
required
Open tickets of the same agent to fold into this one. They remain with status merged, pointing at the destination.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_MOVE_BULK_CONVAI_KNOWLEDGE_BASETool to move multiple documents or folders from one folder to another in the knowledge base. Use when you need to reorganize multiple knowledge base items at once by moving them to a different folder or to the root level.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_MOVE_CONVAI_KNOWLEDGE_BASETool to move a knowledge base document or folder to a different folder. Use when you need to reorganize your knowledge base by moving entities between folders or to the root level.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_MOVE_TESTS_IN_BULKMove multiple tests or folders to a destination folder, or to root when omitted. Requires your own ElevenLabs connection.

Input Parameters

string
The destination folder ID. Omit or pass null to move entities to the root folder.
array
required
The unique IDs of tests or folders to move.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_OUTBOUND_CALLTool to place an outbound call via SIP trunk. Use when you need to initiate a voice call through an ElevenLabs agent after obtaining required IDs. Prerequisites: - The API key must have Conversational AI (convai) permissions enabled. For write operations like initiating calls, ensure your API key has the appropriate convai write scope. - A valid SIP trunk phone number must be configured for outbound calls in ElevenLabs. - The SIP trunk must have valid outbound configuration with proper address and credentials. - The agent must be properly configured in the Conversational AI platform.

Input Parameters

string
required
Agent ID to place the call with (retrieve via Agents API).
string
required
Destination phone number in E.164 format to call.
string
required
ID of the phone number to originate the call from (must support outbound calls).
object
Personalization and override payload for initiating a conversation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_PAGINATE_PHONE_NUMBERSRetrieve one page of phone numbers with optional search, agent, provider and sorting filters. Pass next_cursor as cursor to fetch the next page. Requires your own ElevenLabs connection.

Input Parameters

string
Case-insensitive label substring.
string
Cursor returned by the preceding page.
string
Exact phone number ID or case-insensitive label/number substring.
string ("label" | "phone_number")
Field to sort results by.
string
Filter by assigned agent ID.
string ("twilio" | "sip_trunk" | "exotel")
Filter by telephony provider.
string
Filter by assigned branch ID.
integer
Number of phone numbers per page.
string
Filter by phone number.
string ("asc" | "desc")
Direction to sort results.
boolean
Filter by outbound-call support.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_PREVIEW_BRANCH_MERGEPreview merging a source branch into a target branch without performing the merge. Returns the merged agent configuration and conflicting fields for an accurate diff before confirming. Force makes source changes win conflicts regardless of timestamps. Requires your own ElevenLabs connection.

Input Parameters

boolean
When true, source branch changes always win conflicts regardless of timestamps.
string
required
The ID of the agent returned on creation.
string
required
Unique identifier for the source branch to merge from.
string
required
The ID of the target branch to merge into.
boolean
Whether to include workflow nodes and edges generated from structured procedures. When false, only authored elements are included.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_PREVIEW_BRANCH_REBASEPreview pulling source-branch changes into an agent branch without modifying it. Defaults to the agent’s main branch as the source. Includes conflicting field paths, structured conflict values, and the merged configuration. Requires your own ElevenLabs connection.

Input Parameters

string
required
The id of an agent. This is returned on agent creation.
string
required
Unique identifier for the source branch to merge from.
string
The ID of the branch to pull changes from. Defaults to the agent’s main branch.
boolean
Whether to include the workflow nodes and edges generated from structured procedures. When false, the workflow contains only authored elements.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_QUERY_AGENT_RAG_RETRIEVALRun an ad-hoc query against an agent’s knowledge base RAG index and return ranked chunks. Read-only: no conversation is created. Retrieval internals may evolve. Requires your own ElevenLabs connection.

Input Parameters

string
required
Query to run against the agent’s knowledge base RAG index.
string
required
The agent ID returned on agent creation.
string
The ID of the branch to use.
boolean
Use the agent’s RAG settings. Set false for neutral defaults; the agent’s embedding model is always kept.
integer
Optional maximum total character length of returned chunks; overrides RAG settings for this query only.
integer
Optional maximum number of retrieved chunks; overrides RAG settings for this query only.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_REBASE_BRANCHPull changes from a source branch (default: main) into this branch as a new version, preserving this branch’s own changes on conflicts. Requires your own ElevenLabs connection.

Input Parameters

string
required
The id of an agent. This is returned on agent creation.
string
required
Unique identifier for the branch to rebase.
string
The ID of the branch to pull changes from. Defaults to the agent’s main branch.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_REDIRECT_TO_MINTLIFYRetrieves the content of the official ElevenLabs API documentation page hosted on Mintlify.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_REFRESH_URL_DOCUMENTRefresh an existing URL knowledge-base document by re-fetching content from its source URL. Returns the updated document. Requires your own ElevenLabs connection.

Input Parameters

string
required
The knowledge-base document ID returned when the document was added.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_REGENERATE_DUBBING_TARGETRe-dub an Enterprise dubbing target from its edited transcript, synthesizing only edited regions. Charges apply after the free-regeneration allowance. Acceptance is asynchronous: the target returns to processing and emits dubbing_language_completed to the project’s configured webhooks with output URLs when complete. Returns a conflict if no edits exist, without dispatching or charging. Requires your own connection.

Input Parameters

string
required
Identifier of the dubbing project.
string
required
Identifier of the language target.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_REGISTER_CALL_CONVAI_TWILIOTool to register a Twilio call and return TwiML to connect the call to an ElevenLabs Conversational AI agent. Use when you need to integrate ElevenLabs agents with your own Twilio infrastructure for inbound or outbound calls.

Input Parameters

string
required
The unique identifier of the Conversational AI agent to use for this call
string ("inbound" | "outbound")
Direction of the call: ‘inbound’ for incoming calls or ‘outbound’ for outgoing calls
string
required
The phone number the call is directed to in E.164 format
string
required
The phone number the call is originating from in E.164 format
object
Optional client data for conversation initialization.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_REGISTER_MEDIARegister media with a production order by uploading a file or supplying a URL. Use the returned media ID when adding order items. Requires your own ElevenLabs connection.

Input Parameters

object
Media file to upload. Exactly one of media or media_url must be provided.
string
required
The ID of the order to which this media will be attached.
string
URL to fetch the media from; mutually exclusive with media.
string
required
Language code of the media (e.g. en or es-ES); must be a supported source language for some order item kind.
string
Filename for URL-sourced media (e.g. example.mp4). Required with media_url.
string
MIME type for URL-sourced media (e.g. video/mp4). Required with media_url.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_REMIX_VOICERemix an existing voice using a prompt and return voice previews. Save the preferred generated_voice_id using the create-voice endpoint. Requires your own ElevenLabs connection.

Input Parameters

integer
Random seed; identical inputs and seed produce the same voice.
string
Preview text, between 100 and 1000 characters.
number
Volume: -1 quietest, 1 loudest, 0 roughly -24 LUFS.
string
required
ID of the existing voice to remix.
string ("mp3_22050_32" | "mp3_24000_48" | "mp3_44100_32" | "mp3_44100_64" | "mp3_44100_96" | "mp3_44100_128" | "mp3_44100_192" | "pcm_8000" | "pcm_16000" | "pcm_22050" | "pcm_24000" | "pcm_32000" | "pcm_44100" | "pcm_48000" | "ulaw_8000" | "alaw_8000" | "opus_48000_32" | "opus_48000_64" | "opus_48000_96" | "opus_48000_128" | "opus_48000_192")
Audio codec_sample_rate_bitrate. MP3 192kbps requires Creator or above; PCM 44.1kHz requires Pro or above.
number
Prompt adherence; lower values allow creativity, higher values can sound artificial. Use detailed prompts with lower guidance.
number
Prompt versus reference audio influence: 0 favors audio, 1 favors prompt. Only supported with eleven_ttv_v3.
boolean
If true, return generated IDs for subsequent streaming via /v1/text-to-voice/:generated_voice_id/stream.
string
required
Description of the changes to make to the voice.
boolean
Automatically generate text suitable for the voice description.
string
The remixing session ID.
string
Session iteration to attach generations to; a new iteration is created if omitted.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_REMOVE_GROUP_MEMBERRemove a workspace member from a specified group by email. Requires group_members_manage permission and your own ElevenLabs connection.

Input Parameters

string
required
The email of the target workspace member.
string
required
The ID of the target group.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_REMOVE_ORDER_ITEMRemove an item from an open production order. Requires your own ElevenLabs connection.

Input Parameters

string
required
The ID of the order item to remove.
string
required
The ID of the open production order.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_REMOVE_PROCEDURERemove a procedure from an agent’s draft working set. Removing a folder cascades to its entire subtree and is rejected if an outside procedure hands off into it. Requires your own ElevenLabs connection.

Input Parameters

string
required
Agent ID whose draft contains the procedure.
string
required
Branch ID whose draft contains the procedure.
string
required
The procedure ID to remove.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_REMOVE_RULES_FROM_THE_PRONUNCIATION_DICTIONARYPermanently removes exact-match pronunciation rules from a specified ElevenLabs pronunciation dictionary using a list of rule strings; non-matching rule strings are ignored and this action cannot add or modify rules.

Input Parameters

array
required
A list of exact pronunciation rule strings to be removed from the dictionary (e.g., ‘word -> wɜːd’). Non-matching strings will be ignored.
string
required
Identifier of the pronunciation dictionary from which rules will be removed.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_REMOVE_TOOL_APPROVALRemove approval for a specific MCP tool when using per-tool approval mode. Returns the updated server configuration. Requires your own ElevenLabs connection.

Input Parameters

string
required
Name of the MCP tool to remove approval for.
string
required
ID of the MCP server.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_REMOVE_VOICE_FROM_COLLECTIONRemove a voice from a collection without deleting the voice itself. Requires editor access to the collection and your own ElevenLabs connection.

Input Parameters

string
required
Voice ID to remove from the collection. List available voices with GET /v1/voices.
string
required
Collection ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_REPLACE_PRONUNCIATION_RULESReplace all existing rules in a pronunciation dictionary with the provided alias and phoneme rules. Requires your own ElevenLabs connection.

Input Parameters

array
required
Complete replacement list of alias or phoneme rules. An empty list removes all rules.
string
required
The ID of the pronunciation dictionary.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_REPLICATE_VOICE_TO_ISOLATED_ENVIRONMENTReplicate an Instant Voice Clone or Voice Design voice to another data residency. Available on the central environment only. The target workspace must share the source’s consolidated billing group. Requires source voice admin access and VOICES_WRITE in the source workspace; human users also need VOICES_WRITE in the target workspace. Requires your own ElevenLabs connection.

Input Parameters

string
required
ID of the Instant Voice Clone or Voice Design voice to replicate.
boolean
Keep the same voice ID in the target residency (default true); false assigns a new voice ID.
string
required
ID of the target workspace in the same consolidated billing group; its data residency is derived from that link.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_REQUEST_MANUAL_VERIFICATIONRequest manual verification for a professional voice clone (PVC) by submitting verification documents and optional explanatory text. Requires your own ElevenLabs connection.

Input Parameters

array
required
Verification documents.
string
required
Voice ID to verify. Use the list voices endpoint to find available voices.
string
Extra text to be used in the manual verification process.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_RESOLVE_CONVERSATION_REFERENCEResolve a Slack message or Zendesk ticket URL for an agent and return the existing conversation’s details. Requires your own ElevenLabs connection.

Input Parameters

string
required
Agent id (agent_…) or speech engine external id (seng_), resolved to the same underlying resource.
string
required
A Slack message URL or a Zendesk ticket URL.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_RESUBMIT_CONVAI_TEST_INVOCATIONSTool to resubmit specific test runs from a test invocation for a conversational AI agent. Use when you need to re-run failed tests or specific test cases from a previous test invocation.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_RETRY_CONVAI_BATCH_CALLTool to retry a batch call, calling failed and no-response recipients again. Use when you need to retry unsuccessful calls from a previous batch calling campaign.

Input Parameters

string
required
Unique identifier of the batch call to retry. Retries failed and no-response recipients.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_RUN_AGENT_TESTSTool to run selected tests on a conversational AI agent with optional configuration overrides. Use when you need to execute automated tests on an agent to validate responses, tool calls, or conversation flows. Supports running up to 200 tests in a single invocation with optional branch-specific or configuration override testing.

Input Parameters

array
required
List of tests to run on the agent. Must contain at least 1 test and at most 200 tests.
string
required
The unique identifier of the agent to run tests on. This is returned on agent creation.
string
ID of the branch to run the tests on. If not provided, the tests will be run on the agent default configuration.
object
Configuration overrides to use for testing.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_RUN_CONVERSATION_ANALYSISRe-run a conversation’s analysis with the agent’s current evaluation criteria and data collection settings. Returns the full conversation, including updated analysis. Requires your own ElevenLabs connection.

Input Parameters

string
required
ID of the conversation

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_RUN_CONVERSATION_EVALUATIONRerun one evaluation criterion for an existing conversation. Returns the updated full conversation, including its analysis and transcript. Scope selects conversation-level or agent-level evaluation. Requires your own ElevenLabs connection.

Input Parameters

string ("conversation" | "agent")
Scope.
string
required
ID of the single evaluation criterion to rerun.
string
required
ID of the conversation

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_RUN_TEMPLATEStart a flows template run using input-port values and an optional snapshot version. Returns initial run state, not finished results. Prefer a configured webhook for completion, or poll the run at modest intervals. Requires your own ElevenLabs connection.

Input Parameters

object
required
Values keyed by input port ID. Supply every port; use {} for templates without inputs.
string
Receive a flows_template_run event when the run completes or fails.
string
Published snapshot ID, or latest (also the default when omitted). Owners may pin unpublished saved snapshots, never the live draft.
string
required
Template ID from the app or GET /v1/flows/templates.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_SEARCH_CONVERSATION_MESSAGESSearch conversation transcript messages using full-text and fuzzy matching. Returns matching chunks, highlights and a next-page cursor; pass next_cursor as cursor to continue. Requires your own ElevenLabs connection.

Input Parameters

string
Next-page cursor from a previous response.
string ("search_score" | "created_at")
Sort by search score or conversation start time.
string
User who initiated the conversation.
string
Agent ID or speech engine external ID (seng_).
string
Agent branch ID.
integer
Results per page, from 1 to 50.
boolean
Filter by text-only conversation mode.
array
Topic IDs assigned during topic discovery.
integer
Maximum overall rating, 1–5.
integer
Minimum overall rating, 1–5.
string
required
Search query for full-text and fuzzy matching.
array
Tool names used during calls.
string
Agent version ID.
string ("exclude" | "include")
Whether to include transcript summaries.
array
Detected main language codes.
string ("success" | "failure" | "unknown" | "error")
Success evaluation result.
array
Conversation statuses to exclude.
array
Repeated criteria_id:result filters; result is success, failure or unknown.
array
Any participating agents; at most 50 IDs.
array
Tools with errored calls.
array
Match any stored metadata.termination_reason values.
boolean
Filter by presence of user feedback comments.
integer
Earliest conversation start, Unix seconds.
array
Tools with successful calls.
integer
Maximum call duration in seconds.
integer
Minimum call duration in seconds.
integer
Latest conversation start, Unix seconds.
array
Repeated id:op:value filters; op is eq, neq, gt, gte, lt, lte or in. Pipe-delimit in values. Empty eq/neq values select uncollected/collected fields; ordered comparisons require numeric values.
array
Repeated name:op:value filters; op is eq, neq, gt, gte, lt, lte or in. Pipe-delimit in values. Empty eq/neq values select unset/set variables; ordered comparisons require numbers. Names containing ’:’ cannot be expressed.
array
Any triggered procedures; at most 50 IDs.
array
Any participating agent branches; at most 50 IDs.
string ("agents" | "speech_engine")
Restrict to one product surface.
boolean
Also match tool calls that never ran.
string ("unknown" | "android_sdk" | "node_js_sdk" | "react_native_sdk" | "react_sdk" | "js_sdk" | "python_sdk" | "widget" | "sip_trunk" | "twilio" | "exotel" | "genesys" | "avaya" | "audiocodes" | "swift_sdk" | "whatsapp" | "twilio_sms" | "flutter_sdk" | "zendesk_integration" | "slack_integration" | "telegram_integration" | "intercom_integration" | "freshdesk_integration" | "salesforce_integration" | "template_preview" | "genesys_bot_connector" | "subagent_tool")
Conversation initiation source.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_SEARCH_KNOWLEDGE_BASEFuzzy text search over knowledge-base document content. Filter by document type and use next_cursor to fetch subsequent pages. Requires your own ElevenLabs connection.

Input Parameters

string
required
The search query text.
array
Filter by document types; omit for all types.
string
Opaque next_cursor from a previous response.
integer
Maximum documents per page (1–100); defaults to 30.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_SEARCH_VOICESSearch available voices by text, labels, type or collection, with sorting and cursor pagination. Pass next_page_token from the response while has_more is true. Requires your own ElevenLabs connection.

Input Parameters

string
Filter by the age label.
string ("created_at_unix" | "name")
Sort field; created_at_unix may be unavailable for older voices.
string
Filter by the accent label.
string
Filter by the gender label.
string
Search name, description, labels and category.
string ("premade" | "cloned" | "generated" | "professional")
Voice category filter.
array
Match any of these language labels.
integer
Maximum voices per page, at most 100. The first page may include extra default voices.
array
Match any of these use_case labels.
array
Look up at most 100 voice IDs.
string ("personal" | "community" | "default" | "workspace" | "non-default" | "non-community" | "saved")
Voice type filter. non-community combines personal and workspace; saved includes default voices in collections.
boolean
When true, return only studio-quality voices in the high_quality category.
string
Filter by collection ID.
string ("asc" | "desc")
Ascending or descending sort direction.
string
Continuation token from the previous response. Use with has_more for pagination.
string ("draft" | "not_verified" | "not_started" | "queued" | "fine_tuning" | "fine_tuned" | "failed" | "delayed")
Fine-tuning state filter for professional voice clones.
boolean
Include the live total count, at extra performance cost. Use has_more for pagination.
boolean
Include voices with custom sharing rates; provider defaults to including them.
boolean
Include live-moderated voices; provider defaults to including them.
integer
Minimum sharing notice period in days.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_SEARCH_WORKSPACE_GROUPSSearch workspace groups by name, returning group IDs and member emails. Multiple or no groups may match. Requires your own ElevenLabs connection.

Input Parameters

string
required
Name of the target group.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_SEMANTICALLY_SEARCH_MESSAGESSearch conversation transcripts by semantic meaning and intent, rather than exact keywords. Optionally filter by agent and branch. Returns one page of scored message chunks; pass next_cursor as cursor to continue. Requires your own ElevenLabs connection.

Input Parameters

string
Cursor returned by the previous page.
string
Filter by agent ID (agent_…) or speech engine external ID (seng_).
string
Filter conversations by branch ID.
integer
Number of results per page, from 1 to 50.
string
required
The search query text for semantic similarity matching.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_SEND_CONVERSATION_FEEDBACKSend like/dislike feedback within five minutes of a conversation ending. Requires your own ElevenLabs connection.

Input Parameters

string ("like" | "dislike")
Either ‘like’ or ‘dislike’ to indicate the feedback for the conversation.
string
required
The ID of the conversation to send feedback for.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_SEND_WHATSAPP_MESSAGESend an outbound WhatsApp template message using an ElevenLabs agent and WhatsApp phone number. Returns the conversation ID. Requires your own ElevenLabs connection.

Input Parameters

string
required
ElevenLabs agent ID for the conversation.
string
required
WhatsApp message template name.
array
required
Template header, body and button parameters.
string
required
Recipient WhatsApp user ID.
string
required
Template language code.
string
required
WhatsApp phone number ID used to send the message.
object
Conversation personalization and configuration overrides.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_SEPARATE_MUSIC_STEMSSeparate an audio file into individual stems and download a ZIP archive. Latency depends on audio length. Requires your own ElevenLabs connection.

Input Parameters

object
required
The audio file to separate into stems.
string ("mp3_22050_32" | "mp3_24000_48" | "mp3_44100_32" | "mp3_44100_64" | "mp3_44100_96" | "mp3_44100_128" | "mp3_44100_192" | "pcm_8000" | "pcm_16000" | "pcm_22050" | "pcm_24000" | "pcm_32000" | "pcm_44100" | "pcm_48000" | "ulaw_8000" | "alaw_8000" | "opus_48000_32" | "opus_48000_64" | "opus_48000_96" | "opus_48000_128" | "opus_48000_192")
Output format of each stem as codec_sample_rate_bitrate. MP3 at 192kbps requires Creator tier or above; PCM at 44.1kHz requires Pro tier or above.
boolean
Enable request logging. Setting false uses zero retention mode, available only to enterprise customers.
boolean
Whether to sign the generated song with C2PA. Applicable only for MP3 files.
string ("two_stems_v1" | "six_stems_v1")
The ID of the stem variation to use.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_SEPARATE_SPEAKERSStart speaker separation for a professional voice sample. Returns the start request status, not the separated audio. Requires your own ElevenLabs connection.

Input Parameters

string
required
ID of the professional voice containing the sample.
string
required
ID of the sample to separate speakers in.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_SET_AGENT_AVATARTool to set or update the avatar image for a Conversational AI agent displayed in the widget. Use when you need to customize the visual appearance of an agent by uploading a profile image.

Input Parameters

string
required
The unique identifier of the agent. This is returned on agent creation.
object
required
Image file to be used as the agent’s avatar.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_SET_AGENT_HOLD_AUDIOUpload custom hold audio for callers in an agent’s concurrency wait queue, replacing any previous clip. Accepts MP3 or WAV up to 40 MB and 180 seconds. Requires your own ElevenLabs connection.

Input Parameters

string
required
The ID of the agent, returned on agent creation.
object
required
An MP3 or WAV file played on loop to callers waiting in the agent’s concurrency wait queue. Maximum size 40 MB, maximum duration 180 seconds.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_SET_PRONUNCIATION_DICTIONARIESSet pronunciation dictionaries on a Studio project. By default affected text is marked for reconversion. Requires your own ElevenLabs connection.

Input Parameters

string
required
The ID of the Studio project.
boolean
Mark affected project text for reconversion when dictionaries change. Defaults to true at the provider when omitted.
array
required
Pronunciation dictionary and version locators to apply to the project, sent as JSON objects.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_SHARE_RESOURCEGrant a workspace resource role to a user, group, or service account API key, overriding its existing role. Supply only one target: user_email, group_id, or workspace_api_key_id. The caller must have admin access to the resource. Requires your own ElevenLabs connection.

Input Parameters

string ("admin" | "editor" | "commenter" | "viewer")
required
Role to grant to the target, replacing its existing role.
string
Target group ID. Use ‘default’ for the baseline role every workspace member receives unless they hold a higher role through a direct grant, group membership, or workspace API key.
string
Email of the user or service account in your workspace.
string
required
The ID of the target resource.
string ("voice" | "voice_collection" | "pronunciation_dictionary" | "dubbing" | "dubbing_project" | "project" | "convai_agents" | "convai_knowledge_base_documents" | "convai_tools" | "convai_settings" | "convai_secrets" | "workspace_auth_connections" | "convai_phone_numbers" | "convai_mcp_servers" | "convai_api_integration_connections" | "convai_api_integration_trigger_connections" | "convai_batch_calls" | "convai_agent_response_tests" | "convai_test_suite_invocations" | "convai_crawl_jobs" | "convai_crawl_tasks" | "convai_kb_external_sync_jobs" | "convai_whatsapp_accounts" | "convai_agent_versions" | "convai_agent_branches" | "convai_agent_versions_deployments" | "convai_agent_experiments" | "convai_memory_entries" | "convai_templates" | "dashboard" | "dashboard_configuration" | "convai_agent_drafts" | "resource_locators" | "assets" | "content_generations" | "content_templates" | "content_skills" | "songs" | "transcription_tasks" | "avatars" | "avatar_video_generations" | "resource_collection" | "studio_projects" | "convai_analysis_items")
required
Resource type of the target resource.
string
Target workspace (service account) API key ID, not the authentication key string. Workspace admins can find it under Developers → Service Accounts.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_SIMULATE_CONVAI_AGENTS_SIMULATE_CONVERSATIONDeprecated by the provider; this endpoint will be removed on October 31, 2026 (2026-10-31). For new simulations, use ELEVENLABS_CREATE_CONVAI_AGENT_TESTING to create a simulation test, then ELEVENLABS_RUN_AGENT_TESTS to run it and ELEVENLABS_GET_TEST_INVOCATION to retrieve its result. Replacement simulations use a different asynchronous contract with a 50-turn maximum; this action retains its existing inputs and outputs. Run a simulated conversation between an agent and an AI user to test agent behavior with specific scenarios or evaluate conversation flow. Returns full transcript with analysis including success metrics and conversation summary.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_SPEECH_TO_SPEECHConverts an audio file to speech in a specified voice. Composio-provided access requires a supported curated voice, multilingual STS v2, MP3 output, and a WAV input of at most 60 seconds and 20 MB.Instant: Supported on the latest version.Instant pricing: $0.12 per input audio minute of voice conversion

Input Parameters

integer
Seed for deterministic audio generation (integer 0-4294967295). Repeatability is best effort and is not guaranteed.
object
required
The audio file to be converted.
string
Identifier of the model. Composio-provided access supports only ‘eleven_multilingual_sts_v2’ (the default). With your own connection, any model that supports speech-to-speech (where can_do_voice_conversion is true) works; use /v1/models to list models.
string
required
Identifier of the voice to be used. Available voices can be retrieved using the /v1/voices endpoint. Composio-provided access supports only the 40 curated voice IDs listed in examples, subject to availability and standard-rate checks. Other voices require your own connection.
string
Output audio format. Composio-provided access supports only ‘mp3_44100_128’ (the default). With your own connection, supported options: mp3_22050_32 (MP3 22.05kHz, 32kbps), mp3_44100_32 (MP3 44.1kHz, 32kbps), mp3_44100_64 (MP3 44.1kHz, 64kbps), mp3_44100_96 (MP3 44.1kHz, 96kbps), mp3_44100_128 (MP3 44.1kHz, 128kbps), mp3_44100_192 (MP3 44.1kHz, 192kbps; Requires Creator tier or above), pcm_16000 (PCM S16LE 16kHz), pcm_22050 (PCM S16LE 22.05kHz), pcm_24000 (PCM S16LE 24kHz), pcm_44100 (PCM S16LE 44.1kHz; Requires Pro tier or above), ulaw_8000 (μ-law 8kHz; for Twilio audio inputs).
string
JSON string defining voice settings, such as stability (float) and similarity_boost (float).
integer
Latency optimization. Higher values reduce latency but may lower quality. Options: 0 (no optimizations), 1 (normal), 2 (strong), 3 (max), 4 (max, text normalizer disabled; best latency, can mispronounce numbers/dates).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_SPEECH_TO_SPEECH_STREAMINGConverts an uploaded audio file to a different voice using a streaming speech-to-speech endpoint and returns a downloadable audio file. Composio-provided access requires a supported curated voice, multilingual STS v2, MP3 output, and a WAV input of at most 60 seconds and 20 MB.Instant: Supported on the latest version.Instant pricing: $0.12 per input audio minute of streamed voice conversion

Input Parameters

integer
An integer seed (0-4294967295) for best-effort repeatability. Identical parameters do not guarantee identical audio.
object
required
The input audio file (e.g..wav.mp3) to be converted.
string
Identifier of the speech-to-speech model. Composio-provided access supports only ‘eleven_multilingual_sts_v2’ (the default). With your own connection, other models (e.g., ‘eleven_english_sts_v2’) work. Ensure the chosen model supports voice conversion. Available models can be fetched from the /v1/models endpoint.
string
required
Identifier for the voice to be used. A list of available voices can be fetched from the https://api.elevenlabs.io/v1/voices endpoint. Composio-provided access supports only the 40 curated voice IDs listed in examples, subject to availability and standard-rate checks. Other voices require your own connection.
string
Desired output audio stream format. Composio-provided access supports only ‘mp3_44100_128’ (the default). With your own connection, supported formats include: ‘mp3_22050_32’: MP3 22.05kHz 32kbps. ‘mp3_44100_32’: MP3 44.1kHz 32kbps. ‘mp3_44100_64’: MP3 44.1kHz 64kbps. ‘mp3_44100_96’: MP3 44.1kHz 96kbps. ‘mp3_44100_128’: MP3 44.1kHz 128kbps. ‘mp3_44100_192’: MP3 44.1kHz 192kbps (requires Creator tier or above). ‘pcm_16000’: PCM (S16LE) 16kHz. ‘pcm_22050’: PCM (S16LE) 22.05kHz. ‘pcm_24000’: PCM (S16LE) 24kHz. ‘pcm_44100’: PCM (S16LE) 44.1kHz (requires Pro tier or above). ‘ulaw_8000’: μ-law 8kHz (commonly used for Twilio audio inputs).
string
A JSON string containing voice settings, such as stability and similarity_boost, to fine-tune the characteristics of the generated voice. Example: ’{“stability”: 0.5, “similarity_boost”: 0.75}’. If not provided, the default voice settings for the selected voice will be used.
integer
Controls latency optimizations for streaming audio. Higher values offer lower latency at a potential cost to audio quality. Supported values: 0: Default mode (no latency optimizations). 1: Normal latency optimizations (provides about 50% of the latency improvement of option 3). 2: Strong latency optimizations (provides about 75% of the latency improvement of option 3). 3: Maximum latency optimizations. 4: Maximum latency optimizations, with text normalizer turned off (can mispronounce numbers and dates but offers the best latency).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_START_EXOTEL_CALLStart an outbound phone call via the agent’s configured Exotel number. Returns success, a provider message, conversation ID and Exotel CallSid. Requires your own ElevenLabs connection.

Input Parameters

string
required
ID of the ElevenLabs agent to use.
string
required
Destination phone number to call.
string
required
ID of the agent’s Exotel phone number originating the call.
object
Telephony settings; defaults to 60 seconds ringing. Twilio-specific options are ignored for Exotel.
object
Conversation personalization and configuration overrides.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_START_TWILIO_CALLStart an outbound phone call via the agent’s configured Twilio number. Returns success, a provider message, conversation ID and Twilio call SID. Requires your own ElevenLabs connection.

Input Parameters

string
required
ID of the ElevenLabs agent to use for the call.
string
required
Destination phone number to call.
string
required
ID of the agent’s Twilio phone number used to originate the call.
object
Telephony settings; defaults to 60 seconds ringing and recording disabled.
boolean
Whether to let Twilio record the call.
object
Conversation personalization and configuration overrides.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_START_WHATSAPP_CALLStart an outbound WhatsApp call using an agent and permission request template. Requires your own ElevenLabs connection.

Input Parameters

string
required
Agent identifier.
string
required
Recipient WhatsApp user identifier.
string
required
WhatsApp phone number identifier.
object
Optional conversation personalization and overrides.
string
required
WhatsApp call permission request template name.
string
required
WhatsApp call permission request template language code.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_STREAM_AUDIO_ISOLATIONRemoves background noise from audio to isolate vocals or speech and returns a downloadable file. Composio-provided access requires encoded WAV audio longer than 4.6 seconds and at most 60 seconds and 20 MB.Instant: Supported on the latest version.Instant pricing: $0.12 per input audio minute of voice isolation

Input Parameters

object
required
The audio file from which vocals/speech will be isolated. Audio must be at least 4.6 seconds long.
string ("pcm_s16le_16" | "other")
The format of input audio. Use ‘pcm_s16le_16’ for 16-bit PCM at a 16kHz sample rate, single channel (mono), and little-endian byte order (lower latency). Use ‘other’ for all other encoded waveform formats.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_STREAM_CHAPTER_AUDIOStreams the audio for a specified chapter snapshot from an ElevenLabs project, optionally converting the output to MPEG format.

Input Parameters

string
required
Identifier of the chapter. To list available chapters for a specific project, use the GET /v1/studio/projects/{project_id}/chapters endpoint.
string
required
Identifier of the project. To find available project IDs, you can list all projects using the GET /v1/studio/projects endpoint.
boolean
If true, the output audio stream will be converted to MPEG format. If false, the audio will be streamed in its original format (likely PCM).
string
required
Identifier of the chapter snapshot (a specific version of the chapter). To list all available snapshots for a chapter, use the GET /v1/studio/projects/{project_id}/chapters/{chapter_id}/snapshots endpoint.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_STREAM_CONVAI_AGENTS_SIMULATE_CONVERSATIONDeprecated by the provider; this endpoint will be removed on October 31, 2026 (2026-10-31). For new simulations, use ELEVENLABS_CREATE_CONVAI_AGENT_TESTING to create a simulation test, then ELEVENLABS_RUN_AGENT_TESTS to run it and ELEVENLABS_GET_TEST_INVOCATION to retrieve its result. Replacement simulations use a different asynchronous contract with a 50-turn maximum; this action retains its existing inputs and raw SSE output. Run a simulated conversation between an agent and a simulated user, streaming back partial lists of messages and a final conversation analysis.

Input Parameters

string
required
The ID of the conversational AI agent. This is returned on agent creation.
integer
Maximum number of new turns to generate in the conversation simulation.
object
required
Specification that defines how to simulate the conversation between the agent and a simulated user.
array
A list of additional evaluation criteria to test during the simulation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_STREAM_DIALOGUEConvert ordered text and voice-ID pairs into multi-voice speech and return the streamed audio as a downloadable file. Requires your own ElevenLabs connection.

Input Parameters

integer
Best-effort deterministic sampling seed; determinism is not guaranteed.
array
required
Dialogue turns, with at most 10 unique voices. Keep total text at or below 2,000 characters for reliable generation; longer streams can terminate early.
string
Model ID from GET /v1/models; must support text to speech.
object
Settings controlling dialogue generation.
string
Text immediately after this generation for prosodic continuity; not supported by every model.
object
Audio effects. Unknown IDs return 404. Reverb with positive send_level or nonzero pan produces stereo, rejected with 400 for ulaw, alaw, and pcm formats.
string
ISO 639-1 language; ignored if unsupported. Not supported for multilingual_v2 models.
string ("mp3_22050_32" | "mp3_24000_48" | "mp3_44100_32" | "mp3_44100_64" | "mp3_44100_96" | "mp3_44100_128" | "mp3_44100_192" | "pcm_8000" | "pcm_16000" | "pcm_22050" | "pcm_24000" | "pcm_32000" | "pcm_44100" | "pcm_48000" | "ulaw_8000" | "alaw_8000" | "opus_48000_32" | "opus_48000_64" | "opus_48000_96" | "opus_48000_128" | "opus_48000_192")
Audio codec_sample_rate_bitrate. MP3 192kbps requires Creator tier; PCM 44.1kHz requires Pro tier or above.
string
Text immediately before this generation for prosodic continuity; not supported by every model.
boolean
Enable request logging. False selects enterprise-only zero retention and disables history and request stitching.
boolean
Deprecated: use the IVC version of a professional voice to potentially improve expressiveness and latency.
array
Up to three following generation request IDs; the first is closest. Not supported by every model.
array
Up to three preceding generation request IDs; the last is closest. Not supported by every model.
string ("auto" | "on" | "off")
Whether text normalization is automatic, always enabled, or disabled.
array
Up to three pronunciation dictionary locators, applied in order.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_STREAM_MUSICStream a composed song from a prompt or composition plan and return downloadable audio plus its song ID. Requires your own ElevenLabs connection.

Input Parameters

integer
Random generation seed; cannot be combined with prompt. Exact reproducibility is not guaranteed.
string
Text prompt; cannot be combined with composition_plan.
string ("music_v1" | "music_v2" | "music_v2_5")
Music generation model.
string
Finetune ID to use for generation.
string
Lyrics text for generation.
object
Deprecated music prompt; use composition_plan instead.
string ("auto" | "mp3_48000_128" | "mp3_48000_192" | "mp3_48000_240" | "mp3_48000_320" | "mp3_22050_32" | "mp3_24000_48" | "mp3_44100_32" | "mp3_44100_64" | "mp3_44100_96" | "mp3_44100_128" | "mp3_44100_192" | "pcm_8000" | "pcm_16000" | "pcm_22050" | "pcm_24000" | "pcm_32000" | "pcm_44100" | "pcm_48000" | "ulaw_8000" | "alaw_8000" | "opus_48000_32" | "opus_48000_64" | "opus_48000_96" | "opus_48000_128" | "opus_48000_192")
Audio codec_sample_rate_bitrate. Auto selects mp3_44100_128 for v1 and mp3_48000_192 for v2.
boolean
Disable for enterprise-only zero retention mode.
string ("track" | "loop" | "ambience" | "video_to_music")
Generation mode hint; only usable with prompt.
integer
Song length in milliseconds; only with prompt. If omitted the model chooses a length.
string
Detailed plan; MusicPrompt for music_v1, CompositionPlan for music_v2/music_v2_5. Cannot be combined with prompt.
number
Finetune influence, meaningful only with finetune_id.
boolean
Guarantee instrumental output; only usable with prompt.
boolean
Phonetically spell proper names in lyrics and restore originals in word timestamps.
boolean
Store the generated song for inpainting.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_STREAM_MUSIC_WITH_METADATAGenerate music with detailed metadata using your own ElevenLabs connection. Collects the documented SSE stream into ordered named events: audio_chunk data contains base64 audio plus optional word timestamps and waveform slices. Returns song_id and preserves all metadata. Multipart responses, if supplied, are separated into downloadable parts and JSON metadata.

Input Parameters

integer
Random seed; cannot be combined with prompt. Reproducibility is not guaranteed.
string
Text prompt; cannot be combined with composition_plan.
string ("music_v1" | "music_v2" | "music_v2_5")
Music generation model.
string
Optional finetune ID.
string
Lyrics to use for generation.
object
Deprecated music prompt; use composition_plan.
string ("auto" | "mp3_48000_128" | "mp3_48000_192" | "mp3_48000_240" | "mp3_48000_320" | "mp3_22050_32" | "mp3_24000_48" | "mp3_44100_32" | "mp3_44100_64" | "mp3_44100_96" | "mp3_44100_128" | "mp3_44100_192" | "pcm_8000" | "pcm_16000" | "pcm_22050" | "pcm_24000" | "pcm_32000" | "pcm_44100" | "pcm_48000" | "ulaw_8000" | "alaw_8000" | "opus_48000_32" | "opus_48000_64" | "opus_48000_96" | "opus_48000_128" | "opus_48000_192")
codec_sample_rate_bitrate; auto selects mp3_44100_128 for v1 or mp3_48000_192 for v2.
boolean
False requests enterprise-only zero retention.
string ("track" | "loop" | "ambience" | "video_to_music")
Generation hint, only with prompt.
integer
Length in milliseconds, only with prompt; omitted lets the model choose.
boolean
Include word timestamps in audio_chunk events.
string
Detailed plan; mutually exclusive with prompt. Match plan type to model.
number
Finetune influence, only meaningful with finetune_id.
boolean
Guarantee instrumental output; only with prompt.
boolean
Phonetically spell proper names in lyrics; restore originals in timestamps.
boolean
Store generated song for later inpainting.
boolean
Include waveform slices in audio_chunk events; concatenate in arrival order.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_STREAM_PROJECT_AUDIOStreams audio from a specific project snapshot, optionally converting it to MPEG format.

Input Parameters

string
required
Identifier of the project.
boolean
If true, converts the output audio to MPEG format; otherwise, streams in its original or a default raw format.
string
required
Identifier of the project snapshot.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_STREAMS_ARCHIVE_WITH_PROJECT_AUDIORetrieves a downloadable archive of audio for a specified Studio project snapshot.

Input Parameters

string
required
The ID of the project whose snapshot is to be archived.
string
required
The ID of the project snapshot to archive.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_STREAM_STUDIO_PROJECT_AUDIODownload streamed audio from an existing Studio project snapshot, optionally converted to MPEG. Requires your own ElevenLabs connection.

Input Parameters

string
required
The ID of the Studio project.
boolean
Whether to convert the audio to mpeg format.
string
required
The ID of the Studio project snapshot.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_STREAM_TIMESTAMPED_DIALOGUEGenerate multi-speaker dialogue and collect its JSON stream as ordered audio chunks with character timestamps and voice segments. Requires your own ElevenLabs connection; the result buffers the complete stream.

Input Parameters

integer
Best-effort deterministic sampling seed, 0 through 4294967295; determinism is not guaranteed.
array
required
Ordered text/voice pairs. Maximum 10 unique voices. Keep total text at or below 2,000 characters for reliable generation; longer requests can terminate early or fail validation.
string
Text-to-speech-capable model ID; list models with GET /v1/models.
object
Settings controlling dialogue generation.
string
Immediately following text for prosodic continuity, at most 100 characters. Not supported by every model.
object
Effects applied to audio. Unknown IDs return 404. Reverb with positive send_level and nonzero pan produce stereo and are rejected for ulaw, alaw and pcm formats.
string
ISO 639-1 language code for language enforcement and normalization. Ignored if unsupported; not supported for multilingual_v2.
string ("mp3_22050_32" | "mp3_24000_48" | "mp3_44100_32" | "mp3_44100_64" | "mp3_44100_96" | "mp3_44100_128" | "mp3_44100_192" | "pcm_8000" | "pcm_16000" | "pcm_22050" | "pcm_24000" | "pcm_32000" | "pcm_44100" | "pcm_48000" | "ulaw_8000" | "alaw_8000" | "opus_48000_32" | "opus_48000_64" | "opus_48000_96" | "opus_48000_128" | "opus_48000_192")
Audio codec_sample_rate_bitrate. MP3 192kbps requires Creator tier or above; PCM 44.1kHz requires Pro tier or above.
string
Immediately preceding text for prosodic continuity, at most 100 characters. Not supported by every model.
boolean
False enables zero retention, disabling history and request stitching; enterprise customers only.
boolean
Use the IVC version of a professional voice, potentially improving expressiveness and latency. Deprecated by provider.
array
At most 3 subsequent dialogue request IDs for continuity; first is closest. Not supported by every model.
array
At most 3 preceding dialogue request IDs for continuity; last is closest. Not supported by every model.
string ("auto" | "on" | "off")
Automatically choose text normalization, always apply it, or skip it.
array
Pronunciation dictionaries applied in order; at most 3 locators.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_STREAM_TIMESTAMPED_SPEECHConvert text to speech with character timestamps using a chosen voice. Collects the JSON stream into ordered events with base64 audio chunks. Requires your own ElevenLabs connection.

Input Parameters

integer
Best-effort deterministic seed between 0 and 4294967295; determinism is not guaranteed.
string
required
Text to convert into speech.
string
Text-to-speech model ID; discover supported models using GET /v1/models.
string
required
Voice ID; list available voices using GET /v1/voices.
string
Following text for continuity; ignored when next_request_ids is supplied.
object
Audio effects. Unknown IDs return 404. Reverb with positive send level or nonzero pan requires stereo and is rejected for ulaw, alaw and pcm outputs.
string
ISO 639-1 language code; ignored if unsupported and not supported by multilingual_v2.
string ("mp3_22050_32" | "mp3_24000_48" | "mp3_44100_32" | "mp3_44100_64" | "mp3_44100_96" | "mp3_44100_128" | "mp3_44100_192" | "pcm_8000" | "pcm_16000" | "pcm_22050" | "pcm_24000" | "pcm_32000" | "pcm_44100" | "pcm_48000" | "ulaw_8000" | "alaw_8000" | "opus_48000_32" | "opus_48000_64" | "opus_48000_96" | "opus_48000_128" | "opus_48000_192")
Audio codec_sample_rate_bitrate. MP3 192kbps requires Creator tier; PCM 44.1kHz requires Pro tier or above.
string
Preceding text for continuity; ignored when previous_request_ids is supplied.
boolean
Enable request logging; disabling enables enterprise-only zero retention and disables history/stitching.
boolean
Use the IVC version of a professional voice to improve expressiveness and reduce latency.
object
Override stored voice settings for this request only.
array
Up to three following generation request IDs; use the same model for best continuity.
array
Up to three preceding generation request IDs; use the same model for best continuity.
string ("auto" | "on" | "off")
Automatically decide whether to normalize text, always normalize, or never normalize.
integer
Deprecated latency optimization level: 0 default, 1 normal, 2 strong, 3 maximum, 4 maximum with text normalization disabled.
boolean
Enable language-specific normalization; currently Japanese only and may heavily increase latency.
array
Up to three pronunciation dictionaries, applied in order.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_STREAM_VOICE_CONVERSIONConvert uploaded audio to a target voice, preserving emotion, timing and delivery. Downloads the audio stream as a file. Requires your own ElevenLabs connection.

Input Parameters

integer
Best-effort deterministic sampling seed from 0 to 4294967295. Determinism is not guaranteed.
object
required
Audio file providing the content and emotion of the generated speech.
string
Model ID from GET /v1/models; the model must have can_do_voice_conversion enabled.
string
required
Target voice ID; list available voices with GET /v1/voices.
string ("pcm_s16le_16" | "other")
Input format. pcm_s16le_16 requires mono 16-bit little-endian PCM at 16kHz and offers lower latency than encoded audio.
string ("mp3_22050_32" | "mp3_24000_48" | "mp3_44100_32" | "mp3_44100_64" | "mp3_44100_96" | "mp3_44100_128" | "mp3_44100_192" | "pcm_8000" | "pcm_16000" | "pcm_22050" | "pcm_24000" | "pcm_32000" | "pcm_44100" | "pcm_48000" | "ulaw_8000" | "alaw_8000" | "opus_48000_32" | "opus_48000_64" | "opus_48000_96" | "opus_48000_128" | "opus_48000_192")
Output codec_sample_rate_bitrate. MP3 192kbps requires Creator or above; PCM 44.1kHz requires Pro or above. μ-law is commonly used for Twilio.
boolean
Enable request logging. False uses enterprise-only zero retention mode and disables history features, including stitching.
string
JSON-encoded string of voice settings overriding stored settings for this request only.
boolean
Remove background noise using the audio isolation model before voice conversion.
integer
Deprecated latency optimization: 0 default, 1 normal, 2 strong, 3 maximum, 4 maximum with text normalization disabled. Higher values trade quality for latency.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_STREAM_VOICE_PREVIEWDownload streaming MPEG audio for a voice preview created via /v1/text-to-voice/design. Requires your own ElevenLabs connection.

Input Parameters

string
required
The generated_voice_id returned by /v1/text-to-voice/design to stream.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_SUBMIT_BATCH_CALLTool to submit a batch call. Use when you need to initiate multiple calls (voice or WhatsApp) at once. Triggers real outbound calls immediately (if no scheduled_time_unix is set) or at the scheduled time — always confirm recipient list and call count with the user before executing.

Input Parameters

string
required
ID of the agent to use for the calls
string
required
Name of the batch call
array
required
List of recipient objects for batch calling
integer
Unix timestamp to schedule the batch (omit or null to send immediately)
string
ID of the phone number to originate calls from
string
ID of the WhatsApp Business Account to use

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_SUBMIT_ORDERSubmit an open production order with at least one item for processing. Submission charges the workspace and prevents further item modifications. To review the quote first, poll the order details until the quote is ready. Requires your own ElevenLabs connection.

Input Parameters

string
required
The ID of the open order to submit.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_SYNTHESIZE_TIMESTAMPED_SPEECHGenerate speech with character-level timestamps for audio/text synchronization, returning base64 audio and original/normalized alignments. Requires your own ElevenLabs connection; model, voice and format availability depends on your plan.

Input Parameters

integer
Best-effort deterministic generation seed; determinism is not guaranteed.
string
required
Text to synthesize into speech.
string
Model ID supporting text-to-speech from GET /v1/models.
string
required
Voice ID obtained from GET /v1/voices.
string
Following text for continuity; ignored when next_request_ids is provided.
object
Audio effects. Reverb or nonzero pan produces stereo, rejected for ulaw/alaw/pcm formats; unknown IDs return 404.
string
ISO 639-1 language; unsupported languages are ignored. Not supported by multilingual_v2.
string ("alaw_8000" | "mp3_22050_32" | "mp3_24000_48" | "mp3_44100_128" | "mp3_44100_192" | "mp3_44100_32" | "mp3_44100_64" | "mp3_44100_96" | "opus_48000_128" | "opus_48000_192" | "opus_48000_32" | "opus_48000_64" | "opus_48000_96" | "pcm_16000" | "pcm_22050" | "pcm_24000" | "pcm_32000" | "pcm_44100" | "pcm_48000" | "pcm_8000" | "ulaw_8000" | "wav_16000" | "wav_22050" | "wav_24000" | "wav_32000" | "wav_44100" | "wav_48000" | "wav_8000")
Audio codec/sample rate/bitrate. 192kbps MP3 requires Creator+; 44.1kHz PCM/WAV requires Pro+.
string
Preceding text for continuity; ignored when previous_request_ids is provided.
boolean
Enable request logging. Disabling uses enterprise-only zero retention and disables history/stitching.
boolean
Use the instant clone version of a professional voice for expressiveness/latency.
object
Voice setting overrides for this request only.
array
Up to three following generation request IDs for stitching; use the same model.
array
Up to three preceding generation request IDs for stitching; use the same model.
string ("auto" | "on" | "off")
Automatically choose, always apply, or skip text normalization.
integer
Deprecated latency optimization: 0 (none) through 4 (maximum, normalizer off).
boolean
Language-specific normalization, currently Japanese only; can heavily increase latency.
array
Up to three pronunciation dictionaries, applied in order.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_TEXT_TO_SPEECHConverts text to speech using an ElevenLabs voice and model, returning a downloadable audio file. Composio-provided access is limited to eligible curated voices, Multilingual v2, MP3 44100/128, and 1–5,000 characters without pronunciation dictionaries.Instant: Supported on the latest version.Instant pricing: $0.08 per 1,000 Multilingual v2 input characters

Input Parameters

integer
Integer seed for potentially deterministic audio generation. Repeatability with the same seed and parameters is aimed for but not guaranteed.
string
required
Input text for speech conversion. Max 10,000 characters for most models. Flash/Turbo v2 models: up to 30,000. Flash/Turbo v2.5 models: up to 40,000. For long-form content, use Studio.
string
Identifier of the model for synthesis. Composio-provided access supports only ‘eleven_multilingual_v2’ (the default). With your own connection, list available models via /v1/models; ensure chosen model’s can_do_text_to_speech is true.
string
required
Identifier of the voice for speech generation. Obtainable from the /v1/voices endpoint. Composio-provided access supports only the 40 curated voice IDs listed in examples, subject to availability and standard-rate checks. Other voices require your own connection.
string
Output audio format. Composio-provided access supports only ‘mp3_44100_128’ (the default). With your own connection, supported formats include: - mp3_22050_32: 22.05kHz, 32kbps MP3. - mp3_44100_32: 44.1kHz, 32kbps MP3. - mp3_44100_64: 44.1kHz, 64kbps MP3. - mp3_44100_96: 44.1kHz, 96kbps MP3. - mp3_44100_128: 44.1kHz, 128kbps MP3. - mp3_44100_192: 44.1kHz, 192kbps MP3 (Creator tier+). - pcm_16000: 16kHz PCM (S16LE). - pcm_22050: 22.05kHz PCM (S16LE). - pcm_24000: 24kHz PCM (S16LE). - pcm_44100: 44.1kHz PCM (S16LE) (Pro tier+). - ulaw_8000: 8kHz μ-law (for Twilio audio inputs).
object
Voice settings for controlling speech generation characteristics.
integer
Controls latency optimizations for streaming. Higher values reduce latency, potentially affecting quality. 0: No optimizations. 1: Normal (approx. 50% of max improvement vs option 3). 2: Strong (approx. 75% of max improvement vs option 3). 3: Maximum. 4: Maximum with text normalizer disabled (affects number/date pronunciation, best latency). NOTE: Not supported with model ‘eleven_v3’. If using eleven_v3, leave this parameter unset.
array
List of up to 3 pronunciation dictionary locators, applied sequentially. Each dictionary must contain pronunciation_dictionary_id and version_id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_TEXT_TO_SPEECH_STREAMConverts text through the provider streaming endpoint and returns a downloadable audio file. Composio-provided access is limited to eligible curated voices, Multilingual v2, MP3 44100/128, and 1–5,000 characters without pronunciation dictionaries; other connections can request custom pronunciations and other formats.Instant: Supported on the latest version.Instant pricing: $0.08 per 1,000 Multilingual v2 input characters for streamed speech

Input Parameters

integer
If specified, the system will attempt to sample deterministically, meaning that repeated requests with the same seed and parameters should ideally return the same audio result. However, complete determinism is not guaranteed.
string
required
The text that will be converted into speech. It is recommended to keep the text length under 5000 characters, as longer texts might face limitations.
string
Identifier of the model to be used for text-to-speech conversion. Composio-provided access supports only ‘eleven_multilingual_v2’ (the default). With your own connection, available models can be listed using the GET /v1/models endpoint. Ensure the chosen model supports text-to-speech by verifying its can_do_text_to_speech property. Voice and account compatibility with specific models (e.g., eleven_turbo_v2, eleven_multilingual_v2) may vary; validate by testing a short clip (~200 characters) before full runs.
string
required
Identifier of the voice to be used for speech generation. A list of available voice IDs can be retrieved from the GET /v1/voices endpoint. Composio-provided access supports only the 40 curated voice IDs listed in examples, subject to availability and standard-rate checks. Other voices require your own connection.
string
Specifies the desired output format for the generated audio stream. Composio-provided access supports only ‘mp3_44100_128’ (the default). With your own connection, the following formats are supported. Supported MP3 formats: - mp3_22050_32: MP3, 22.05kHz, 32kbps. - mp3_44100_32: MP3, 44.1kHz, 32kbps. - mp3_44100_64: MP3, 44.1kHz, 64kbps. - mp3_44100_96: MP3, 44.1kHz, 96kbps. - mp3_44100_128: MP3, 44.1kHz, 128kbps. - mp3_44100_192: MP3, 44.1kHz, 192kbps (Creator tier or above required). Supported PCM formats (S16LE): - pcm_16000: PCM, 16kHz. - pcm_22050: PCM, 22.05kHz. - pcm_24000: PCM, 24kHz. - pcm_44100: PCM, 44.1kHz (Pro tier or above required). Supported μ-law format: - ulaw_8000: μ-law, 8kHz (commonly used for Twilio audio inputs).
integer
Controls latency optimization for the streaming audio. Higher values prioritize lower latency, potentially at the cost of audio quality. Possible values: - 0: Default mode (no latency optimizations). - 1: Normal latency optimizations (reduces latency by approximately 50% of option 3’s improvement). - 2: Strong latency optimizations (reduces latency by approximately 75% of option 3’s improvement). - 3: Maximum latency optimizations. - 4: Maximum latency optimizations with text normalizer disabled (offers the lowest latency but may lead to mispronunciations of numbers, dates, etc.).
array
A list of pronunciation dictionary locators to be applied to the text. Each locator should be a dictionary containing ‘pronunciation_dictionary_id’ (string) and ‘version_id’ (string). Dictionaries are applied in the provided order. A maximum of 3 locators can be used per request.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_TRAIN_PROFESSIONAL_VOICEStart professional voice clone (PVC) training for an existing voice, optionally choosing its model. Requires your own ElevenLabs connection.

Input Parameters

string
The model ID to use for the conversion.
string
required
Voice ID to train. Use the list voices endpoint to find available voice IDs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_TRANSCRIBE_AUDIOTranscribe one uploaded file or public media URL with ElevenLabs.

Input Parameters

object
Audio or video file to transcribe. Use instead of source_url.
integer
Best-effort deterministic sampling seed from 0 through 2147483647.
boolean
Whether to identify speakers in the transcript.
boolean
Return early and deliver the transcription to configured speech-to-text webhooks.
array
Terms to bias recognition toward. Each must be under 50 characters and at most five words. Adds a 20% surcharge.
string
required
Speech-to-text model ID.
string
Public audio or video URL. Use instead of file.
string
Specific configured webhook ID, valid only when webhook=true.
string ("pcm_s16le_16" | "other")
Input audio format. pcm_s16le_16 requires mono 16-bit little-endian PCM at 16 kHz.
boolean
Remove filler words, false starts, and non-speech sounds. Supported only by scribe_v2.
number
Transcription sampling temperature from 0.0 through 2.0.
integer
Expected number of speakers, from 1 to 32.
string
Optional ISO language code for the source media.
boolean
Enable request logging. Disabling it uses enterprise-only zero-retention mode.
string
Natural-language transcript edit instruction. Adds a 30% surcharge and cannot be combined with entity processing or multi-channel transcription.
string
Entity type, category, ‘all’, or list to detect. Categories include pii, phi, pci, other, and offensive_language. Adds a 30% surcharge.
string
Entity types or categories to redact; must be a subset of entity_detection and adds a 30% surcharge.
boolean
Whether to tag non-speech sounds in the transcript.
string
Webhook metadata as a JSON object or JSON-object string, with at most two levels and 16KB encoded size.
boolean
Transcribe up to five audio channels independently; each channel is billed separately.
array
Additional transcript export formats, up to 10.
boolean
Match diarized speakers against the workspace speaker library.
boolean
Detect agent and customer roles. Requires diarization, conflicts with multi-channel mode, and adds a 10% surcharge.
number
Speaker diarization threshold, valid only with diarize=true and no num_speakers.
string ("redacted" | "entity_type" | "enumerated_entity_type")
Replacement style used when entity_redaction is set.
string ("none" | "word" | "character")
Timestamp detail level for the transcript.
string ("separate" | "combined")
Return separate channel transcripts or one time-sorted combined transcript.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_UNASSIGN_CONVERSATION_TAGRemove a single tag from a conversation. Requires your own ElevenLabs connection.

Input Parameters

string
required
ID of the tag to unassign from the conversation.
string
required
ID of the conversation to remove the tag from.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_UNSHARE_RESOURCERemove an existing workspace resource role from a user, group, or service account API key. Pass only the user email, group ID, or workspace API key ID for the intended recipient. Requires admin access to the resource; its creator’s permissions cannot be removed. Requires your own ElevenLabs connection.

Input Parameters

string
The ID of the target group. Use ‘default’ to target the resource’s baseline role for workspace members.
string
The email of the user or service account.
string
required
The ID of the target resource.
string ("voice" | "voice_collection" | "pronunciation_dictionary" | "dubbing" | "dubbing_project" | "project" | "convai_agents" | "convai_knowledge_base_documents" | "convai_tools" | "convai_settings" | "convai_secrets" | "workspace_auth_connections" | "convai_phone_numbers" | "convai_mcp_servers" | "convai_api_integration_connections" | "convai_api_integration_trigger_connections" | "convai_batch_calls" | "convai_agent_response_tests" | "convai_test_suite_invocations" | "convai_crawl_jobs" | "convai_crawl_tasks" | "convai_kb_external_sync_jobs" | "convai_whatsapp_accounts" | "convai_agent_versions" | "convai_agent_branches" | "convai_agent_versions_deployments" | "convai_agent_experiments" | "convai_memory_entries" | "convai_templates" | "dashboard" | "dashboard_configuration" | "convai_agent_drafts" | "resource_locators" | "assets" | "content_generations" | "content_templates" | "content_skills" | "songs" | "transcription_tasks" | "avatars" | "avatar_video_generations" | "resource_collection" | "studio_projects" | "convai_analysis_items")
required
Resource type of the target resource.
string
The ID of the target workspace (service account) API key, not the authentication key string. Workspace admins can find it under Developers → Service Accounts.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_UPDATE_AGENT_BRANCHUpdate metadata for an ElevenLabs Conversational AI agent branch.

Input Parameters

string
New branch name, which must be unique within the agent.
string
required
Agent ID returned when the agent was created.
string
required
Unique agent branch ID.
boolean
Whether to rebase this branch onto main automatically after each new main version. This cannot be enabled on the main branch.
boolean
Whether the branch should be archived.
string ("writer_perms_required" | "admin_perms_required")
Permission level required to modify the branch.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_UPDATE_AGENT_BRANCH_PROCEDURE_DRAFTReplace an ElevenLabs agent branch procedure draft.

Input Parameters

string
required
Procedure name.
string
required
Complete replacement procedure content.
string
Optional text describing when the agent uses the procedure.
string
required
Agent ID.
string
required
Agent branch ID.
string
required
Procedure ID.
string ("free_form" | "deterministic" | "folder")
required
Procedure type.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_UPDATE_AUDIO_NATIVE_CONTENTTool to update content for an Audio Native project by uploading a text or HTML file. Use when you need to refresh or change the content of an existing Audio Native project. Optionally auto-convert to audio and auto-publish the new snapshot.

Input Parameters

object
required
Text or HTML file containing the article content. For HTML, format as ‘<html><body><div><p>Your content</p><h5>More content</h5></div></body></html>’.
string
required
The ID of the Audio Native project to update.
boolean
Whether to automatically convert the project to audio after updating content.
boolean
Whether to automatically publish the new project snapshot after conversion completes.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_UPDATE_AUDIO_NATIVE_FROM_URLFind an existing Audio Native project matching a page URL, extract its content, update the project, and queue conversion and auto-publishing. Requires your own ElevenLabs connection.

Input Parameters

string
required
URL of the page to extract content from.
string
Title used in the player and inserted at the top of the uploaded article. If not provided, the default title set in the Player settings is used.
string
Author used in the player and inserted at the start of the uploaded article. If not provided, the default author set in the Player settings is used.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_UPDATE_CHAPTERUpdate a Studio chapter’s name or structured text-to-speech content by project and chapter ID. Requires your own ElevenLabs connection.

Input Parameters

string
The name of the chapter, used for identification only.
object
The chapter content to use.
string
required
The ID of the chapter.
string
required
The ID of the Studio project.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_UPDATE_CONVAI_AGENTTool to update an existing ElevenLabs Conversational AI agent’s settings. Use when you need to modify an agent’s configuration, such as changing its name, conversation settings, workflow, or platform settings.

Input Parameters

string
A name to make the agent easier to find
array
Tags to help classify and filter the agent
string
required
The id of an agent. This is returned on agent creation.
object
Workflow configuration defining conditional logic, tool execution modes, and conversation flow patterns for the agent
string
The ID of the branch to use
array
List of procedure refs used for this agent version.
object
Platform settings for the agent are all settings that aren’t related to the conversation orchestration and content.
object
Conversation configuration for an agent
string
Description for this version when publishing changes (only applicable for versioned agents)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_UPDATE_CONVAI_AGENT_TESTINGTool to update an existing ElevenLabs Conversational AI agent response test by ID. Use when you need to modify test configuration, chat history, success conditions, or other test parameters.

Input Parameters

string
required
Name for the test case to identify it later
string ("llm" | "tool_call" | "simulation")
Type of agent test.
string
required
The id of a chat response test. This is returned on test creation.
array
Array of messages representing the conversation history to test against. Each message must include role (‘user’ or ‘agent’), time_in_call_secs (float), and optional message text content.
array
Examples of failed or incorrect agent responses for LLM tests
array
Examples of successful agent responses for LLM tests
object
Key-value pairs of variables to be dynamically injected into the test context
string
For ‘llm’ and ‘simulation’ types: Natural language description of what constitutes a successful agent response
string
For ‘simulation’ type: Natural language description of the scenario to simulate in the conversation
integer
For ‘simulation’ type tests: Maximum number of conversation turns to simulate
string
For ‘tool_call’ type tests: Expected parameters for the tool that should be called by the agent
string
For ‘tool_call’ type tests: Whether to check if any tool matches the expected call pattern
string
Metadata from a previous conversation to use as context for this test

Output

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

Input Parameters

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

Output

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

Input Parameters

string
required
Updated name identifier for the secret. Must be unique within the workspace.
string ("update")
required
Type of operation. Must be the literal value ‘update’ for updating secrets.
string
required
The updated secret value to store securely in the workspace.
string
required
The unique identifier of the workspace secret to update. This ID is returned when creating or listing secrets.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_UPDATE_CONVAI_SETTINGSTool to update Convai settings for the workspace. Use when you need to modify webhook configurations, RAG retention settings, MCP server capabilities, or Livekit stack preferences.

Input Parameters

object
Webhook configuration for ConvAI conversations.
boolean
Whether the workspace can use MCP servers
string ("standard" | "static")
Valid Livekit stack types for the default_livekit_stack setting.
integer
Number of days to retain RAG data. Maximum: 30 days
object
Webhook configuration for conversation initiation client data.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_UPDATE_CONVAI_SETTINGS_DASHBOARDTool to update Convai dashboard settings for the workspace. Use when you need to configure dashboard charts for monitoring conversational AI performance.

Input Parameters

array
List of dashboard charts (max 4), each representing call success metrics, criteria evaluations, or data collection insights

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_UPDATE_CONVAI_TOOLTool to update an existing conversational AI tool in ElevenLabs workspace. Use when modifying tool settings, descriptions, API endpoints, or behavior configurations. Requires the complete tool_config object with all required fields for the tool type.

Input Parameters

string
required
ID of the tool to update.
object
required
Complete tool configuration object to update. Must include ‘type’ field (webhook/client/system/mcp) and all type-specific required fields. For webhook: requires name, description, api_schema. For client: requires name, description. For system: requires name, params. For mcp: requires name, description, integration_type, mcp_tool_name, mcp_tool_description, mcp_server_id, mcp_server_name. Optional fields include: assignments, disable_interruptions, dynamic_variables, execution_mode, force_pre_tool_speech, response_timeout_secs, tool_call_sound, tool_call_sound_behavior, tool_error_handling_mode.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_UPDATE_ENVIRONMENT_VARIABLEReplace an environment variable’s values using your own ElevenLabs connection. Null removes an environment’s value except production; deleting an environment is a separate operation.

Input Parameters

object
required
Replacement values keyed by environment. Use a nonempty string, secret ID object, or authentication connection ID object matching the variable type. Null removes a value except for production.
string
required
ID of the environment variable to update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_UPDATE_FILE_DOCUMENTReplace a knowledge-base document’s source file. Updates its name, content and metadata, overwriting manual content edits. Requires your own ElevenLabs connection.

Input Parameters

object
required
Replacement source file accessible to the agent.
string
required
Knowledge-base document ID returned when the document was added.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_UPDATE_MCP_SERVERUpdate non-credential settings for an existing MCP server. Requires your own ElevenLabs connection. Credential tokens and custom request headers/metadata are excluded by owner policy; existing auth-connection IDs remain supported.

Input Parameters

string
required
ID of the MCP Server.
string ("immediate" | "post_tool_speech" | "async")
Override when tools from this MCP server execute.
string ("auto_approve_all" | "require_approval_all" | "require_approval_per_tool")
Approval mode to set for this MCP server.
string
Workspace auth connection or environment auth-connection reference.
string ("auto" | "force" | "off")
Override whether the agent speaks before tool execution.
string ("typing" | "elevator1" | "elevator2" | "elevator3" | "elevator4")
Predefined sound to play during execution; null means no sound.
string ("allow" | "disable_during_tool" | "disable_during_tool_and_turn")
Override interruptions during tool execution and the following turn.
boolean
Whether to disable HTTP compression for this server.
boolean
DEPRECATED: use interruption_mode instead.
boolean
DEPRECATED: use pre_tool_speech instead.
integer
Maximum time in seconds to wait for an MCP tool call (5–300).
string ("auto" | "always")
When the tool call sound should play.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_UPDATE_MEMBERUpdate a workspace member identified by email. Only workspace administrators may call this endpoint. Attributes remain unchanged unless specified. Requires your own ElevenLabs connection.

Input Parameters

string
required
Email of the target user.
boolean
Whether to lock or unlock the user account.
string ("workspace_admin" | "workspace_member" | "workspace_lite_member")
Deprecated workspace role; use workspace_seat_type instead.
string ("workspace_admin" | "workspace_member" | "workspace_lite_member")
The workspace seat type.
boolean
When unlocking a user whose original seat type has no seats available but a basic seat is available, downgrade the user to a basic seat instead of failing.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_UPDATE_MUSIC_FINETUNEUpdate a music finetune’s name, tags, genre or visibility. Omitted fields are not sent; explicit nulls are sent as null. Requires your own ElevenLabs connection.

Input Parameters

string
Updated name for the finetune (5–200 characters).
array
Replacement set of tags, at most five.
string ("private" | "workspace")
Finetune visibility. Only private and workspace can be set.
string
required
ID of the music finetune to update.
string
Updated primary musical genre.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_UPDATE_PRODUCTION_ORDERRename an open production order. Requires your own ElevenLabs connection.

Input Parameters

object
required
The order update containing the new name.
string
required
The ID of the open production order to update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_UPDATE_PROJECT_CONTENTUpdate a Studio project’s content from a URL, uploaded document or JSON chapter content. Requires your own ElevenLabs connection; auto_convert can generate audio.

Input Parameters

string
Import content from this URL; use only one content source.
string
required
The ID of the Studio project.
boolean
Whether to automatically convert the project to audio.
object
Import an .epub, .pdf, .txt or similar document; use only one content source.
string
JSON-encoded chapter and block content; omit other sources when supplied. Omit all sources for a blank project.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_UPDATE_PRONUNCIATION_DICTIONARIESUpdates a project’s pronunciation dictionaries on ElevenLabs to improve text-to-speech accuracy for specialized terms; note that while multiple dictionaries can be applied, the UI only displays the first.

Input Parameters

string
required
The ID of the project to which the pronunciation dictionaries will be applied.
array
required
List of locators, each provided as a JSON string detailing pronunciation_dictionary_id and version_id, due to form-data requirements. The ElevenLabs UI currently displays only the first applied dictionary.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_UPDATE_PRONUNCIATION_DICTIONARYPartially updates a pronunciation dictionary’s metadata (name or archived status) without changing its version. Use when you need to rename or archive/unarchive a dictionary.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_UPDATE_SPEECH_ENGINEPartially update an existing speech engine’s connection, ASR, TTS, turn detection, privacy or limits. Omitted fields remain unchanged. Requires your own ElevenLabs connection.

Input Parameters

object
Automatic speech recognition settings.
object
Text-to-speech settings.
object
Voice activity detection settings.
string
Updated speech engine name.
array
Categorization and filtering tags.
object
Turn detection settings.
object
Recording, retention and PII settings.
string
Speech engine ISO language code.
object
Settings clients may override at conversation initiation.
object
Concurrency and daily conversation limits.
object
Conversation settings and client events.
object
Upstream transcript WebSocket settings.
string
required
Speech engine ID, accepting seng_ or agent_ prefixes.
number
Seconds to wait for the upstream endpoint before abandoning and retrying (2–15).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_UPDATE_STUDIO_PROJECTUpdate a Studio project’s name, default voices, and optional download metadata. Requires your own ElevenLabs connection.

Input Parameters

string
required
The name of the Studio project, used for identification only.
string
Optional project title included in downloaded MP3 metadata.
string
Optional author included in downloaded MP3 metadata.
string
required
The ID of the Studio project.
string
Optional ISBN included in downloaded MP3 metadata.
boolean
Apply audiobook volume normalization to downloaded audio.
string
required
Default voice ID used for new titles.
string
required
Default voice ID used for new paragraphs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_UPDATE_TAGUpdate a conversation tag’s title and/or description as its owner or a workspace admin. Omit fields to leave them unchanged. Requires your own ElevenLabs connection.

Input Parameters

string
If provided, replaces the tag title. Omit to leave unchanged.
string
required
ID of the conversation tag to update.
string
If provided, replaces the tag description. Omit to leave unchanged.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_UPDATE_TEST_FOLDERRename an existing agent test folder. Currently only the folder name can be updated. Requires your own ElevenLabs connection.

Input Parameters

string
required
The new name for the folder.
string
required
The ID of the agent test folder to update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_UPDATE_TOOL_OVERRIDEUpdate configuration overrides for one MCP tool and return its server configuration. Requires your own ElevenLabs connection; omitted settings are not sent and explicit nulls are preserved.

Input Parameters

string
required
Name of the MCP tool whose overrides are updated.
array
Dynamic variable assignments for this tool.
string
Environment for resolving URL, header and auth connection environment variables.
string
required
ID of the MCP server.
string ("immediate" | "post_tool_speech" | "async")
Override the server’s execution mode.
array
Mock responses evaluated top-to-bottom; first match wins.
object
Mapping of JSON paths to input override configurations.
string ("auto" | "force" | "off")
Override the server’s pre-tool speech mode.
string
Sound name, off for silence, or null to inherit the server default.
string ("allow" | "disable_during_tool" | "disable_during_tool_and_turn")
Override the server’s interruption mode.
boolean
Deprecated: use interruption_mode instead.
boolean
Deprecated: use pre_tool_speech instead.
integer
Override tool timeout in seconds, between 5 and 300.
string ("auto" | "always")
Override when the tool sound plays.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_UPDATE_TRANSCRIPT_SEGMENTEdit a source transcript segment’s text, speaker, or timing (Enterprise only). Omitted fields stay unchanged. Bumps the project revision, discards affected translations in every language target, and marks completed targets stale. Audio changes only when a target is regenerated. Requires your own connection.

Input Parameters

string
New text; omit to leave unchanged.
number
New end time in seconds; omit to leave unchanged.
number
New start time in seconds; omit to leave unchanged.
string
required
Identifier of the dubbing project.
string
required
Identifier of the segment to edit.
string
New speaker ID; omit to leave unchanged.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_UPDATE_TRANSCRIPT_SEGMENTSEnterprise only: atomically edit source segments’ text, speaker, or timing. Increments the transcript revision, discards affected translations in every target language, and marks completed targets stale. Regenerate a target to change its audio. Requires your own ElevenLabs connection.

Input Parameters

object
required
Map of segment ID to partial update; 1 to 500 entries, applied atomically.
string
required
Identifier of the dubbing project.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_UPDATE_TRANSLATED_SEGMENTEdit a dubbing target segment’s translation (Enterprise only, own connection). Omitted translation is unchanged; null clears it for re-translation. Increments the target revision and marks a completed target stale. Audio changes only after regenerating the target; source text and other languages remain untouched.

Input Parameters

string
required
Identifier of the dubbing project.
string
required
Identifier of the segment to edit.
string
required
Identifier of the language target.
string
New translated text. Omit to leave unchanged; null marks the segment for re-translation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_UPDATE_TRANSLATED_SEGMENTSEdit 1–500 segment translations for a dubbing language target atomically (Enterprise only). Increments the target revision and marks completed targets stale. Omitted translations stay unchanged; null requests re-translation. Audio changes only after regenerating the target. Requires your own ElevenLabs connection.

Input Parameters

object
required
Map of 1 to 500 segment IDs to translation edits to apply atomically.
string
required
Identifier of the dubbing project.
string
required
Identifier of the language target.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_UPDATE_TRIAGE_TICKETUpdate a triage ticket’s title, description, status, priority, or assignee. Requires viewer access to the ticket’s agent and your own ElevenLabs connection. Omitted fields stay unchanged; null clears priority or unassigns the assignee.

Input Parameters

string
If provided, updates the ticket title. Omit to leave unchanged.
string ("open" | "in_progress" | "resolved" | "cancelled" | "merged")
If provided, updates the ticket status. Omit to leave unchanged.
string ("low" | "medium" | "high" | "urgent")
Ticket urgency. Pass null to clear it. Omit to leave unchanged.
string
If provided, updates the ticket description. Omit to leave unchanged.
string
Workspace member with at least viewer access to the agent. Pass null to unassign. Omit to leave unchanged.
string
required
ID of the triage ticket to update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_UPDATE_VOICE_COLLECTIONUpdate a voice collection’s title and icon, leaving omitted fields unchanged. Requires editor access or higher and your own ElevenLabs connection.

Input Parameters

string
New collection icon (up to 1000 characters), or null. Omit to leave unchanged.
string
New collection title (up to 1000 characters), or null. Omit to leave unchanged.
string
required
ID of the voice collection to update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_UPDATE_VOICE_SAMPLEUpdate a professional voice cloning sample’s noise removal, speaker selection, trim times or file name. Requires your own ElevenLabs connection. Speaker selection replaces the previous selection.

Input Parameters

string
required
ID of the professional voice to update.
string
Name of the audio file used for PVC training.
string
required
ID of the voice sample to update.
integer
End time of the training audio in milliseconds.
integer
Start time of the training audio in milliseconds.
array
Speaker IDs for PVC training. Send all desired IDs together: each request overrides the previous selection.
boolean
Remove background noise using audio isolation. May worsen quality if the sample has no background noise.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_UPDATE_WHATSAPP_ACCOUNTUpdate a WhatsApp account’s assigned agent, messaging, audio responses, or typing indicator. Omitted settings are not sent. Requires your own ElevenLabs connection.

Input Parameters

string
required
ID of the WhatsApp phone number to update.
boolean
Whether messaging is enabled. May be null.
string
Agent ID to assign to the WhatsApp account. May be null.
boolean
Whether the typing indicator is enabled. May be null.
boolean
Whether audio message responses are enabled. May be null.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_UPDATE_WORKSPACE_WEBHOOKUpdates a workspace webhook by ID, setting both its display name and enabled or disabled status.

Input Parameters

string
required
The display name of the webhook (used for display purposes only).
string
required
The unique ID for the webhook
boolean
required
Whether to disable or enable the webhook

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_UPLOAD_ASSETUpload a file as a new asset with a display name and return its metadata and signed content URL. Requires your own ElevenLabs connection.

Input Parameters

string
required
Display name for the asset.
object
required
The file to upload.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_UPLOAD_CONVERSATION_FILEUpload an image, PDF, or text file for a conversation and return its reference ID. Requires your own ElevenLabs connection.

Input Parameters

object
required
Image, PDF, or text file to upload.
string
required
The ID of the conversation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_UPLOAD_MUSICUpload music for later inpainting and optionally extract a composition plan, timestamps, or waveform. Uploads are charged at song-generation prices and inspected for copyright infringement; detected copyrighted content still incurs half the request cost. Requires your own ElevenLabs connection.

Input Parameters

object
required
Audio file to upload, with a duration between 10 and 600 seconds.
boolean
Transcribe the song and return word-level timestamps; increases latency.
boolean
Return the visual waveform of the uploaded song.
string
Extract a composition plan in the selected model format. Boolean values are deprecated; true selects music_v1. Extraction increases latency.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_UPSERT_ORDER_ITEMAdd or update a dubbing, subtitle, or transcription item on an open production order and return its ID and quoted price. Requires your own ElevenLabs connection.

Input Parameters

object
required
Item upsert request.
string
required
The ID of the open order.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_VERIFY_CAPTCHASubmit the user’s audio recording to verify a professional voice cloning captcha. Requires your own ElevenLabs connection.

Input Parameters

string
required
Voice ID of the professional voice to verify. List available voices with GET /v1/voices.
object
required
Audio recording of the user for captcha verification.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELEVENLABS_VOICE_GENERATION_PARAMETERSFetches configurable parameters for ElevenLabs voice generation, used to determine available settings (e.g., accents, character limits) prior to audio synthesis; returns metadata only, not audio.

Output

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