All servers / Audio / ElevenLabs
ElevenLabs
Text to speech and voices.
Tested by ConnectATDScore 75 out of 100. Tested 2026-11-17 on package version 1.0.4. Package: @angelogiacco/elevenlabs-mcp-server · source
Score breakdown
| Runs | 18 / 20 | |
|---|---|---|
| Tool descriptions | 18 / 20 | |
| Package safety | 20 / 20 | |
| Maintenance | 3 / 20 | |
| Adoption | 16 / 20 |
What we saw
- Starts and answers the MCP handshake: yes (7.7 seconds including download)
- Tools offered: 546
- Last published: 2025-03-09
- Weekly downloads (npm): 12,492
- License: MIT · Direct dependencies: 4
Want this server set up for your team?
ConnectATD builds AI automation and wires up MCP servers like this one. Tell us what you are trying to do.
Talk to ConnectATDTools and how they are described
Agents choose tools from these descriptions. Under each name you can see how many of its parameters are explained.
List_Generated_Items10 of 10 parameters describedReturns a list of your generated audio (e.g. text to speech, speech to speech, Studio, dubbing). Music and SFX generations are not included and cannot currently be retrieved via the API.
Get_History_Item2 of 2 parameters describedRetrieves a history item.
Delete_History_Item2 of 2 parameters describedDelete a history item by its ID
Get_Audio_From_History_Item2 of 2 parameters describedReturns the audio of an history item.
Download_History_Items1 of 1 parameter describedDownload one or more history items. If one history item ID is provided, we will return a single audio file. If more than one history item IDs are provided, we will provide the history items packed into a .zip file.
Sound_Generation3 of 3 parameters describedTurn text into sound effects for your videos, voice-overs or video games using the most advanced sound effects models in the world.
Audio_Isolation1 of 1 parameter describedRemoves background noise from audio
Get_Audio_Isolation_History4 of 4 parameters describedReturns a list of all your audio isolation generations.
Delete_Audio_Isolation_History_Item2 of 2 parameters describedDeletes a specific audio isolation history item and the associated media files.
Audio_Isolation_Stream1 of 1 parameter describedRemoves background noise from audio and streams the result
Get_Audio_Effects_Catalog1 of 1 parameter describedLists the filter presets, reverb environments, and background noises that `audio_effects` can reference in Text to Speech, Text to Dialogue, and agent configurations.
Delete_Sample3 of 3 parameters describedRemoves a sample by its ID.
Get_Audio_From_Sample3 of 3 parameters describedReturns the audio corresponding to a sample attached to a voice.
Text_To_Speech5 of 5 parameters describedConverts text into speech using a voice of your choice and returns audio.
Text_To_Speech_With_Timestamps5 of 5 parameters describedGenerate speech from text with precise character-level timing information for audio-text synchronization.
Text_To_Speech_Streaming5 of 5 parameters describedConverts text into speech using a voice of your choice and returns audio as an audio stream.
Text_To_Speech_Streaming_With_Timestamps5 of 5 parameters describedConverts text into speech using a voice of your choice and returns a stream of JSONs containing audio as a base64 encoded string together with information on when which character was spoken.
Text_To_Dialogue_Multi-Voice_3 of 3 parameters describedConverts a list of text and voice ID pairs into speech (dialogue) and returns audio.
Text_To_Dialogue_Multi-Voice_Streaming3 of 3 parameters describedConverts a list of text and voice ID pairs into speech (dialogue) and returns an audio stream.
Text_To_Dialogue_Streaming_With_Timestamps3 of 3 parameters describedConverts a list of text and voice ID pairs into speech (dialogue) and returns a stream of JSON blobs containing audio as a base64 encoded string and timestamps
Text_To_Dialogue_With_Timestamps3 of 3 parameters describedGenerate dialogue from text with precise character-level timing information for audio-text synchronization.
Voice_Changer5 of 5 parameters describedTransform audio from one voice to another. Maintain full control over emotion, timing and delivery.
Voice_Changer_Streaming5 of 5 parameters describedStream audio from one voice to another. Maintain full control over emotion, timing and delivery.
_Deprecated_Generate_A_Voice_Preview_From_Description2 of 2 parameters described**Deprecated.** Use `POST /v1/text-to-voice/design` instead. Generate a custom voice based on voice description. This method returns a list of voice previews. Each preview has a generated_voice_id and a sample of the voice as base64 encoded mp3 audio. To create the voice use `POST /v1/text-to-voice` with the chosen `generated_voice_id`.
Create_A_New_Voice_From_Voice_Preview1 of 1 parameter describedCreate a voice from previously generated voice preview. This endpoint should be called after you fetched a generated_voice_id using POST /v1/text-to-voice/design or POST /v1/text-to-voice/:voice_id/remix.
Design_A_Voice_2 of 2 parameters describedDesign a voice via a prompt. This method returns a list of voice previews. Each preview has a generated_voice_id and a sample of the voice as base64 encoded mp3 audio. To create a voice use the generated_voice_id of the preferred preview with the /v1/text-to-voice endpoint.
Remix_A_Voice_3 of 3 parameters describedRemix an existing voice via a prompt. This method returns a list of voice previews. Each preview has a generated_voice_id and a sample of the voice as base64 encoded mp3 audio. To create a voice use the generated_voice_id of the preferred preview with the /v1/text-to-voice endpoint.
Text_To_Voice_Preview_Streaming2 of 2 parameters describedStream a voice preview that was created via the /v1/text-to-voice/design endpoint.
Get_User_Info1 of 1 parameter describedGets information about the user
Get_User_Subscription_Info1 of 1 parameter describedGets extended information about the users subscription
List_Voice_Collections1 of 1 parameter describedReturns all the voice collections the user has access to, sorted by title.
Create_Voice_Collection1 of 1 parameter describedCreates a new voice collection. The caller becomes its admin.
Get_Voice_Collection2 of 2 parameters describedReturns a voice collection the user has access to.
Update_Voice_Collection2 of 2 parameters describedUpdates the title and icon of a voice collection. Fields that are omitted are left unchanged. Requires editor access to the collection.
Delete_Voice_Collection2 of 2 parameters describedDeletes a voice collection. The voices in it are not deleted. Requires admin access to the collection.
Add_Voice_To_Collection3 of 3 parameters describedAdds a voice to a voice collection. Adding a voice that is already in the collection succeeds without changes. Requires editor access to the collection.
Remove_Voice_From_Collection3 of 3 parameters describedRemoves a voice from a voice collection. The voice itself is not deleted. Requires editor access to the collection.
Get_Default_Voice_Settings_no parametersGets the default settings for voices. "similarity_boost" corresponds to"Clarity + Similarity Enhancement" in the web app and "stability" corresponds to "Stability" slider in the web app.
Get_Voice_Settings2 of 2 parameters describedReturns the settings for a specific voice. "similarity_boost" corresponds to"Clarity + Similarity Enhancement" in the web app and "stability" corresponds to "Stability" slider in the web app.
Edit_Voice_Settings2 of 2 parameters describedEdit your settings for a specific voice. "similarity_boost" corresponds to "Clarity + Similarity Enhancement" in the web app and "stability" corresponds to "Stability" slider in the web app.
Get_Voice_Accents3 of 3 parameters describedGets the list of available accents in the shared voice library.
List_Voices2 of 2 parameters describedReturns a list of all available voices for a user. Stops working once the user's workspace exceeds 500 voices.
Get_Voice3 of 3 parameters describedReturns metadata about a specific voice.
Delete_Voice2 of 2 parameters describedDeletes a voice by its ID.
Edit_Voice2 of 2 parameters describedEdit a voice created by you.
Get_Voices_V221 of 21 parameters describedGets a list of all available voices for a user with search, filtering and pagination.
Replicate_Voice_To_Isolated_Environment2 of 2 parameters describedReplicates an Instant Voice Clone or Voice Design voice to a workspace in a different data residency. The target workspace must belong to the same consolidated billing group. The user must have VOICES_WRITE in the source workspace, and be an admin on the source voice. Human users (i.e. not service accounts) must also have VOICES_WRITE in the target workspace. This endpoint is available on the central environment only.
Add_Voice1 of 1 parameter describedAdd a new voice to your collection of voices in VoiceLab.
Add_Shared_Voice3 of 3 parameters describedAdd a shared voice to your collection of voices.
Create_Podcast2 of 2 parameters describedCreate and auto-convert a podcast project. Currently, the LLM cost is covered by us but you will still be charged for the audio generation. In the future, you will be charged for both the LLM and audio generation costs.
Create_Pronunciation_Dictionaries2 of 2 parameters describedCreate a set of pronunciation dictionaries acting on a project. This will automatically mark text within this project as requiring reconverting where the new dictionary would apply or the old one no longer does.
List_Studio_Projects1 of 1 parameter describedReturns a list of your Studio projects with metadata.
Create_Studio_Project1 of 1 parameter describedCreates a new Studio project, it can be either initialized as blank, from a document or from a URL.
Update_Studio_Project2 of 2 parameters describedUpdates the specified Studio project by setting the values of the parameters passed.
Get_Studio_Project3 of 3 parameters describedReturns information about a specific Studio project. This endpoint returns more detailed information about a project than `GET /v1/studio`.
Delete_Studio_Project2 of 2 parameters describedDeletes a Studio project.
Update_Studio_Project_Content2 of 2 parameters describedUpdates Studio project content.
Convert_Studio_Project2 of 2 parameters describedStarts conversion of a Studio project and all of its chapters.
List_Studio_Project_Snapshots2 of 2 parameters describedRetrieves a list of snapshots for a Studio project.
Get_Project_Snapshot3 of 3 parameters describedReturns the project snapshot.
Stream_Studio_Project_Audio3 of 3 parameters describedStream the audio from a Studio project snapshot.
Stream_Archive_With_Studio_Project_Audio3 of 3 parameters describedReturns a compressed archive of the Studio project's audio.
List_Chapters2 of 2 parameters describedReturns a list of a Studio project's chapters.
Create_Chapter2 of 2 parameters describedCreates a new chapter either as blank or from a URL.
Get_Chapter3 of 3 parameters describedReturns information about a specific chapter.
Update_Chapter3 of 3 parameters describedUpdates a chapter.
Delete_Chapter3 of 3 parameters describedDeletes a chapter.
Convert_Chapter3 of 3 parameters describedStarts conversion of a specific chapter.
List_Chapter_Snapshots3 of 3 parameters describedGets information about all the snapshots of a chapter. Each snapshot can be downloaded as audio. Whenever a chapter is converted a snapshot will automatically be created.
Get_Chapter_Snapshot4 of 4 parameters describedReturns the chapter snapshot.
Stream_Chapter_Audio4 of 4 parameters describedStream the audio from a chapter snapshot. Use `GET /v1/studio/projects/{project_id}/chapters/{chapter_id}/snapshots` to return the snapshots of a chapter.
Get_Project_Muted_Tracks2 of 2 parameters describedReturns a list of chapter IDs that have muted tracks in a project.
Create_Dubbing_Project1 of 1 parameter describedCreate a dubbing project from an uploaded file (`file`) or a source URL (`source_url`). Returns as soon as the project record exists, before the source has been fetched: the project starts `queued` and reaches `ready` once its source has been transcribed. Add a language target to it for each language you want, or pass `target_language` to queue the first one here. Creating a project incurs a minimum charge of one language: you are charged for at least one language's dubbing when the project is created, before any output exists. This charge prepays the first language target — the first target you add, or the one queued via `target_language`, consumes it — and each additional language is charged separately. Preparation can take minutes on a long source, so we recommend passing `webhook_ids` to be notified when the project turns `ready` or `failed`, rather than polling for it.
List_Dubbing_Projects5 of 5 parameters describedList the dubbing projects in your workspace that you can access, newest first, cursor-paginated. Listed projects carry no `language_ids`; fetch a project, or list its language targets, to see them.
Get_Dubbing_Project2 of 2 parameters describedFull project detail, including the IDs of every language target under it. To follow a project to `ready`, we recommend a `webhook_ids` subscription rather than polling this endpoint.
Delete_Dubbing_Project2 of 2 parameters describedDelete a project, every language target under it, and their stored media and outputs. This cannot be undone, and a dub already running is still billed.
Create_Dubbing_Language_Target2 of 2 parameters describedAdd a language to dub a project into, and queue the dub. This is the call that produces dubbed audio, and it is billed per generation. The target is created `queued` and starts as soon as the project is `ready`, so it can be added at any point after the project is created. It inherits the project's dubbing model and cannot pick another. A project created with `webhook_ids` sends a `dubbing_language_completed` event carrying the output download URLs, so we recommend subscribing rather than polling this target to completion.
List_Dubbing_Language_Targets5 of 5 parameters describedList a project's language targets, cursor-paginated, each with signed output URLs once it has produced an output.
Get_Dubbing_Language_Target3 of 3 parameters describedFull language-target detail. Once the target reports `completed`, `outputs` carries the signed download URLs. To learn when that happens, we recommend the project's `webhook_ids` subscription rather than polling this endpoint; fetch here when a delivered URL has expired, or to reconcile after an edit.
Delete_Dubbing_Language_Target3 of 3 parameters describedDelete a language target and its outputs, leaving the project and its other languages intact. This cannot be undone, and a dub already running is still billed.
Get_Dubbing_Transcript2 of 2 parameters describedThe project's source transcript, as editable segments. Available once the project is `ready`.
Update_Dubbing_Transcript_Segment3 of 3 parameters describedEnterprise only. Edit a source segment's text, speaker, or timing. Omitted fields are left unchanged. Bumps the project's `revision`, discards the affected translations in every language target, and marks any target that had already completed `stale`. No audio changes until you regenerate a target.
Delete_Dubbing_Transcript_Segment3 of 3 parameters describedEnterprise only. Remove a source segment from the transcript so it is no longer dubbed. Bumps the project's `revision`, discards the affected translations in every language target, and marks any target that had already completed `stale`. No audio changes until you regenerate a target.
Update_Dubbing_Transcript_Segments2 of 2 parameters describedEnterprise only. Edit several source segments' text, speaker, or timing in one atomic request: every edit applies or none does. Bumps the project's `revision`, discards the affected translations in every language target, and marks any target that had already completed `stale`. No audio changes until you regenerate a target.
Add_Dubbing_Transcript_Segment2 of 2 parameters describedEnterprise only. Add a new source segment to the transcript. Its span must lie within the source media, last between 0.1 and 25 seconds, and not overlap another segment by the same speaker. Bumps the project's `revision`, discards the affected translations in every language target, and marks any target that had already completed `stale`. No audio changes until you regenerate a target.
Get_Dubbing_Target_Transcript3 of 3 parameters describedA language target's transcript: source segments with their translations. Available once the target has produced an output. Returns a conflict while the target is still on its first dub, since it has no translations to return yet.
Update_Dubbing_Target_Transcript_Segment4 of 4 parameters describedEnterprise only. Edit a segment's translation for a language target. Omitted fields are left unchanged; an explicit null clears the field. Bumps the target's `revision` and marks it `stale` if it had already completed. The source transcript and the project's other languages are untouched, and no audio changes until you regenerate the target.
Update_Dubbing_Target_Transcript_Segments3 of 3 parameters describedEnterprise only. Edit several segments' translations for a language target in one atomic request: every edit applies or none does. Bumps the target's `revision` and marks it `stale` if it had already completed. The source transcript and the project's other languages are untouched, and no audio changes until you regenerate the target.
Regenerate_Dubbing_Target3 of 3 parameters describedEnterprise only. Re-dub a target from its edited transcript, re-synthesizing only the edited regions (charged like a generation, less the free-regeneration allowance). Accepted asynchronously: the target returns to `processing` and sends a `dubbing_language_completed` event to the project's `webhook_ids` when the re-dub lands, carrying the new output URLs. Returns a conflict when the target has no edits to apply — nothing is dispatched and nothing is charged.
Get_The_Dubbing_Resource_For_An_Id_2 of 2 parameters describedGiven a dubbing ID generated from the '/v1/dubbing' endpoint with studio enabled, returns the dubbing resource.
Add_A_Language_To_The_Resource2 of 2 parameters describedAdds the given ElevenLab Turbo V2/V2.5 language code to the resource. Does not automatically generate transcripts/translations/audio.
Create_A_Segment_For_The_Speaker3 of 3 parameters describedCreates a new segment in dubbing resource with a start and end time for the speaker in every available language. Does not automatically generate transcripts/translations/audio.
Modify_A_Single_Segment4 of 4 parameters describedModifies a single segment with new text and/or start/end times. Will update the values for only a specific language of a segment. Does not automatically regenerate the dub.
Move_Segments_Between_Speakers2 of 2 parameters describedChange the attribution of one or more segments to a different speaker.
Deletes_A_Single_Segment3 of 3 parameters describedDeletes a single segment from the dubbing.
Transcribes_Segments2 of 2 parameters describedRegenerate the transcriptions for the specified segments. Does not automatically regenerate translations or dubs.
Translates_All_Or_Some_Segments_And_Languages2 of 2 parameters describedRegenerate the translations for either the entire resource or the specified segments/languages. Will automatically transcribe missing transcriptions. Will not automatically regenerate the dubs.
Dubs_All_Or_Some_Segments_And_Languages2 of 2 parameters describedRegenerate the dubs for either the entire resource or the specified segments/languages. Will automatically transcribe and translate any missing transcriptions and translations.
Update_Metadata_For_A_Speaker3 of 3 parameters describedAmend the metadata associated with a speaker, such as their voice. Both voice cloning and using voices from the ElevenLabs library are supported.
Create_A_New_Speaker2 of 2 parameters describedCreates a new speaker in a dubbing resource. The speaker is added to every available language and can optionally be associated with an ElevenLabs voice and voice settings.
Search_The_Elevenlabs_Library_For_Voices_Similar_To_A_Speaker_3 of 3 parameters describedFetch the top 10 similar voices to a speaker, including the voice IDs, names, descriptions, and, where possible, a sample audio recording.
Render_Audio_Or_Video_For_The_Given_Language3 of 3 parameters describedRegenerate the output media for a language using the latest Studio state. Please ensure all segments have been dubbed before rendering, otherwise they will be omitted. Renders are generated asynchronously, and to check the status of all renders please use the 'Get Dubbing Resource' endpoint.
List_Dubs11 of 11 parameters describedList the dubs you have access to.
Dub_A_Video_Or_An_Audio_File1 of 1 parameter describedDubs a provided audio or video file into given language.
Get_Dubbing2 of 2 parameters describedReturns metadata about a dubbing project, including whether it's still in progress or not
Delete_Dubbing2 of 2 parameters describedDeletes a dubbing project.
Get_Dubbed_File3 of 3 parameters describedReturns dub as a streamed MP3 or MP4 file. If this dub has been edited using Dubbing Studio you need to use the resource render endpoint as this endpoint only returns the original automatic dub result.
Get_Dubbed_Transcript4 of 4 parameters describedReturns transcript for the dub as an SRT or WEBVTT file.
Retrieve_A_Transcript4 of 4 parameters describedFetch the transcript for one of the languages in a dub.
Get_Models1 of 1 parameter describedGets a list of available models.
Creates_Audio_Native_Enabled_Project_1 of 1 parameter describedCreates Audio Native enabled project, optionally starts conversion and returns project ID and embeddable HTML snippet.
Get_Audio_Native_Project_Settings2 of 2 parameters describedGet player settings for the specific project.
Update_Audio-Native_Project_Content2 of 2 parameters describedUpdates content for the specific AudioNative Project.
Update_Audio-Native_Content_From_Url1 of 1 parameter describedFinds an AudioNative project matching the provided URL, extracts content from the URL, updates the project content, and queues it for conversion and auto-publishing.
Check_Watermark1 of 1 parameter describedCheck an audio file for an embedded ElevenLabs watermark. This endpoint is in beta and may change.
Get_Similar_Library_Voices1 of 1 parameter describedReturns a list of shared voices similar to the provided audio sample. If neither similarity_threshold nor top_k is provided, we will apply default values.
Get_Voices19 of 19 parameters describedRetrieves a list of shared voices.
Get_Characters_Usage_Metrics_Deprecated_8 of 8 parameters described(Deprecated) This endpoint is deprecated. Use /v1/workspace/analytics/query/usage-by-product-over-time instead, which exposes the bucket size as `interval_seconds` (an integer in seconds) rather than `aggregation_interval`. Returns the usage metrics for the current user or the entire workspace they are part of. The response provides a time axis based on the specified aggregation interval (default: day), with usage values for each interval along that axis. Usage is broken down by the selected breakdown type. For example, breakdown type "voice" will return the usage of each voice for each interval along the time axis.
Add_A_Pronunciation_Dictionary1 of 1 parameter describedCreates a new pronunciation dictionary from a lexicon .PLS file
Add_A_Pronunciation_Dictionary1 of 1 parameter describedCreates a new pronunciation dictionary from provided rules.
Update_Pronunciation_Dictionary2 of 2 parameters describedPartially update the pronunciation dictionary without changing the version
Get_Metadata_For_A_Pronunciation_Dictionary2 of 2 parameters describedGet metadata for a pronunciation dictionary
Set_Rules_On_The_Pronunciation_Dictionary2 of 2 parameters describedReplaces all existing rules on the pronunciation dictionary with the provided ones.
Add_Rules_To_The_Pronunciation_Dictionary2 of 2 parameters describedAdd rules to the pronunciation dictionary. If a rule with the same string_to_replace already exists, it will be replaced.
Remove_Rules_From_The_Pronunciation_Dictionary2 of 2 parameters describedRemove rules from the pronunciation dictionary
Get_A_Pls_File_With_A_Pronunciation_Dictionary_Version_Rules3 of 3 parameters describedGet a PLS file with a pronunciation dictionary version rules
Get_Pronunciation_Dictionaries6 of 6 parameters describedGet a list of the pronunciation dictionaries you have access to and their metadata
Disable_Api_Key2 of 2 parameters describedDisable the API key used to authenticate this request. Requires the query parameter `api_key_name=self` as an explicit confirmation.
Set_Workspace_Third-Party_Disabling_Policy1 of 1 parameter describedSet the workspace-wide Third-Party Disabling policy. When set, it forces, for every API key in the workspace, whether the holder of a key (potentially a third party who found it) may disable it via the self-disable endpoint or when it leaks publicly — overriding each key's own setting. Pass `true` to allow it for all keys, `false` to forbid it for all keys, or `null` to clear the override so per-key values and the plan default apply again. Workspace admins only.
Get_Service_Account_Api_Keys_Route2 of 2 parameters describedGet all API keys for a service account
Create_Service_Account_Api_Key2 of 2 parameters describedCreate a new API key for a service account
Edit_Service_Account_Api_Key3 of 3 parameters describedUpdate an existing API key for a service account
Delete_Service_Account_Api_Key3 of 3 parameters describedDelete an existing API key for a service account
Disable_Service_Account_Api_Key3 of 3 parameters describedDisable an existing API key for a service account without changing its other settings. This stays available after a workspace downgrades off a plan that includes service accounts. Turning the key back on still requires that plan.
Get_Workspace_Audit_Logs8 of 8 parameters describedReturns the audit log for the workspace. Requires enterprise tier and the audit_log_read permission.
Create_Workspace_Auth_Connection1 of 1 parameter describedCreate a new OAuth2 auth connection for the workspace
Get_Workspace_Auth_Connections1 of 1 parameter describedGet all auth connections for the workspace
Update_Workspace_Auth_Connection2 of 2 parameters describedUpdate an auth connection
Delete_Workspace_Auth_Connection2 of 2 parameters describedDelete an auth connection
Get_Workspace_Service_Accounts1 of 1 parameter describedList all service accounts in the workspace
Create_Service_Account1 of 1 parameter describedCreate a new service account in the workspace. By default, a workspace can have up to 20 service accounts. Enterprise customers may request an increase to this limit.
Get_All_Groups1 of 1 parameter describedGet all groups in the workspace
Search_User_Groups2 of 2 parameters describedSearches for user groups in the workspace. Multiple or no groups may be returned.
Delete_Member_From_User_Group2 of 2 parameters describedRemoves a member from the specified group. Requires `group_members_manage` permission.
Add_Member_To_User_Group2 of 2 parameters describedAdds a member of your workspace to the specified group. Requires `group_members_manage` permission.
Invite_User1 of 1 parameter describedSends an email invitation to join your workspace to the provided email. If the user doesn't have an account they will be prompted to create one. If the user accepts this invite they will be added as a user to your workspace and your subscription using one of your seats. This endpoint may only be called by workspace members with the WORKSPACE_MEMBERS_INVITE permission. If the user is already in the workspace a 400 error will be returned.
Invite_Multiple_Users1 of 1 parameter describedSends email invitations to join your workspace to the provided emails. Requires all email addresses to be part of a verified domain. If the users don't have an account they will be prompted to create one. If the users accept these invites they will be added as users to your workspace and your subscription using one of your seats. This endpoint may only be called by workspace members with the WORKSPACE_MEMBERS_INVITE permission.
Delete_Existing_Invitation1 of 1 parameter describedInvalidates an existing email invitation. The invitation will still show up in the inbox it has been delivered to, but activating it to join the workspace won't work. This endpoint may only be called by workspace members with the WORKSPACE_MEMBERS_INVITE permission.
Get_Workspace_Members1 of 1 parameter describedGets a list of all members of the workspace, including locked members. Service accounts are excluded. Requires the workspace_members_read permission.
Update_Member1 of 1 parameter describedUpdates attributes of a workspace member. Apart from the email identifier, all parameters will remain unchanged unless specified. This endpoint may only be called by workspace administrators.
Update_Member_Usage_Limit2 of 2 parameters describedSets or clears the monthly credit usage limit of a workspace member or service account. This endpoint may only be called by workspace administrators.
Get_Resource3 of 3 parameters describedGets the metadata of a resource by ID.
Share_Workspace_Resource2 of 2 parameters describedGrants a role (one of 'admin', 'editor', 'commenter', or 'viewer') on a workspace resource to a user, group, or workspace (service account) API key. This overrides any existing role the target has on the resource. To target a user or service account, pass only the user email; the user must be in your workspace. To target a group, pass only the group id. To target a workspace (service account) API key, pass the api key id; the resource will be shared with the service account associated with that key. You must have admin access to the resource to share it.
Unshare_Workspace_Resource2 of 2 parameters describedRemoves any existing role on a workspace resource from a user, group, or workspace (service account) API key. To target a user or service account, pass only the user email; the user must be in your workspace. To target a group, pass only the group id. To target a workspace (service account) API key, pass the api key id; the resource will be unshared from the service account associated with that key. You must have admin access to the resource to unshare it. You cannot remove permissions from the user who created the resource.
List_Workspace_Webhooks2 of 2 parameters describedList all webhooks for a workspace
Create_Workspace_Webhook1 of 1 parameter describedCreate a new webhook for the workspace with the specified authentication type.
Update_Workspace_Webhook2 of 2 parameters describedUpdate the specified workspace webhook
Delete_Workspace_Webhook2 of 2 parameters describedDelete the specified workspace webhook
Video_To_Music3 of 3 parameters describedGenerate background music from one or more video files. Videos are combined in order. Optional description and style tags influence the generated music.
Speech_To_Text3 of 3 parameters describedTranscribe an audio or video file. If webhook is set to true, the request will be processed asynchronously and results sent to configured webhooks. When use_multi_channel is true and the provided audio has multiple channels, a 'transcripts' object with separate transcripts for each channel is returned; set multichannel_output_style='combined' to instead receive a single transcript with all channels merged and sorted by time. Otherwise, returns a single transcript. The optional webhook_metadata parameter allows you to attach custom data that will be included in webhook responses for request correlation and tracking.
Get_Transcript_By_Id2 of 2 parameters describedRetrieve a previously generated transcript by its ID.
Delete_Transcript_By_Id2 of 2 parameters describedDelete a previously generated transcript by its ID.
Create_Single_Use_Token3 of 3 parameters describedGenerate a time limited single-use token with embedded authentication for frontend clients.
Create_Forced_Alignment1 of 1 parameter describedForce align an audio file to text. Use this endpoint to get the timing information for each character and word in an audio file based on a provided text transcript.
Get_Signed_Url7 of 7 parameters describedGet a signed url to start a conversation with an agent with an agent that requires authorization
Get_Webrtc_Token7 of 7 parameters describedGet a WebRTC session token for real-time communication.
Handle_An_Outbound_Call_Via_Twilio1 of 1 parameter describedHandle an outbound call via Twilio
Register_A_Twilio_Call_And_Return_Twiml1 of 1 parameter describedRegister a Twilio call and return TwiML to connect the call
Handle_An_Outbound_Call_Via_Exotel1 of 1 parameter describedHandle an outbound call via Exotel Connect API
Make_An_Outbound_Call_Via_Whatsapp1 of 1 parameter describedMake an outbound call via WhatsApp
Send_An_Outbound_Message_Via_Whatsapp1 of 1 parameter describedSend an outbound message via WhatsApp
Create_Agent2 of 2 parameters describedCreate an agent from a config object
Get_Agent_Summaries2 of 2 parameters describedReturns summaries for the specified agents.
Get_Agent5 of 5 parameters describedRetrieve config for an agent
Patches_An_Agent_Settings5 of 5 parameters describedPatches an Agent settings
Delete_Agent3 of 3 parameters describedDelete an agent
Get_Agent_Subagent_Dependents4 of 4 parameters describedGet a list of agents that use this agent as a subagent.
Get_Agent_Widget_Config3 of 3 parameters describedRetrieve the widget configuration for an agent
Get_Shareable_Agent_Link2 of 2 parameters describedGet the current link used to share the agent with others
Post_Agent_Avatar2 of 2 parameters describedSets the avatar for an agent displayed in the widget
Post_Agent_Hold_Audio2 of 2 parameters describedSets the custom hold audio played on loop to callers waiting in the agent's concurrency wait queue. Replaces any previously uploaded clip.
Delete_Agent_Hold_Audio2 of 2 parameters describedRemoves the agent's custom hold audio; queued callers hear the default hold tone again.
List_Agents10 of 10 parameters describedReturns a list of your agents and their metadata.
Returns_The_Size_Of_The_Agent_S_Knowledge_Base2 of 2 parameters describedReturns the number of pages in the agent's knowledge base.
Calculate_Expected_Llm_Usage_For_An_Agent2 of 2 parameters describedCalculates expected number of LLM tokens needed for the specified agent.
Duplicate_Agent2 of 2 parameters describedCreate a new agent by duplicating an existing one. The new agent gets a copy of every unarchived branch of the source agent, each with the same name and description and starting from the latest version on that branch. The live traffic split is copied onto the new branches, with any share held by a branch that was not copied moved to main. Version history, drafts, archived branches, past traffic splits and experiments are not copied.
Simulates_A_Conversation2 of 2 parameters describedDeprecated. This endpoint will be removed on 31 Oct 2026. Use the `/v1/convai/agent-testing/create` and `/v1/convai/agents/:agent_id/run-tests` endpoints to create and run simulations. Run a conversation between the agent and a simulated user.
Simulates_A_Conversation_Stream_2 of 2 parameters describedDeprecated. This endpoint will be removed on 31 Oct 2026. Use the `/v1/convai/agent-testing/create` and `/v1/convai/agents/:agent_id/run-tests` endpoints to create and run simulations. Run a conversation between the agent and a simulated user and stream back the response. Response is streamed back as partial lists of messages that should be concatenated and once the conversation has complete a single final message with the conversation analysis will be sent.
Create_Agent_Response_Test1 of 1 parameter describedCreates a new agent response test.
Create_Agent_Test_Folder1 of 1 parameter describedCreates a folder for organizing agent tests.
Get_Agent_Test_Folder_By_Id2 of 2 parameters describedGets an agent test folder by ID, including its folder path.
Update_Agent_Test_Folder2 of 2 parameters describedUpdates an agent test folder. Currently only supports updating the folder name.
Delete_Agent_Test_Folder3 of 3 parameters describedDeletes an agent test folder by ID. Use force=true to delete a non-empty folder and all its contents.
Bulk_Move_Tests_To_Folder1 of 1 parameter describedMoves multiple tests or folders from one folder to another.
Get_Agent_Response_Test_By_Id2 of 2 parameters describedGets an agent response test by ID.
Update_Agent_Response_Test2 of 2 parameters describedUpdates an agent response test by ID.
Delete_Agent_Response_Test2 of 2 parameters describedDeletes an agent response test by ID.
Get_Agent_Response_Test_Summaries_By_Ids1 of 1 parameter describedGets agent response test summaries for the requested test IDs.
List_Agent_Response_Tests10 of 10 parameters describedLists all agent response tests with pagination support and optional search filtering.
List_Test_Invocations11 of 11 parameters describedLists all test invocations with pagination support and optional search filtering.
Run_Tests_On_The_Agent2 of 2 parameters describedRun selected tests on the agent with provided configuration. If the agent configuration is provided, it will be used to override default agent configuration.
Get_Test_Invocation2 of 2 parameters describedGets a test invocation by ID.
Update_Test_Invocation2 of 2 parameters describedUpdates the user-provided name of a test invocation.
Cancel_Test_Invocation2 of 2 parameters describedCancels all pending runs in a test invocation.
Resubmit_Tests2 of 2 parameters describedResubmits specific test runs from a test invocation.
Get_Conversations49 of 49 parameters describedGet all conversations of agents that user owns. With option to restrict to a specific agent.
Create_Conversation1 of 1 parameter describedCreate a text conversation with an agent. This does not run the agent, and the agent sends no first message. This endpoint is in alpha and may change.
Get_Conversation_Users10 of 10 parameters describedGet distinct users from conversations with pagination.
Resolve_Conversation_Reference3 of 3 parameters describedResolve a conversation URL (a Slack message URL or a Zendesk ticket URL) to the deterministic conversation ID for the given agent, then confirm the conversation exists.
Get_Conversation_Details3 of 3 parameters describedGet the details of a particular conversation
Delete_Conversation2 of 2 parameters describedDelete a particular conversation
Get_Conversation_Summary3 of 3 parameters describedGet a lightweight summary of a conversation: its title, the generated transcript summary, whether the call was successful, and — only when the conversation is short — the plain chat messages. Tool calls, tool results, and contextual updates are omitted so the response stays small. Use this instead of the full conversation endpoint when you only need the gist (e.g. an agent reading many conversations); use GET /v1/convai/conversations/{conversation_id} when you need the full transcript with tool calls and contextual updates.
Get_Sip_Messages_For_A_Conversation4 of 4 parameters describedGet SIP messages associated with a conversation's phone call
Get_Conversation_Audio2 of 2 parameters describedGet the audio recording of a particular conversation
Get_Conversation_File3 of 3 parameters describedDownload a file the user attached to a conversation, including while the conversation is still active.
Delete_File_Upload3 of 3 parameters describedRemove a file upload from a conversation. Only possible if the file hasn't already been used in the conversation.
Send_Conversation_Feedback1 of 1 parameter describedSend the feedback for the given conversation
Text_Search_Conversation_Messages40 of 40 parameters describedSearch through conversation transcript messages by full-text and fuzzy search
Smart_Search_Conversation_Messages6 of 6 parameters describedSearch conversation transcripts by semantic similarity to surface relevant messages based on meaning and intent, rather than exact keyword matches
Assign_Conversation_Tags2 of 2 parameters describedAssign one or more conversation tags to a conversation. Tags that are already assigned are ignored. Tags must belong to the same workspace.
Unassign_Conversation_Tag3 of 3 parameters describedRemove a single conversation tag from a conversation.
List_Conversation_Tags3 of 3 parameters describedList conversation tags for the workspace, ordered by most recently created first.
Create_Conversation_Tag1 of 1 parameter describedCreate a new conversation tag for the workspace.
Get_Conversation_Tag2 of 2 parameters describedGet a conversation tag by ID.
Update_Conversation_Tag2 of 2 parameters describedUpdate a conversation tag's title and/or description. Restricted to the tag owner or a workspace admin.
Delete_Conversation_Tag2 of 2 parameters describedDelete a conversation tag. Restricted to the tag owner or a workspace admin.
List_Agent_Conversation_Tickets15 of 15 parameters describedList an agent's issues, ordered by most recently created first unless sorted by priority. These are issues about the agent's own performance on a conversation (to work on with Architect), not tickets an agent opens for end users.
Create_Manual_Agent_Ticket2 of 2 parameters describedManually raise a follow-up issue against an agent, not tied to any conversation (for example a task like 'add the KB about X'). Without a title, one is derived from the comment. Requires viewer access to the agent.
List_Workspace_Conversation_Tickets14 of 14 parameters describedList agent issues across every agent in the workspace, ordered by most recently created first. Use this to build a workspace-wide view (for example, issues assigned to the caller). Supports the same filters, sorting and search as the per-agent endpoint. Issues for agents the caller cannot access are omitted.
Create_Agent_Conversation_Ticket1 of 1 parameter describedRaise an issue about an agent's performance on a conversation, to work on with Architect. Provide an overall comment and/or turn-level comments describing what went wrong.
Get_Agent_Conversation_Ticket_Assignable_Users2 of 2 parameters describedAll non-service-account workspace members, each flagged with whether they currently have at least viewer access to the agent. Members without access are included (not filtered out) so the UI can offer them as an assignee and prompt to grant access first.
Get_Agent_Conversation_Ticket2 of 2 parameters describedGet an agent issue by ID.
Update_Agent_Conversation_Ticket2 of 2 parameters describedUpdate an agent issue's title, comment, status, priority, and/or assignee. Requires viewer access to the issue's agent.
Delete_Agent_Conversation_Ticket2 of 2 parameters describedDelete an agent issue. Restricted to the issue creator or a workspace admin.
Add_Comment_To_Agent_Conversation_Ticket2 of 2 parameters describedAppend a comment discussing how to resolve the agent issue. Requires viewer access to the issue's agent.
Merge_Agent_Conversation_Tickets2 of 2 parameters describedMerge other open issues of the same agent into this pending, in-progress, or resolved one. Their conversations move onto this issue, its priority is raised to the highest among them, and they are kept with status 'merged'. Requires viewer access to the issue's agent.
Add_Turn_Comment_To_Agent_Conversation_Ticket2 of 2 parameters describedAppend a turn-level comment to an agent issue. Requires viewer access to the issue's agent.
Import_Phone_Number1 of 1 parameter describedImport Phone Number from provider configuration (Twilio, Exotel, or SIP trunk)
List_Phone_Numbers4 of 4 parameters describedRetrieve all Phone Numbers
Get_Phone_Number2 of 2 parameters describedRetrieve Phone Number details by ID
Delete_Phone_Number2 of 2 parameters describedDelete Phone Number by ID
Update_Phone_Number2 of 2 parameters describedUpdate assigned agent of a phone number
List_Phone_Numbers_Page12 of 12 parameters describedRetrieve a page of Phone Numbers
Get_Sip_Messages_For_A_Phone_Number4 of 4 parameters describedGet SIP messages for a phone number
Calculate_Expected_Llm_Usageno parametersReturns a list of LLM models and the expected cost for using them based on the provided values.
List_Available_Llms1 of 1 parameter describedReturns a list of available LLM models that can be used with agents, including their capabilities and any deprecation status. The response is filtered based on the data residency of the deployment and any compliance requirements (e.g. HIPAA) of the workspace subscription.
Upload_File2 of 2 parameters describedUpload an image, PDF, or text file for a conversation. Returns a unique file ID that can be used to reference the file in the conversation.
Get_Live_Count3 of 3 parameters describedGet the live count of the ongoing conversations.
Get_Knowledge_Base_Summaries_By_Ids2 of 2 parameters describedGets multiple knowledge base document summaries by their IDs.
Add_To_Knowledge_Base2 of 2 parameters describedUploads a file or reference a webpage to use as part of the shared knowledge base
Get_Knowledge_Base_List12 of 12 parameters describedGet a list of available knowledge base documents
Create_Url_Document1 of 1 parameter describedCreate a knowledge base document generated by scraping the given webpage.
Create_Crawl_Job1 of 1 parameter describedCreate a crawl job to crawl the given URL with specified depth and page limits.
List_Ongoing_And_Recent_Crawl_Jobs_Created_By_A_User4 of 4 parameters describedGet a list of ongoing and recent crawl jobs for the user.
Get_Crawl_Job_Details2 of 2 parameters describedGet details about a specific crawl job including status and progress.
Cancel_Crawl_Job2 of 2 parameters describedCancel a crawl job and delete all associated documents and folders.
Create_File_Document1 of 1 parameter describedCreate a knowledge base document generated form the uploaded file.
Create_Text_Document1 of 1 parameter describedCreate a knowledge base document containing the provided text.
Create_Folder1 of 1 parameter describedCreate a folder used for grouping documents together.
Update_Document2 of 2 parameters describedUpdate the name, content and/or auto-sync settings of a document.
Get_Documentation_From_Knowledge_Base3 of 3 parameters describedGet details about a specific documentation making up the agent's knowledge base
Delete_Knowledge_Base_Document_Or_Folder3 of 3 parameters describedDelete a document or folder from the knowledge base.
Get_Chunking_Override2 of 2 parameters describedGet the stored and effective RAG chunking overrides for a document or folder.
Update_Chunking_Override2 of 2 parameters describedSet or clear the RAG chunking override for a document or folder.
Update_File_Document2 of 2 parameters describedUpdate the source file of a file document. The document name, content, and metadata are updated to reflect the new file. Any manual content edits will be overwritten.
Compute_Rag_Indexes_In_Batch1 of 1 parameter describedRetrieves and/or creates RAG indexes for multiple knowledge base documents in a single request. Maximum 100 items per request.
Get_Rag_Index_Overview_1 of 1 parameter describedProvides total size and other information of RAG indexes used by knowledgebase documents
Refresh_Url_Document_Content2 of 2 parameters describedManually refresh a URL document by re-fetching its content from the source URL.
Compute_Rag_Index_2 of 2 parameters describedIn case the document is not RAG indexed, it triggers rag indexing task, otherwise it just returns the current status.
Get_Rag_Indexes_Of_The_Specified_Knowledgebase_Document_2 of 2 parameters describedProvides information about all RAG indexes of the specified knowledgebase document.
Delete_Rag_Index_3 of 3 parameters describedDelete RAG index for the knowledgebase document.
Search_Knowledge_Base_Content5 of 5 parameters describedFuzzy text search over knowledge base document content
Query_Agent_Knowledge_Base_Rag3 of 3 parameters describedRun one of the agent's exact knowledge base retrieval strategies for an ad-hoc request and return what the agent would retrieve: ranked chunks for semantic or keyword search, a document's content for cat, or the entries of a folder for ls. Read-only: no conversation is created. The response reflects current retrieval internals and may evolve.
Get_Dependent_Agents_List5 of 5 parameters describedGet a list of agents depending on this knowledge base document
Get_Dependent_Agents_For_Multiple_Documents4 of 4 parameters describedGet a list of agents depending on any of the given knowledge base documents.
Get_Document_Content2 of 2 parameters describedGet the entire content of a document from the knowledge base
Get_Document_Source_File_Url2 of 2 parameters describedGet a signed URL to download the original source file of a file-type document from the knowledge base
Get_Documentation_Chunk_From_Knowledge_Base4 of 4 parameters describedGet details about a specific documentation part used by RAG.
Get_All_Rag_Chunks_For_A_Document5 of 5 parameters describedGet all RAG chunks for a specific knowledge base document.
Move_Entity_To_Folder2 of 2 parameters describedMoves the entity from one folder to another.
Bulk_Move_Entities_To_Folder1 of 1 parameter describedMoves multiple entities from one folder to another.
Bulk_Delete_Knowledge_Base_Documents1 of 1 parameter describedDelete multiple documents or folders from the knowledge base. Each id succeeds or fails independently.
Get_Agent_Conversation_Topics9 of 9 parameters describedReturns the latest topic discovery run results for a given agent.
Add_Tool1 of 1 parameter describedAdd a new tool to the available tools in the workspace.
Get_Tools10 of 10 parameters describedGet all available tools in the workspace.
Get_Tool3 of 3 parameters describedGet tool that is available in the workspace.
Update_Tool2 of 2 parameters describedUpdate tool that is available in the workspace.
Delete_Tool3 of 3 parameters describedDelete tool from the workspace.
Get_Dependent_Agents_List4 of 4 parameters describedGet a list of agents depending on this tool
Get_Tool_Executions9 of 9 parameters describedGet paginated list of tool executions for a specific tool.
Create_Analysis_Item1 of 1 parameter describedCreate a new analysis item (evaluation criterion or data collection) in the workspace.
List_Analysis_Items8 of 8 parameters describedList analysis items available in the workspace.
Update_Analysis_Item_Attachments2 of 2 parameters describedAttach or detach one analysis item on multiple agent branches.
Get_Analysis_Item2 of 2 parameters describedGet an analysis item available in the workspace.
Update_Analysis_Item2 of 2 parameters describedUpdate an analysis item. Publishes a new version when the content changes.
Delete_Analysis_Item3 of 3 parameters describedDelete an analysis item and all of its versions from the workspace.
List_Analysis_Item_Versions4 of 4 parameters describedList the published versions of an analysis item, newest first.
Copy_Analysis_Item2 of 2 parameters describedCreate a new analysis item from this item's current definition.
Get_Analysis_Item_Dependent_Agents4 of 4 parameters describedGet a list of agents (and branches) that reference this analysis item.
Get_Convai_Settings1 of 1 parameter describedRetrieve Convai settings for the workspace
Update_Convai_Settings1 of 1 parameter describedUpdate Convai settings for the workspace
Get_Convai_Dashboard_Settings1 of 1 parameter describedRetrieve Convai dashboard settings for the workspace
Update_Convai_Dashboard_Settings1 of 1 parameter describedUpdate Convai dashboard settings for the workspace
Create_Convai_Workspace_Secret1 of 1 parameter describedCreate a new secret for the workspace
Get_Convai_Workspace_Secrets5 of 5 parameters describedGet all workspace secrets for the user
Get_Convai_Workspace_Secret2 of 2 parameters describedGet a workspace secret by ID
Delete_Convai_Workspace_Secret2 of 2 parameters describedDelete a workspace secret if it's not in use
Update_Convai_Workspace_Secret2 of 2 parameters describedUpdate an existing secret for the workspace
Get_Secret_Dependencies_By_Type5 of 5 parameters describedGet paginated list of resources that depend on a specific secret, filtered by resource type.
Submit_A_Batch_Call_Request_1 of 1 parameter describedSubmit a batch call request to schedule calls for multiple recipients.
Get_All_Batch_Calls_For_A_Workspace_4 of 4 parameters describedGet all batch calls for the current workspace.
Get_A_Batch_Call_By_Id_2 of 2 parameters describedGet detailed information about a batch call including all recipients.
Delete_A_Batch_Call_2 of 2 parameters describedPermanently delete a batch call and all recipient records. Conversations remain in history.
Cancel_A_Batch_Call_2 of 2 parameters describedCancel a running batch call and set all recipients to cancelled status.
Retry_A_Batch_Call_2 of 2 parameters describedRetry a batch call, calling failed and no-response recipients again.
Export_Batch_Call_Results3 of 3 parameters describedDownload all recipients and conversation results for a batch call as CSV, including calls that are still in progress.
Handle_An_Outbound_Call_Via_Sip_Trunk1 of 1 parameter describedHandle an outbound call via SIP trunk
Create_Mcp_Server1 of 1 parameter describedCreate a new MCP server configuration in the workspace.
List_Mcp_Servers1 of 1 parameter describedRetrieve all MCP server configurations available in the workspace.
Get_Mcp_Server2 of 2 parameters describedRetrieve a specific MCP server configuration from the workspace.
Delete_Mcp_Server2 of 2 parameters describedDelete a specific MCP server configuration from the workspace.
Update_Mcp_Server_Configuration2 of 2 parameters describedUpdate the configuration settings for an MCP server.
List_Mcp_Server_Tools3 of 3 parameters describedRetrieve all tools available for a specific MCP server configuration.
Update_Mcp_Server_Approval_Policy2 of 2 parameters describedUpdate the approval policy configuration for an MCP server. DEPRECATED: Use PATCH /mcp-servers/{id} endpoint instead.
Create_Mcp_Server_Tool_Approval2 of 2 parameters describedAdd approval for a specific MCP tool when using per-tool approval mode.
Delete_Mcp_Server_Tool_Approval3 of 3 parameters describedRemove approval for a specific MCP tool when using per-tool approval mode.
Create_Mcp_Tool_Configuration_Override3 of 3 parameters describedCreate configuration overrides for a specific MCP tool.
Get_Mcp_Tool_Configuration_Override3 of 3 parameters describedRetrieve configuration overrides for a specific MCP tool.
Update_Mcp_Tool_Configuration_Override4 of 4 parameters describedUpdate configuration overrides for a specific MCP tool.
Delete_Mcp_Tool_Configuration_Override3 of 3 parameters describedRemove configuration overrides for a specific MCP tool.
Get_Whatsapp_Account2 of 2 parameters describedGet a WhatsApp account
Update_Whatsapp_Account2 of 2 parameters describedUpdate a WhatsApp account
Delete_Whatsapp_Account2 of 2 parameters describedDelete a WhatsApp account
List_Whatsapp_Accounts2 of 2 parameters describedList all WhatsApp accounts
Create_A_New_Branch2 of 2 parameters describedCreate a new branch from a given version of any branch
List_Agent_Branches5 of 5 parameters describedReturns a list of branches an agent has
Get_Agent_Branch3 of 3 parameters describedGet information about a single agent branch
Update_Agent_Branch3 of 3 parameters describedUpdate agent branch properties such as name, description, archiving status, protection level, and auto-rebase onto main
Get_Agent_Version_Metadata3 of 3 parameters describedGet metadata for a specific agent version
Preview_Merged_Configuration6 of 6 parameters describedReturns the result of merging the source branch into the target branch without performing the merge. Useful for showing an accurate diff before confirming.
Merge_A_Branch_Into_A_Target_Branch4 of 4 parameters describedMerge a branch into a target branch
Preview_Rebased_Configuration5 of 5 parameters describedReturns the result of pulling changes from a source branch (defaults to main) into the given branch without performing it, preserving the given branch's own changes. Useful for showing an accurate diff before confirming.
Rebase_A_Branch_Onto_Main4 of 4 parameters describedPull changes from a source branch (defaults to main) into this branch as a new version, preserving this branch's own changes on conflicts.
Create_Or_Update_Deployments2 of 2 parameters describedCreate a new deployment for an agent
List_Agent_Deployments4 of 4 parameters describedList the traffic split history of an agent, newest first
Create_Agent_Draft3 of 3 parameters describedCreate a new draft for an agent
Delete_Agent_Draft3 of 3 parameters describedDelete a draft for an agent
Create_A_Merge_Proposal2 of 2 parameters describedRecord a request to merge a source branch into a target branch. Anyone with edit access can open one; merging it later is gated on write access to the target branch, so this is how a change reaches a protected branch the author cannot merge into themselves.
List_Proposals8 of 8 parameters describedList the proposals for an agent, newest first.
Get_A_Merge_Proposal3 of 3 parameters describedGet a single merge_proposal.
Update_A_Merge_Proposal3 of 3 parameters describedEdit an open merge_proposal's title or description, or close it. The author closing it is recorded as withdrawn; anyone else as rejected.
Review_A_Merge_Proposal3 of 3 parameters describedApprove a merge_proposal or request changes on it. A user's latest review replaces their previous one. Non-admins need an approval from another user before the merge is allowed.
Comment_On_A_Merge_Proposal3 of 3 parameters describedLeave a comment on a merge_proposal without recording a review verdict. Unlike reviews, comments accumulate and can still be added once the merge_proposal is merged or closed.
Merge_A_Merge_Proposal3 of 3 parameters describedExecute the merge. The caller must have write access to the target branch (admins only, for a protected branch), so this is where a reviewer approves and merges a request opened by someone who could not.
Get_Outbound_Campaign_Configuration1 of 1 parameter describedGet the workspace's outbound campaign configuration: the default policy new campaigns take, and per-agent overrides.
Replace_Outbound_Campaign_Configuration1 of 1 parameter describedCreate or replace the workspace's outbound campaign configuration. Send the `version` you last read as `expected_version`, or omit it to create the first configuration. A configuration changed since you read it is not replaced. Campaigns keep the policy they started with.
List_Outbound_Campaigns8 of 8 parameters describedList the workspace's outbound campaigns, newest first.
Pause_All_Outbound_Campaigns1 of 1 parameter describedPause every running outbound campaign in the workspace. Paused campaigns place no new calls until resumed.
Stop_All_Outbound_Campaigns1 of 1 parameter describedStop every outbound campaign in the workspace that hasn't finished. Returns `202` while calls already placed are still finishing.
Create_An_Outbound_Campaign1 of 1 parameter describedCreate an outbound campaign that calls or messages each recipient with the agent, within the policy's calling windows, retrying and following up as it allows. Returns `201` for a new campaign. A repeated request, matched by `idempotency_key` or else by its body, returns the existing campaign with `created` false.
Get_An_Outbound_Campaign2 of 2 parameters describedGet an outbound campaign and its lead counts.
Get_Outbound_Campaign_Progress2 of 2 parameters describedGet where an outbound campaign's leads and calls stand, and when its next call is due.
List_Outbound_Campaign_Leads7 of 7 parameters describedList the leads of an outbound campaign, one per recipient.
List_Outbound_Campaign_Calls8 of 8 parameters describedList the calls of an outbound campaign, newest first: first contacts, retries, callbacks and redirects, whether queued, under way or done.
Get_Outbound_Campaign_Follow-Up_Requests2 of 2 parameters describedCount the callbacks and redirects contacts asked for during an outbound campaign's calls.
Export_Outbound_Campaign_Calls3 of 3 parameters describedDownload every call of a campaign, with its lead and conversation results, as CSV.
Get_An_Outbound_Campaign_Lead3 of 3 parameters describedGet one lead of an outbound campaign.
Remove_An_Outbound_Campaign_Lead3 of 3 parameters describedRemove a lead from an outbound campaign so it is never called again. Returns `202` when a call already placed may still go through.
Pause_An_Outbound_Campaign2 of 2 parameters describedPause an outbound campaign. It places no new calls until resumed; calls already placed carry on.
Resume_An_Outbound_Campaign2 of 2 parameters describedResume a paused outbound campaign, including calls an attention item held back.
Stop_An_Outbound_Campaign2 of 2 parameters describedStop an outbound campaign for good: queued calls are cancelled and no lead is called again. Returns `202` with the campaign `stopping` while calls already placed are still finishing.
List_Outbound_Campaign_Attention_Items5 of 5 parameters describedList problems in the workspace's outbound campaigns that need you to act, such as an agent or phone number that can no longer be used, newest first. A campaign with an open item holds back the calls it affects.
Retry_An_Outbound_Campaign_Attention_Item2 of 2 parameters describedPlace the calls a retryable attention item holds back, once its cause is fixed. Resumes the campaign.
Resolve_An_Outbound_Campaign_Attention_Item2 of 2 parameters describedClose an attention item that can't be retried, recording how it was handled.
List_Speech_Engines6 of 6 parameters describedReturns a paginated list of Speech Engine resources.
Create_Speech_Engine1 of 1 parameter describedCreate a new Speech Engine resource
Get_Speech_Engine2 of 2 parameters describedRetrieve a Speech Engine resource
Update_Speech_Engine2 of 2 parameters describedUpdate a Speech Engine resource (partial update)
Delete_Speech_Engine2 of 2 parameters describedDelete a Speech Engine resource
Duplicate_Speech_Engine2 of 2 parameters describedCreate a new Speech Engine resource by duplicating an existing one
Send_Conversation_Message2 of 2 parameters describedSend input to a conversation, and wait until the agent finishes or waits on client tool results. With `background` set to true, the endpoint returns 202 when the server admits the turn. Then stream the turn's events with `Last-Event-ID` set to the `stream_cursor`. This endpoint is in alpha and may change.
Send_Conversation_Message_Stream2 of 2 parameters describedSend input to a conversation, and stream the events of the request as server-sent events. The last event is `stream_ended`, which has the outcome of the turn. This endpoint is in alpha and may change.
Get_Conversation_Turn3 of 3 parameters describedGet the status and output of a turn. The status comes from the stored transcript, so a turn that failed after the agent started can show as completed. Only the `stream_ended` event has the real outcome. This endpoint is in alpha and may change.
Stream_Conversation_Turn_Events4 of 4 parameters describedStream the events of a turn as server-sent events. Send `Last-Event-ID` to resume after an event. The server keeps events for about an hour. This endpoint is in alpha and may change.
Create_Procedure3 of 3 parameters describedCreate a new procedure for the agent on a branch.
List_Procedures4 of 4 parameters describedList the procedures attached to this agent branch. By default, unpublished drafts take precedence over the latest committed version. Pass agent_version_id to list a published snapshot instead. has_draft is true when a procedure has unpublished draft changes on this branch. Procedure content is not included; use Get Procedure to read a procedure's body.
Legacy_Compile_Procedures3 of 3 parameters describedLegacy. Do not use. Saving an agent draft (`POST /v1/convai/agents/{agent_id}/drafts`) and publishing an agent (`PATCH /v1/convai/agents/{agent_id}`) compile structured procedures into workflow nodes and edges, save the compiled workflow with the draft or version, and return validation errors, so a separate compile call is no longer needed. This endpoint remains available for the time being so existing callers do not break, as a dry-run that compiles the current procedure drafts into a workflow without persisting anything. It will eventually be deprecated.
Remove_Procedure4 of 4 parameters describedRemove a procedure from the agent's draft working set. Removing a folder cascades to its entire subtree, rejected if any procedure outside the subtree hands off into it.
Get_Procedure6 of 6 parameters describedRetrieve a procedure at a specific version or the current branch HEAD.
Get_Procedure_Draft4 of 4 parameters describedGet user's draft for a procedure
Update_Procedure_Draft4 of 4 parameters describedCreate or update user's draft for a procedure
Delete_Procedure_Draft4 of 4 parameters describedDelete user's draft for a procedure, resetting to the committed version
Run_Conversation_Analysis2 of 2 parameters describedRun the analysis for a conversation using the agent's current evaluation criteria and data collection settings.
Run_Conversation_Evaluation2 of 2 parameters describedRerun a specific evaluation for a conversation.
List_Environment_Variables6 of 6 parameters describedList all environment variables for the workspace with optional filtering
Create_Environment_Variable1 of 1 parameter describedCreate a new environment variable for the workspace
Get_Environment_Variable2 of 2 parameters describedGet a specific environment variable by ID
Update_Environment_Variable2 of 2 parameters describedReplace an environment variable's values. Use null to remove its value for an environment (except production); delete an environment with DELETE /v1/convai/environments/{environment}.
Delete_Environment_Variable2 of 2 parameters describedDelete an environment variable and its values in all environments. The delete is rejected while the latest version of an unarchived agent branch, a tool, an MCP server or the workspace conversation initiation webhook uses the variable. Archived branches and earlier versions are not checked.
List_Environments1 of 1 parameter describedList the workspace environments, including 'production'.
Create_Environment1 of 1 parameter describedCreate a workspace environment. Variables without a value for it fall back to their production value.
Delete_Environment2 of 2 parameters describedDelete a workspace environment and remove its values from all environment variables. 'production' cannot be deleted.
List_Realtime_Conversation_Groups4 of 4 parameters describedList the realtime conversation groups the current user can view.
Create_Realtime_Conversation_Group1 of 1 parameter describedCreate a realtime conversation group owned by the current user.
Get_Realtime_Conversation_Group2 of 2 parameters describedGet a realtime conversation group by id.
Update_Realtime_Conversation_Group2 of 2 parameters describedRename or re-describe a realtime conversation group.
Delete_Realtime_Conversation_Group2 of 2 parameters describedDelete a realtime conversation group. Every conversation in it becomes ungrouped, so access granted through the group is revoked.
Set_Realtime_Conversation_Group2 of 2 parameters describedPlace a realtime conversation in a conversation group, moving it out of its current group if it has one.
Clear_Realtime_Conversation_Group2 of 2 parameters describedRemove a realtime conversation from its conversation group.
Create_Realtime_Client_Secret1 of 1 parameter describedCreate an ephemeral client secret for authenticating browser-based Realtime API sessions.
Generate_Composition_Plan2 of 2 parameters describedGenerate a composition plan from a prompt.
Compose_Music3 of 3 parameters describedCompose a song from a prompt or a composition plan.
Compose_Music_With_A_Detailed_Response3 of 3 parameters describedCompose a song from a prompt or a composition plan.
Stream_Composed_Music_With_A_Detailed_Response3 of 3 parameters describedStream a song and its detailed metadata using Server-Sent Events (SSE).
Stream_Composed_Music3 of 3 parameters describedStream a composed song from a prompt or a composition plan.
Upload_Music1 of 1 parameter describedUpload a music file to be later used for inpainting. Price for uploading is the same as the one for song generation. All uploaded content gets inspected for copyright infringement. If copyrighted content is detected, half of the request cost is still charged.
Stem_Separation3 of 3 parameters describedSeparate an audio file into individual stems. This endpoint might have high latency, depending on the length of the audio file.
Get_Music_Finetunes7 of 7 parameters describedList music finetunes accessible to you (your own, workspace-shared, and ElevenLabs-curated), with optional filtering, sorting, and cursor pagination.
Create_Music_Finetune1 of 1 parameter describedCreate a new music finetune
Get_Music_Finetune2 of 2 parameters describedGet a music finetune.
Update_Music_Finetune2 of 2 parameters describedUpdate a music finetune.
Delete_Music_Finetune2 of 2 parameters describedDelete a music finetune
Create_Order1 of 1 parameter describedCreates a new Productions order in the workspace. The order starts in the open state and can be configured with items before submission.
List_Orders6 of 6 parameters describedLists Productions orders in the workspace. Supports filtering by status and date range, with pagination.
Get_Order2 of 2 parameters describedRetrieves full details for a Productions order. Quote and pricing information may not be available immediately; if you wish to see the quote before submission, you may need to poll the order details until it is ready.
Update_Order2 of 2 parameters describedUpdates an open order.
Register_Media2 of 2 parameters describedRegisters a media file with an order, either by uploading it directly or by providing a URL to fetch it from. Exactly one of `media` or `media_url` must be provided. The registered media can then be referenced when adding order items.
Get_Media_Info3 of 3 parameters describedRetrieves metadata and a time-limited download URL for a previously uploaded media file.
Upsert_Order_Item2 of 2 parameters describedAdds or updates an order item on an open order. Returns the item ID and the quoted price.
Remove_Order_Item3 of 3 parameters describedRemoves an order item from an open order.
Submit_Order2 of 2 parameters describedSubmits an open order for processing. The order must have at least one item. Once submitted, items can no longer be modified. Upon submission, the workspace will be charged for the order. The quote is based on information extracted from the uploaded media, such as its duration. The quote may not be available immediately; if you wish to see the quote before submission, you may need to poll the order details until the quote is ready.
Get_Order_Deliverables2 of 2 parameters describedRetrieves the delivered files for a completed order. Returns an empty list if the order is not yet completed.
Get_Available_Languages2 of 2 parameters describedReturns the available languages for a given order item kind.
Create_Pvc_Voice1 of 1 parameter describedCreates a new PVC voice with metadata but no samples
Edit_Pvc_Voice2 of 2 parameters describedEdit PVC voice metadata
Add_Samples_To_Pvc_Voice2 of 2 parameters describedAdd audio samples to a PVC voice
Update_Pvc_Voice_Sample3 of 3 parameters describedUpdate a PVC voice sample - apply noise removal, select speaker, change trim times or file name.
Delete_Pvc_Voice_Sample3 of 3 parameters describedDelete a sample from a PVC voice.
Retrieve_Voice_Sample_Audio4 of 4 parameters describedRetrieve the first 30 seconds of voice sample audio with or without noise removal.
Retrieve_Voice_Sample_Visual_Waveform3 of 3 parameters describedRetrieve the visual waveform of a voice sample.
Retrieve_Speaker_Separation_Status3 of 3 parameters describedRetrieve the status of the speaker separation process and the list of detected speakers if complete.
Start_Speaker_Separation3 of 3 parameters describedStart speaker separation process for a sample
Retrieve_Separated_Speaker_Audio4 of 4 parameters describedRetrieve the separated audio for a specific speaker.
Get_Pvc_Voice_Captcha2 of 2 parameters describedGet captcha for PVC voice verification.
Verify_Pvc_Voice_Captcha2 of 2 parameters describedSubmit captcha verification for PVC voice.
Run_Pvc_Training2 of 2 parameters describedStart PVC training process for a voice.
Request_Manual_Verification2 of 2 parameters describedRequest manual verification for a PVC voice.
Create_Video_Generation1 of 1 parameter describedStart a video generation with the selected model.
List_Video_Generations5 of 5 parameters describedList the video generations created through this API, newest first.
Get_Video_Generation2 of 2 parameters describedRetrieve the status of a video generation, and retrieve its output URL once completed.
Create_Image_Generation1 of 1 parameter describedStart an image generation with the selected model.
List_Image_Generations5 of 5 parameters describedList the image generations created through this API, newest first.
Get_Image_Generation2 of 2 parameters describedRetrieve the status of an image generation, and retrieve its output URL once completed.
Create_Speech_Generation1 of 1 parameter describedStart a speech generation with the selected model. Charged per character via text-to-speech billing. Use this over `/v1/text-to-speech` for the asynchronous generation lifecycle or for models not offered there; for direct, synchronous speech synthesis, prefer `/v1/text-to-speech`.
List_Speech_Generations5 of 5 parameters describedList the speech generations created through this API, newest first.
Get_Speech_Generation2 of 2 parameters describedRetrieve the status of a speech generation, and retrieve its output URL once completed.
Create_Template_Run2 of 2 parameters describedStart a run of a flows template. Pass `version_id` to pin a snapshot, or omit it / pass `latest` to run the latest published version. Set input values under `inputs`, keyed by input port id. The response is the run in its initial state, with every output already listed under its port id in `outputs`. Include `webhook` to receive a `flows_template_run` event carrying the finished run once its `status` is `completed` or `failed`; this is the recommended way to wait. Without one, fetch `GET /v1/flows/templates/{template_id}/runs/{run_id}` at a modest interval until the `status` is terminal.
List_Template_Runs5 of 5 parameters describedList this template's runs created through this API, newest first.
Get_Template_Run3 of 3 parameters describedRetrieve a template run: its `status`, rolled up from its outputs, and each output's own status and download URL once completed.
List_Templates5 of 5 parameters describedList the published flows templates in your workspace, together with each runnable version's inputs and outputs. Use the ids here as `template_id` / `version_id` on `POST /v1/flows/templates/{template_id}/runs`. Versions built on models that are not available to you through the API are left out, so `versions` is empty when none of a template's published versions is runnable through this API. Templates shared with you by link, or published to Explore from another workspace, are not listed but can still be fetched and run by `template_id`.
Get_Template3 of 3 parameters describedRetrieve one flows template, together with each runnable version's inputs and outputs. `versions` is empty when no published version is runnable through this API. Works for any template you can open, including templates shared with you by link or published to Explore from another workspace, which `GET /v1/flows/templates` does not list.
Upload_Asset1 of 1 parameter describedUpload a new asset.
List_Assets4 of 4 parameters describedList assets in the workspace, most recently created first.
Get_Asset2 of 2 parameters describedRetrieve a single asset by ID.
Delete_Asset2 of 2 parameters describedDelete an asset by ID.
Get_Workspace_Usage1 of 1 parameter describedReturns credit usage broken down by product type over time, for workspaces billed in credits. The response is a tabular structure with columns, column_types, column_units, and rows. Some id columns also get a display-name column, such as user_label or voice_name, appended after the existing columns. For workspaces billed by cost, ranges that reach the date the workspace moved to cost billing return an error; use /v1/workspace/analytics/usage instead.
Get_Workspace_Cost_Usage1 of 1 parameter describedReturns the cost of the workspace's usage over time, for workspaces billed by cost. Usage is bucketed by UTC day. The response is a tabular structure with columns, column_types, column_units, and rows, with one row per group and bucket. `total_cost` is the cost in the workspace's currency and `total_charge_count` the billed quantity. Usage can be grouped or filtered by at most two of `user_id`, `hashed_xi_api_key`, `region`, `reporting_workspace_id`, `billing_group_id`, `product_type`, `surface` and `actor`, and grouping by two of them requires an `eq` or `in` filter on one. `model`, `request_source`, `fiat_charge_type` and `fiat_currency` can always be added. Some id columns also get a display-name column, such as user_label, appended after the existing columns. Workspaces billed in credits should use /v1/workspace/analytics/query/usage-by-product-over-time.
List_Api_Requests1 of 1 parameter describedReturns a list of API requests. Supports filtering by time range, column filters, and search terms. At least one of start_time or end_time must be provided. An optional sort parameter controls timestamp ordering. Results are ordered by timestamp. Descending if end_time is used, ascending if start_time is used. The response is a tabular structure with columns, column_types, column_units, and rows.
Send_Test_Webhook_Event2 of 2 parameters describedSends a sample event of the given type to the webhook once and returns the endpoint's status code, response time, content type and response size. Test events are signed like real ones, are never retried, and share a limit of 10 per webhook per minute with redeliveries.
Redeliver_Webhook_Delivery3 of 3 parameters describedSends a stored delivery again, once, with the same delivery ID, a new signature and an ElevenLabs-Webhook-Redelivery header. A retry that is already scheduled is still sent. Only workspace admins on a web session can redeliver, and only deliveries whose payload is stored. Redeliveries and test events share a limit of 10 per webhook per minute.
Get_All_Services6 of 6 parameters describedGet all services for the current workspace with optional filters
Create_Service2 of 2 parameters describedCreate a new service
Get_Service3 of 3 parameters describedGet a specific service by ID
Update_Service3 of 3 parameters describedUpdate an existing service. Only the fields sent are changed.
Delete_Service3 of 3 parameters describedDelete a service
Confirm_Service_Update4 of 4 parameters describedSave a service update that changes the price of existing bookings. Optionally reprice future bookings.
Get_All_Assets2 of 2 parameters describedList the workspace's bookable assets, such as rooms or equipment.
Create_Asset2 of 2 parameters describedCreate a bookable asset, such as a room or a piece of equipment.
Get_Asset3 of 3 parameters describedGet an asset by ID.
Update_Asset3 of 3 parameters describedUpdate an asset. Only the fields sent are changed.
Delete_Asset3 of 3 parameters describedDelete an asset.
Get_All_Products4 of 4 parameters describedList the workspace's products, optionally filtered by group or active state.
Create_Product2 of 2 parameters describedCreate a product the receptionist can quote and take orders for. A product created with `track_quantity` starts with nothing on hand; add stock with the stock endpoints.
Get_Product3 of 3 parameters describedGet a product by ID.
Update_Product3 of 3 parameters describedUpdate a product's catalog fields. Only the fields sent are changed. On-hand quantities are not part of this call; use the stock endpoints.
Delete_Product3 of 3 parameters describedDelete a product.
Update_Product_Stock3 of 3 parameters describedSet the on-hand quantity of a counted product at one location. Rejected with a 409 if it changed since `expected_on_hand` was read.
Adjust_Product_Stock3 of 3 parameters describedAdd to or subtract from the on-hand quantity of a counted product at one location, without overwriting orders taken at the same time.
Get_All_Staff2 of 2 parameters describedGet all staff for the current workspace
Create_Staff_Member2 of 2 parameters describedCreate a new staff member
Get_Staff_Member3 of 3 parameters describedGet a specific staff member by ID
Update_Staff_Member3 of 3 parameters describedUpdate an existing staff member. Only the fields sent are changed.
Delete_Staff_Member3 of 3 parameters describedDelete a staff member
List_Receptionists2 of 2 parameters describedList every customer-facing receptionist for the workspace.
Update_Receptionist3 of 3 parameters describedUpdate a receptionist's display name, config and/or widget appearance.
Activate_Receptionist3 of 3 parameters describedRe-activate a deactivated receptionist. Fails with `quota_exceeded` when the plan has no free receptionist slot.
Add_Rule3 of 3 parameters describedAdd a behavioral rule to the named receptionist.
Update_Rule4 of 4 parameters describedReplace an existing rule on the named receptionist. Send every field: an omitted `priority` resets to `strict`.
Delete_Rule4 of 4 parameters describedDelete a rule from the named receptionist.
List_Procedures3 of 3 parameters describedList the procedures (SOPs) on the named receptionist, with the tools each one is missing.
Add_Procedure3 of 3 parameters describedAdd a procedure (SOP) to the named receptionist.
Update_Procedure4 of 4 parameters describedReplace an existing procedure on the named receptionist. Send every field: an omitted `body` resets to empty.
Delete_Procedure4 of 4 parameters describedDelete a procedure from the named receptionist.
Add_Transfer_Rule3 of 3 parameters describedAdd a phone forwarding rule to the named receptionist.
Update_Transfer_Rule4 of 4 parameters describedReplace an existing transfer rule on the named receptionist. Send every field: an omitted `post_dial_digits` clears it.
Delete_Transfer_Rule4 of 4 parameters describedDelete a transfer rule from the named receptionist.
List_Phone_Numbers2 of 2 parameters describedList the workspace's phone numbers and the receptionist each one rings. A number with no `customer_facing_agent_id` is held by the workspace but not attached to a receptionist yet.
Assign_Phone_Number2 of 2 parameters describedGive a receptionist a phone number. A number the workspace already holds but has not attached is used first. Otherwise, in the US and Canada, a number with one of the requested `area_codes` is taken from the pool or bought, falling back to any number in the business's country. In countries that require paperwork, the number is issued right away but takes public calls only once the workspace's own registration is approved (see `accepts_public_calls`). Counts toward the plan's phone number limit, and free plans can take only a few new numbers a day. Returns 404 when no number is available and 403 `telephony_managed_by_reseller` when the reseller supplies the workspace's numbers from its own Twilio account or SIP trunk and none is free.
Release_Phone_Number3 of 3 parameters describedRemove a phone number from the workspace. A pool number goes back to the pool it came from. A number the business brought from its own Twilio account, or one issued in a country that requires paperwork, is released at Twilio and cannot be recovered. Returns 403 `telephony_managed_by_reseller` when the reseller supplies the workspace's numbers from its own Twilio account or SIP trunk.
Move_Phone_Number3 of 3 parameters describedMove a phone number to a different receptionist in the same workspace, which answers its calls from then on. Returns 409 `phone_number_not_attached` for a number no receptionist answers yet (attach it with `POST /v1/reception/phone-numbers/assignments`).
Get_All_Holidays7 of 7 parameters describedGet all holidays/time-off entries for the current workspace with optional filters
Create_Holiday2 of 2 parameters describedCreate a new holiday
Get_Holiday3 of 3 parameters describedGet a specific holiday by ID
Update_Holiday3 of 3 parameters describedUpdate an existing holiday. Only the fields sent are changed.
Delete_Holiday3 of 3 parameters describedDelete a holiday
List_Locations2 of 2 parameters describedList all business locations.
Create_Location2 of 2 parameters describedAdd a new business location.
Get_Location3 of 3 parameters describedGet a single location by ID.
Update_Location3 of 3 parameters describedUpdate an existing location. Only the fields sent are changed.
Delete_Location3 of 3 parameters describedDelete a location.
Get_Business_Profile2 of 2 parameters describedGet the business profile the receptionists answer from, with the current time in the business's timezone.
Update_Business_Profile2 of 2 parameters describedUpdate the business profile. Every receptionist is updated to match.
List_Knowledge_Sources2 of 2 parameters describedList all knowledge sources for the current workspace
Upload_Knowledge_Source2 of 2 parameters describedUpload a file as a knowledge source
Get_Knowledge_Source3 of 3 parameters describedGet a specific knowledge source by ID
Delete_Knowledge_Source3 of 3 parameters describedDelete a knowledge source
Add_Url_Source2 of 2 parameters describedAdd a URL as a knowledge source
List_Reseller_Workspaces3 of 3 parameters describedList workspaces attributed to the caller's reseller, with cursor-based pagination
Create_Reseller_Workspace1 of 1 parameter describedCreate a workspace for one of your customers, optionally with a tier, a phone number and team invites.
Complete_Reseller_Workspace_Onboarding2 of 2 parameters describedFinish setting up the workspace: create its receptionist and assistant from the business profile, reusing a receptionist from a setup already started, and connect your phone number, if you supply one. Safe to retry.
Assign_Reseller_Tier2 of 2 parameters describedSubscribe a reseller-attributed workspace to one of the reseller's tiers
Change_Reseller_Tier2 of 2 parameters describedMove a reseller-attributed workspace between the reseller's tiers. Upgrades apply immediately; downgrades and lateral moves take effect at the end of the billing period.
Unassign_Reseller_Tier2 of 2 parameters describedEnd a reseller-attributed workspace's subscription at the end of the current billing period
Restore_Reseller_Subscription2 of 2 parameters describedUndo a pending unassignment so the subscription renews normally
Cancel_Reseller_Pending_Downgrade2 of 2 parameters describedDrop a scheduled downgrade, leaving the workspace on its current tier
List_Reseller_Tiers1 of 1 parameter describedThe tiers you can sell, cheapest first. The first is the trial. Retired tiers are left out.
List_Reseller_Invoices3 of 3 parameters describedList the invoices charged to the reseller's card, newest first, one per workspace invoice
Get_Reseller_Invoice2 of 2 parameters describedGet one invoice charged to the reseller's card, broken down into the workspace invoice's lines
List_Reseller_Upcoming_Payments1 of 1 parameter describedList the next workspace renewals the reseller's card will be charged for, soonest first
Get_Team_Members2 of 2 parameters describedList the workspace's members, suspended members last.
Get_Pending_Team_Invites2 of 2 parameters describedList the workspace's pending invites.
Invite_Team_Member2 of 2 parameters describedEmail an invite to join the workspace. A pending invite takes a seat, so this is refused once members and invites reach the plan's team limit.
Cancel_Team_Invite2 of 2 parameters describedCancel a pending invite, freeing its seat.
Update_Team_Member_Role3 of 3 parameters describedPromote a member to admin or demote an admin to member.
Remove_Team_Member3 of 3 parameters describedRemove a member from the workspace. Their seat goes to a suspended member, if any.
Redirect_To_Mintlifyno parametersMake a GET request to /docs
Tested in a sandbox with an empty environment: no API keys, a throwaway folder, nothing from a real account. A passing test shows the server runs and responds. It is not a security audit.