Skip to content
Changelog

Report a bug

ElevenLabs integration: operations for AI agents

ElevenLabs connects to Type.com as an integration. This page lists the 458 operations documented for Claude and Codex in Type.com: 186 read, 185 write, 87 destructive.

About ElevenLabs

ElevenLabs API reference operations, subject to Type setup and account permissions.

Categories: Design & Media

How to connect ElevenLabs to Type.com

Connect
Configure xi-api-key in the Type custom header. Grant the account permissions required by the operations you use.
Access
Organization connection: one shared account for the workspace.
MCP
This integration is not available through Type’s MCP server. It remains available in Type.

To add the connection, follow the steps in Space connections.

Documented operations

458 operations. Your connection's permissions determine which operations are available. API references describe the vendor surface; they do not expand your connection's credentials or access.

458 operations listed.

Speech history

  • Read

    List Generated Items

    Returns 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 /v1/history

  • Read

    Get History Item

    Retrieves a history item.

    GET /v1/history/{history_item_id}

  • Read

    Get Audio From History Item

    Returns the audio of an history item.

    GET /v1/history/{history_item_id}/audio

  • Read

    Download History Items

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

    POST /v1/history/download

  • Destructive

    Delete History Item

    Delete a history item by its ID

    DELETE /v1/history/{history_item_id}

Sound generation

  • Write

    Sound Generation

    Turn text into sound effects for your videos, voice-overs or video games using the most advanced sound effects models in the world.

    POST /v1/sound-generation

Audio isolation

  • Read

    Get Audio Isolation History

    Returns a list of all your audio isolation generations.

    GET /v1/audio-isolation/history

  • Write

    Audio Isolation

    Removes background noise from audio

    POST /v1/audio-isolation

  • Write

    Audio Isolation Stream

    Removes background noise from audio and streams the result

    POST /v1/audio-isolation/stream

  • Destructive

    Delete Audio Isolation History Item

    Deletes a specific audio isolation history item and the associated media files.

    DELETE /v1/audio-isolation/history/{history_item_id}

Audio effects

  • Read

    Get Audio Effects Catalog

    Lists the filter presets, reverb environments, and background noises that `audio_effects` can reference in Text to Speech, Text to Dialogue, and agent configurations.

    GET /v1/audio-effects/catalog

Samples

  • Read

    Get Audio From Sample

    Returns the audio corresponding to a sample attached to a voice.

    GET /v1/voices/{voice_id}/samples/{sample_id}/audio

  • Destructive

    Delete Sample

    Removes a sample by its ID.

    DELETE /v1/voices/{voice_id}/samples/{sample_id}

Text to speech

  • Write

    Text To Speech

    Converts text into speech using a voice of your choice and returns audio.

    POST /v1/text-to-speech/{voice_id}

  • Write

    Text To Speech With Timestamps

    Generate speech from text with precise character-level timing information for audio-text synchronization.

    POST /v1/text-to-speech/{voice_id}/with-timestamps

  • Write

    Text To Speech Streaming

    Converts text into speech using a voice of your choice and returns audio as an audio stream.

    POST /v1/text-to-speech/{voice_id}/stream

  • Write

    Text To Speech Streaming With Timestamps

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

    POST /v1/text-to-speech/{voice_id}/stream/with-timestamps

Text to dialogue

  • Write

    Text To Dialogue (Multi-Voice)

    Converts a list of text and voice ID pairs into speech (dialogue) and returns audio.

    POST /v1/text-to-dialogue

  • Write

    Text To Dialogue (Multi-Voice) Streaming

    Converts a list of text and voice ID pairs into speech (dialogue) and returns an audio stream.

    POST /v1/text-to-dialogue/stream

  • Write

    Text To Dialogue Streaming With Timestamps

    Converts 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

    POST /v1/text-to-dialogue/stream/with-timestamps

  • Write

    Text To Dialogue With Timestamps

    Generate dialogue from text with precise character-level timing information for audio-text synchronization.

    POST /v1/text-to-dialogue/with-timestamps

Voice changer

  • Write

    Voice Changer

    Transform audio from one voice to another. Maintain full control over emotion, timing and delivery.

    POST /v1/voice-changer/{voice_id}

  • Write

    Voice Changer Streaming

    Stream audio from one voice to another. Maintain full control over emotion, timing and delivery.

    POST /v1/voice-changer/{voice_id}/stream

Text to voice

  • Read

    Text To Voice Preview Streaming

    Stream a voice preview that was created via the /v1/text-to-voice/design endpoint.

    GET /v1/text-to-voice/{generated_voice_id}/stream

  • Write

    Create A New Voice From Voice Preview

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

    POST /v1/text-to-voice

  • Write

    Design A Voice.

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

    POST /v1/text-to-voice/design

  • Write

    Remix A Voice.

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

    POST /v1/text-to-voice/{voice_id}/remix

User

  • Read

    Get User Info

    Gets information about the user

    GET /v1/user

  • Read

    Get User Subscription Info

    Gets extended information about the users subscription

    GET /v1/user/subscription

Voices

  • Read

    List Voice Collections

    Returns all the voice collections the user has access to, sorted by title.

    GET /v1/voices/collections

  • Read

    Get Voice Collection

    Returns a voice collection the user has access to.

    GET /v1/voices/collections/{collection_id}

  • Read

    Get Default Voice Settings.

    Gets 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 /v1/voices/settings/default

  • Read

    Get Voice Settings

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

    GET /v1/voices/{voice_id}/settings

  • Read

    Get Voice Accents

    Gets the list of available accents in the shared voice library.

    GET /v1/voices/accents

  • Read

    List Voices

    Returns a list of all available voices for a user. Stops working once the user's workspace exceeds 500 voices.

    GET /v1/voices

  • Read

    Get Voice

    Returns metadata about a specific voice.

    GET /v1/voices/{voice_id}

  • Read

    Get Voices V2

    Gets a list of all available voices for a user with search, filtering and pagination.

    GET /v2/voices

  • Read

    Get Similar Library Voices

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

    POST /v1/similar-voices

  • Read

    Get Voices

    Retrieves a list of shared voices.

    GET /v1/shared-voices

  • Write

    Create Voice Collection

    Creates a new voice collection. The caller becomes its admin.

    POST /v1/voices/collections

  • Write

    Update Voice Collection

    Updates the title and icon of a voice collection. Fields that are omitted are left unchanged. Requires editor access to the collection.

    PATCH /v1/voices/collections/{collection_id}

  • Write

    Add Voice To Collection

    Adds a voice to a voice collection. Adding a voice that is already in the collection succeeds without changes. Requires editor access to the collection.

    POST /v1/voices/collections/{collection_id}/voice/{voice_id}

  • Write

    Edit Voice Settings

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

    POST /v1/voices/{voice_id}/settings/edit

  • Write

    Edit Voice

    Edit a voice created by you.

    POST /v1/voices/{voice_id}/edit

  • Write

    Replicate Voice To Isolated Environment

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

    POST /v1/voices/{voice_id}/replicate-to-isolated-environment

  • Write

    Add Voice

    Add a new voice to your collection of voices in VoiceLab.

    POST /v1/voices/add

  • Write

    Add Shared Voice

    Add a shared voice to your collection of voices.

    POST /v1/voices/add/{public_user_id}/{voice_id}

  • Destructive

    Delete Voice Collection

    Deletes a voice collection. The voices in it are not deleted. Requires admin access to the collection.

    DELETE /v1/voices/collections/{collection_id}

  • Destructive

    Remove Voice From Collection

    Removes a voice from a voice collection. The voice itself is not deleted. Requires editor access to the collection.

    DELETE /v1/voices/collections/{collection_id}/voice/{voice_id}

  • Destructive

    Delete Voice

    Deletes a voice by its ID.

    DELETE /v1/voices/{voice_id}

Studio

  • Read

    List Studio Projects

    Returns a list of your Studio projects with metadata.

    GET /v1/studio/projects

  • Read

    Get Studio Project

    Returns information about a specific Studio project. This endpoint returns more detailed information about a project than `GET /v1/studio`.

    GET /v1/studio/projects/{project_id}

  • Read

    List Studio Project Snapshots

    Retrieves a list of snapshots for a Studio project.

    GET /v1/studio/projects/{project_id}/snapshots

  • Read

    Get Project Snapshot

    Returns the project snapshot.

    GET /v1/studio/projects/{project_id}/snapshots/{project_snapshot_id}

  • Read

    Stream Archive With Studio Project Audio

    Returns a compressed archive of the Studio project's audio.

    POST /v1/studio/projects/{project_id}/snapshots/{project_snapshot_id}/archive

  • Read

    List Chapters

    Returns a list of a Studio project's chapters.

    GET /v1/studio/projects/{project_id}/chapters

  • Read

    Get Chapter

    Returns information about a specific chapter.

    GET /v1/studio/projects/{project_id}/chapters/{chapter_id}

  • Read

    List Chapter Snapshots

    Gets 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 /v1/studio/projects/{project_id}/chapters/{chapter_id}/snapshots

  • Read

    Get Chapter Snapshot

    Returns the chapter snapshot.

    GET /v1/studio/projects/{project_id}/chapters/{chapter_id}/snapshots/{chapter_snapshot_id}

  • Read

    Get Project Muted Tracks

    Returns a list of chapter IDs that have muted tracks in a project.

    GET /v1/studio/projects/{project_id}/muted-tracks

  • Write

    Create Podcast

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

    POST /v1/studio/podcasts

  • Write

    Create Pronunciation Dictionaries

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

    POST /v1/studio/projects/{project_id}/pronunciation-dictionaries

  • Write

    Create Studio Project

    Creates a new Studio project, it can be either initialized as blank, from a document or from a URL.

    POST /v1/studio/projects

  • Write

    Update Studio Project

    Updates the specified Studio project by setting the values of the parameters passed.

    POST /v1/studio/projects/{project_id}

  • Write

    Update Studio Project Content

    Updates Studio project content.

    POST /v1/studio/projects/{project_id}/content

  • Write

    Convert Studio Project

    Starts conversion of a Studio project and all of its chapters.

    POST /v1/studio/projects/{project_id}/convert

  • Write

    Stream Studio Project Audio

    Stream the audio from a Studio project snapshot.

    POST /v1/studio/projects/{project_id}/snapshots/{project_snapshot_id}/stream

  • Write

    Create Chapter

    Creates a new chapter either as blank or from a URL.

    POST /v1/studio/projects/{project_id}/chapters

  • Write

    Update Chapter

    Updates a chapter.

    POST /v1/studio/projects/{project_id}/chapters/{chapter_id}

  • Write

    Convert Chapter

    Starts conversion of a specific chapter.

    POST /v1/studio/projects/{project_id}/chapters/{chapter_id}/convert

  • Write

    Stream Chapter Audio

    Stream the audio from a chapter snapshot. Use `GET /v1/studio/projects/{project_id}/chapters/{chapter_id}/snapshots` to return the snapshots of a chapter.

    POST /v1/studio/projects/{project_id}/chapters/{chapter_id}/snapshots/{chapter_snapshot_id}/stream

  • Destructive

    Delete Studio Project

    Deletes a Studio project.

    DELETE /v1/studio/projects/{project_id}

  • Destructive

    Delete Chapter

    Deletes a chapter.

    DELETE /v1/studio/projects/{project_id}/chapters/{chapter_id}

Dubbing

  • Read

    List Dubbing Projects

    List 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 /v1/dubbing/project

  • Read

    Get Dubbing Project

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

    GET /v1/dubbing/project/{project_id}

  • Read

    List Dubbing Language Targets

    List a project's language targets, cursor-paginated, each with signed output URLs once it has produced an output.

    GET /v1/dubbing/project/{project_id}/language

  • Read

    Get Dubbing Language Target

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

    GET /v1/dubbing/project/{project_id}/language/{language_id}

  • Read

    Get Dubbing Transcript

    The project's source transcript, as editable segments. Available once the project is `ready`.

    GET /v1/dubbing/project/{project_id}/transcript

  • Read

    Get Dubbing Target Transcript

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

    GET /v1/dubbing/project/{project_id}/language/{language_id}/transcript

  • Write

    Create Dubbing Project

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

    POST /v1/dubbing/project

  • Write

    Create Dubbing Language Target

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

    POST /v1/dubbing/project/{project_id}/language

  • Write

    Update Dubbing Transcript Segment

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

    PATCH /v1/dubbing/project/{project_id}/transcript/segment/{segment_id}

  • Write

    Update Dubbing Transcript Segments

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

    PATCH /v1/dubbing/project/{project_id}/transcript/segments

  • Write

    Add Dubbing Transcript Segment

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

    POST /v1/dubbing/project/{project_id}/transcript/segment

  • Write

    Regenerate Dubbing Target

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

    POST /v1/dubbing/project/{project_id}/language/{language_id}/transcript/regenerate

  • Destructive

    Delete Dubbing Project

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

    DELETE /v1/dubbing/project/{project_id}

  • Destructive

    Delete Dubbing Language Target

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

    DELETE /v1/dubbing/project/{project_id}/language/{language_id}

  • Destructive

    Delete Dubbing Transcript Segment

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

    DELETE /v1/dubbing/project/{project_id}/transcript/segment/{segment_id}

  • Destructive

    Update Dubbing Target Transcript Segment

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

    PATCH /v1/dubbing/project/{project_id}/language/{language_id}/transcript/segment/{segment_id}

  • Destructive

    Update Dubbing Target Transcript Segments

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

    PATCH /v1/dubbing/project/{project_id}/language/{language_id}/transcript/segments

Models

  • Read

    Get Models

    Gets a list of available models.

    GET /v1/models

Audio native

  • Read

    Get Audio Native Project Settings

    Get player settings for the specific project.

    GET /v1/audio-native/{project_id}/settings

  • Write

    Creates Audio Native Enabled Project.

    Creates Audio Native enabled project, optionally starts conversion and returns project ID and embeddable HTML snippet.

    POST /v1/audio-native

  • Write

    Update Audio-Native Project Content

    Updates content for the specific AudioNative Project.

    POST /v1/audio-native/{project_id}/content

  • Write

    Update Audio-Native Content From Url

    Finds an AudioNative project matching the provided URL, extracts content from the URL, updates the project content, and queues it for conversion and auto-publishing.

    POST /v1/audio-native/content

Pronunciation Dictionary

  • Read

    Get Metadata For A Pronunciation Dictionary

    Get metadata for a pronunciation dictionary

    GET /v1/pronunciation-dictionaries/{pronunciation_dictionary_id}

  • Read

    Get A Pls File With A Pronunciation Dictionary Version Rules

    Get a PLS file with a pronunciation dictionary version rules

    GET /v1/pronunciation-dictionaries/{dictionary_id}/{version_id}/download

  • Read

    Get Pronunciation Dictionaries

    Get a list of the pronunciation dictionaries you have access to and their metadata

    GET /v1/pronunciation-dictionaries

  • Write

    Add A Pronunciation Dictionary

    Creates a new pronunciation dictionary from a lexicon .PLS file

    POST /v1/pronunciation-dictionaries/add-from-file

  • Write

    Add A Pronunciation Dictionary

    Creates a new pronunciation dictionary from provided rules.

    POST /v1/pronunciation-dictionaries/add-from-rules

  • Write

    Update Pronunciation Dictionary

    Partially update the pronunciation dictionary without changing the version

    PATCH /v1/pronunciation-dictionaries/{pronunciation_dictionary_id}

  • Destructive

    Set Rules On The Pronunciation Dictionary

    Replaces all existing rules on the pronunciation dictionary with the provided ones.

    POST /v1/pronunciation-dictionaries/{pronunciation_dictionary_id}/set-rules

  • Destructive

    Add Rules To The Pronunciation Dictionary

    Add rules to the pronunciation dictionary. If a rule with the same string_to_replace already exists, it will be replaced.

    POST /v1/pronunciation-dictionaries/{pronunciation_dictionary_id}/add-rules

  • Destructive

    Remove Rules From The Pronunciation Dictionary

    Remove rules from the pronunciation dictionary

    POST /v1/pronunciation-dictionaries/{pronunciation_dictionary_id}/remove-rules

Workspace

  • Read

    Get Service Account Api Keys Route

    Get all API keys for a service account

    GET /v1/service-accounts/{service_account_user_id}/api-keys

  • Read

    Get Workspace Audit Logs

    Returns the audit log for the workspace. Requires enterprise tier and the audit_log_read permission.

    GET /v1/workspace/audit-logs

  • Read

    Get Workspace Auth Connections

    Get all auth connections for the workspace

    GET /v1/workspace/auth-connections

  • Read

    Get Workspace Service Accounts

    List all service accounts in the workspace

    GET /v1/service-accounts

  • Read

    Get All Groups

    Get all groups in the workspace

    GET /v1/workspace/groups

  • Read

    Search User Groups

    Searches for user groups in the workspace. Multiple or no groups may be returned.

    GET /v1/workspace/groups/search

  • Read

    Get Workspace Members

    Gets a list of all members of the workspace, including locked members. Service accounts are excluded. Requires the workspace_members_read permission.

    GET /v1/workspace/members

  • Read

    Get Resource

    Gets the metadata of a resource by ID.

    GET /v1/workspace/resources/{resource_id}

  • Read

    List Workspace Webhooks

    List all webhooks for a workspace

    GET /v1/workspace/webhooks

  • Write

    Create Service Account Api Key

    Create a new API key for a service account

    POST /v1/service-accounts/{service_account_user_id}/api-keys

  • Write

    Create Workspace Auth Connection

    Create a new OAuth2 auth connection for the workspace

    POST /v1/workspace/auth-connections

  • Write

    Update Workspace Auth Connection

    Update an auth connection

    PATCH /v1/workspace/auth-connections/{auth_connection_id}

  • Write

    Create Service Account

    Create 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, up to 100.

    POST /v1/service-accounts

  • Write

    Add Member To User Group

    Adds a member of your workspace to the specified group. Requires `group_members_manage` permission.

    POST /v1/workspace/groups/{group_id}/members

  • Write

    Invite User

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

    POST /v1/workspace/invites/add

  • Write

    Invite Multiple Users

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

    POST /v1/workspace/invites/add-bulk

  • Write

    Update Member

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

    POST /v1/workspace/members

  • Write

    Share Workspace Resource

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

    POST /v1/workspace/resources/{resource_id}/share

  • Write

    Create Workspace Webhook

    Create a new webhook for the workspace with the specified authentication type.

    POST /v1/workspace/webhooks

  • Destructive

    Disable Api Key

    Disable the API key used to authenticate this request. Requires the query parameter `api_key_name=self` as an explicit confirmation.

    POST /v1/workspaces/api-keys/disable

  • Destructive

    Set Workspace Third-Party Disabling Policy

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

    POST /v1/workspaces/api-keys/third-party-disabling

  • Destructive

    Edit Service Account Api Key

    Update an existing API key for a service account

    PATCH /v1/service-accounts/{service_account_user_id}/api-keys/{api_key_id}

  • Destructive

    Delete Service Account Api Key

    Delete an existing API key for a service account

    DELETE /v1/service-accounts/{service_account_user_id}/api-keys/{api_key_id}

  • Destructive

    Disable Service Account Api Key

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

    POST /v1/service-accounts/{service_account_user_id}/api-keys/{api_key_id}/disable

  • Destructive

    Delete Workspace Auth Connection

    Delete an auth connection

    DELETE /v1/workspace/auth-connections/{auth_connection_id}

  • Destructive

    Delete Member From User Group

    Removes a member from the specified group. Requires `group_members_manage` permission.

    POST /v1/workspace/groups/{group_id}/members/remove

  • Destructive

    Delete Existing Invitation

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

    DELETE /v1/workspace/invites

  • Destructive

    Unshare Workspace Resource

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

    POST /v1/workspace/resources/{resource_id}/unshare

  • Destructive

    Update Workspace Webhook

    Update the specified workspace webhook

    PATCH /v1/workspace/webhooks/{webhook_id}

  • Destructive

    Delete Workspace Webhook

    Delete the specified workspace webhook

    DELETE /v1/workspace/webhooks/{webhook_id}

Video to music

  • Write

    Video To Music

    Generate background music from one or more video files. Videos are combined in order. Optional description and style tags influence the generated music.

    POST /v1/music/video-to-music

Speech to text

  • Read

    Get Transcript By Id

    Retrieve a previously generated transcript by its ID.

    GET /v1/speech-to-text/transcripts/{transcription_id}

  • Write

    Speech To Text

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

    POST /v1/speech-to-text

  • Destructive

    Delete Transcript By Id

    Delete a previously generated transcript by its ID.

    DELETE /v1/speech-to-text/transcripts/{transcription_id}

Single Use Token

  • Write

    Create Single Use Token

    Generate a time limited single-use token with embedded authentication for frontend clients.

    POST /v1/single-use-token/{token_type}

Forced alignment

  • Write

    Create Forced Alignment

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

    POST /v1/forced-alignment

Agents Platform

  • Read

    Get Webrtc Token

    Get a WebRTC session token for real-time communication.

    GET /v1/convai/conversation/token

  • Read

    Get Agent Summaries

    Returns summaries for the specified agents.

    GET /v1/convai/agents/summaries

  • Read

    Get Agent

    Retrieve config for an agent

    GET /v1/convai/agents/{agent_id}

  • Read

    Get Agent Widget Config

    Retrieve the widget configuration for an agent

    GET /v1/convai/agents/{agent_id}/widget

  • Read

    List Agents

    Returns a list of your agents and their metadata.

    GET /v1/convai/agents

  • Read

    Returns The Size Of The Agent'S Knowledge Base

    Returns the number of pages in the agent's knowledge base.

    GET /v1/convai/agent/{agent_id}/knowledge-base/size

  • Read

    Get Agent Test Folder By Id

    Gets an agent test folder by ID, including its folder path.

    GET /v1/convai/agent-testing/folders/{folder_id}

  • Read

    Get Conversations

    Get all conversations of agents that user owns. With option to restrict to a specific agent.

    GET /v1/convai/conversations

  • Read

    Get Conversation Users

    Get distinct users from conversations with pagination.

    GET /v1/convai/users

  • Read

    Resolve Conversation Reference

    Resolve 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 /v1/convai/conversations/resolve

  • Read

    Get Conversation Details

    Get the details of a particular conversation

    GET /v1/convai/conversations/{conversation_id}

  • Read

    Get Conversation Summary

    Get 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 /v1/convai/conversations/{conversation_id}/summary

  • Read

    Get Sip Messages For A Conversation

    Get SIP messages associated with a conversation's phone call

    GET /v1/convai/conversations/{conversation_id}/sip-messages

  • Read

    Get Conversation Audio

    Get the audio recording of a particular conversation

    GET /v1/convai/conversations/{conversation_id}/audio

  • Read

    Text Search Conversation Messages

    Search through conversation transcript messages by full-text and fuzzy search

    GET /v1/convai/conversations/messages/text-search

  • Read

    Smart Search Conversation Messages

    Search conversation transcripts by semantic similarity to surface relevant messages based on meaning and intent, rather than exact keyword matches

    GET /v1/convai/conversations/messages/smart-search

  • Read

    List Conversation Tags

    List conversation tags for the workspace, ordered by most recently created first.

    GET /v1/convai/tags

  • Read

    Get Conversation Tag

    Get a conversation tag by ID.

    GET /v1/convai/tags/{tag_id}

  • Read

    List Phone Numbers

    Retrieve all Phone Numbers

    GET /v1/convai/phone-numbers

  • Read

    Get Phone Number

    Retrieve Phone Number details by ID

    GET /v1/convai/phone-numbers/{phone_number_id}

  • Read

    List Phone Numbers Page

    Retrieve a page of Phone Numbers

    GET /v1/convai/v2/phone-numbers

  • Read

    Get Sip Messages For A Phone Number

    Get SIP messages for a phone number

    GET /v1/convai/phone-numbers/{phone_number_id}/sip-messages

  • Read

    Calculate Expected Llm Usage

    Returns a list of LLM models and the expected cost for using them based on the provided values.

    POST /v1/convai/llm-usage/calculate

  • Read

    List Available Llms

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

    GET /v1/convai/llm/list

  • Read

    Get Live Count

    Get the live count of the ongoing conversations.

    GET /v1/convai/analytics/live-count

  • Read

    Get Knowledge Base Summaries By Ids

    Gets multiple knowledge base document summaries by their IDs.

    GET /v1/convai/knowledge-base/summaries

  • Read

    Get Knowledge Base List

    Get a list of available knowledge base documents

    GET /v1/convai/knowledge-base

  • Read

    Get Documentation From Knowledge Base

    Get details about a specific documentation making up the agent's knowledge base

    GET /v1/convai/knowledge-base/{documentation_id}

  • Read

    Get Rag Index Overview.

    Provides total size and other information of RAG indexes used by knowledgebase documents

    GET /v1/convai/knowledge-base/rag-index

  • Read

    Get Rag Indexes Of The Specified Knowledgebase Document.

    Provides information about all RAG indexes of the specified knowledgebase document.

    GET /v1/convai/knowledge-base/{documentation_id}/rag-index

  • Read

    Search Knowledge Base Content

    Fuzzy text search over knowledge base document content

    GET /v1/convai/knowledge-base/search

  • Read

    Query Agent Knowledge Base Rag

    Run the agent's exact RAG retrieval for an ad-hoc query and return the ranked chunks the agent would retrieve. Read-only: no conversation is created. The response reflects current retrieval internals and may evolve.

    POST /v1/convai/agents/{agent_id}/knowledge-base/rag-query

  • Read

    Get Dependent Agents List

    Get a list of agents depending on this knowledge base document

    GET /v1/convai/knowledge-base/{documentation_id}/dependent-agents

  • Read

    Get Dependent Agents For Multiple Documents

    Get a list of agents depending on any of the given knowledge base documents.

    POST /v1/convai/knowledge-base/dependent-agents

  • Read

    Get Document Content

    Get the entire content of a document from the knowledge base

    GET /v1/convai/knowledge-base/{documentation_id}/content

  • Read

    Get Document Source File Url

    Get a signed URL to download the original source file of a file-type document from the knowledge base

    GET /v1/convai/knowledge-base/{documentation_id}/source-file-url

  • Read

    Get Documentation Chunk From Knowledge Base

    Get details about a specific documentation part used by RAG.

    GET /v1/convai/knowledge-base/{documentation_id}/chunk/{chunk_id}

  • Read

    Get All Rag Chunks For A Document

    Get all RAG chunks for a specific knowledge base document.

    GET /v1/convai/knowledge-base/{documentation_id}/chunks

  • Read

    Get Tools

    Get all available tools in the workspace.

    GET /v1/convai/tools

  • Read

    Get Tool

    Get tool that is available in the workspace.

    GET /v1/convai/tools/{tool_id}

  • Read

    Get Dependent Agents List

    Get a list of agents depending on this tool

    GET /v1/convai/tools/{tool_id}/dependent-agents

  • Read

    Get Tool Executions

    Get paginated list of tool executions for a specific tool.

    GET /v1/convai/tools/{tool_id}/executions

  • Read

    Get Convai Settings

    Retrieve Convai settings for the workspace

    GET /v1/convai/settings

  • Read

    Get Convai Dashboard Settings

    Retrieve Convai dashboard settings for the workspace

    GET /v1/convai/settings/dashboard

  • Read

    Get Convai Workspace Secrets

    Get all workspace secrets for the user

    GET /v1/convai/secrets

  • Read

    Get Convai Workspace Secret

    Get a workspace secret by ID

    GET /v1/convai/secrets/{secret_id}

  • Read

    Get Secret Dependencies By Type

    Get paginated list of resources that depend on a specific secret, filtered by resource type.

    GET /v1/convai/secrets/{secret_id}/dependencies/{resource_type}

  • Read

    Get All Batch Calls For A Workspace.

    Get all batch calls for the current workspace.

    GET /v1/convai/batch-calling/workspace

  • Read

    Get A Batch Call By Id.

    Get detailed information about a batch call including all recipients.

    GET /v1/convai/batch-calling/{batch_id}

  • Read

    Export Batch Call Results

    Download all recipients and conversation results for a terminal batch call as CSV.

    GET /v1/convai/batch-calling/{batch_id}/export

  • Read

    List Mcp Servers

    Retrieve all MCP server configurations available in the workspace.

    GET /v1/convai/mcp-servers

  • Read

    Get Mcp Server

    Retrieve a specific MCP server configuration from the workspace.

    GET /v1/convai/mcp-servers/{mcp_server_id}

  • Read

    List Mcp Server Tools

    Retrieve all tools available for a specific MCP server configuration.

    GET /v1/convai/mcp-servers/{mcp_server_id}/tools

  • Read

    Get Mcp Tool Configuration Override

    Retrieve configuration overrides for a specific MCP tool.

    GET /v1/convai/mcp-servers/{mcp_server_id}/tool-configs/{tool_name}

  • Read

    Get Whatsapp Account

    Get a WhatsApp account

    GET /v1/convai/whatsapp-accounts/{phone_number_id}

  • Read

    List Whatsapp Accounts

    List all WhatsApp accounts

    GET /v1/convai/whatsapp-accounts

  • Read

    List Agent Branches

    Returns a list of branches an agent has

    GET /v1/convai/agents/{agent_id}/branches

  • Read

    Get Agent Branch

    Get information about a single agent branch

    GET /v1/convai/agents/{agent_id}/branches/{branch_id}

  • Read

    Get Agent Version Metadata

    Get metadata for a specific agent version

    GET /v1/convai/agents/{agent_id}/versions/{version_id}

  • Read

    Preview Merged Configuration

    Returns the result of merging the source branch into the target branch without performing the merge. Useful for showing an accurate diff before confirming.

    GET /v1/convai/agents/{agent_id}/branches/{source_branch_id}/merge-preview

  • Read

    Preview Rebased Configuration

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

    GET /v1/convai/agents/{agent_id}/branches/{branch_id}/rebase-preview

  • Read

    List Agent Deployments

    List the traffic split history of an agent, newest first

    GET /v1/convai/agents/{agent_id}/deployments

  • Read

    List Proposals

    List the proposals for an agent, newest first.

    GET /v1/convai/agents/{agent_id}/merge-proposals

  • Read

    Get A Merge Proposal

    Get a single merge_proposal.

    GET /v1/convai/agents/{agent_id}/merge-proposals/{merge_proposal_id}

  • Read

    List Procedures

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

    GET /v1/convai/agents/{agent_id}/branches/{branch_id}/procedures

  • Read

    Get Procedure

    Retrieve a procedure at a specific version or the current branch HEAD.

    GET /v1/convai/agents/{agent_id}/branches/{branch_id}/procedures/{procedure_id}

  • Read

    Get Procedure Draft

    Get user's draft for a procedure

    GET /v1/convai/agents/{agent_id}/branches/{branch_id}/procedures/{procedure_id}/draft

  • Read

    List Environment Variables

    List all environment variables for the workspace with optional filtering

    GET /v1/convai/environment-variables

  • Read

    Get Environment Variable

    Get a specific environment variable by ID

    GET /v1/convai/environment-variables/{env_var_id}

  • Read

    List Environments

    List the workspace environments, including 'production'.

    GET /v1/convai/environments

  • Read

    Get Signed Url (deprecated)

    Get a signed url to start a conversation with an agent with an agent that requires authorization

    GET /v1/convai/conversation/get_signed_url

  • Write

    Handle An Outbound Call Via Twilio

    Handle an outbound call via Twilio

    POST /v1/convai/twilio/outbound-call

  • Write

    Register A Twilio Call And Return Twiml

    Register a Twilio call and return TwiML to connect the call

    POST /v1/convai/twilio/register-call

  • Write

    Handle An Outbound Call Via Exotel

    Handle an outbound call via Exotel Connect API

    POST /v1/convai/exotel/outbound-call

  • Write

    Make An Outbound Call Via Whatsapp

    Make an outbound call via WhatsApp

    POST /v1/convai/whatsapp/outbound-call

  • Write

    Send An Outbound Message Via Whatsapp

    Send an outbound message via WhatsApp

    POST /v1/convai/whatsapp/outbound-message

  • Write

    Create Agent

    Create an agent from a config object

    POST /v1/convai/agents/create

  • Write

    Post Agent Avatar

    Sets the avatar for an agent displayed in the widget

    POST /v1/convai/agents/{agent_id}/avatar

  • Write

    Calculate Expected Llm Usage For An Agent

    Calculates expected number of LLM tokens needed for the specified agent.

    POST /v1/convai/agent/{agent_id}/llm-usage/calculate

  • Write

    Duplicate Agent

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

    POST /v1/convai/agents/{agent_id}/duplicate

  • Write

    Create Agent Test Folder

    Creates a folder for organizing agent tests.

    POST /v1/convai/agent-testing/folders

  • Write

    Update Agent Test Folder

    Updates an agent test folder. Currently only supports updating the folder name.

    PATCH /v1/convai/agent-testing/folders/{folder_id}

  • Write

    Bulk Move Tests To Folder

    Moves multiple tests or folders from one folder to another.

    POST /v1/convai/agent-testing/bulk-move

  • Write

    Send Conversation Feedback

    Send the feedback for the given conversation

    POST /v1/convai/conversations/{conversation_id}/feedback

  • Write

    Assign Conversation Tags

    Assign one or more conversation tags to a conversation. Tags that are already assigned are ignored. Tags must belong to the same workspace.

    POST /v1/convai/conversations/{conversation_id}/tags

  • Write

    Create Conversation Tag

    Create a new conversation tag for the workspace.

    POST /v1/convai/tags

  • Write

    Import Phone Number

    Import Phone Number from provider configuration (Twilio, Exotel, or SIP trunk)

    POST /v1/convai/phone-numbers

  • Write

    Update Phone Number

    Update assigned agent of a phone number

    PATCH /v1/convai/phone-numbers/{phone_number_id}

  • Write

    Upload File

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

    POST /v1/convai/conversations/{conversation_id}/files

  • Write

    Create Url Document

    Create a knowledge base document generated by scraping the given webpage.

    POST /v1/convai/knowledge-base/url

  • Write

    Create File Document

    Create a knowledge base document generated form the uploaded file.

    POST /v1/convai/knowledge-base/file

  • Write

    Create Text Document

    Create a knowledge base document containing the provided text.

    POST /v1/convai/knowledge-base/text

  • Write

    Compute Rag Indexes In Batch

    Retrieves and/or creates RAG indexes for multiple knowledge base documents in a single request. Maximum 100 items per request.

    POST /v1/convai/knowledge-base/rag-index

  • Write

    Refresh Url Document Content

    Manually refresh a URL document by re-fetching its content from the source URL.

    POST /v1/convai/knowledge-base/{documentation_id}/refresh

  • Write

    Compute Rag Index.

    In case the document is not RAG indexed, it triggers rag indexing task, otherwise it just returns the current status.

    POST /v1/convai/knowledge-base/{documentation_id}/rag-index

  • Write

    Add Tool

    Add a new tool to the available tools in the workspace.

    POST /v1/convai/tools

  • Write

    Update Tool

    Update tool that is available in the workspace.

    PATCH /v1/convai/tools/{tool_id}

  • Write

    Update Convai Settings

    Update Convai settings for the workspace

    PATCH /v1/convai/settings

  • Write

    Update Convai Dashboard Settings

    Update Convai dashboard settings for the workspace

    PATCH /v1/convai/settings/dashboard

  • Write

    Create Convai Workspace Secret

    Create a new secret for the workspace

    POST /v1/convai/secrets

  • Write

    Update Convai Workspace Secret

    Update an existing secret for the workspace

    PATCH /v1/convai/secrets/{secret_id}

  • Write

    Submit A Batch Call Request.

    Submit a batch call request to schedule calls for multiple recipients.

    POST /v1/convai/batch-calling/submit

  • Write

    Retry A Batch Call.

    Retry a batch call, calling failed and no-response recipients again.

    POST /v1/convai/batch-calling/{batch_id}/retry

  • Write

    Handle An Outbound Call Via Sip Trunk

    Handle an outbound call via SIP trunk

    POST /v1/convai/sip-trunk/outbound-call

  • Write

    Create Mcp Server

    Create a new MCP server configuration in the workspace.

    POST /v1/convai/mcp-servers

  • Write

    Update Mcp Server Configuration

    Update the configuration settings for an MCP server.

    PATCH /v1/convai/mcp-servers/{mcp_server_id}

  • Write

    Create Mcp Server Tool Approval

    Add approval for a specific MCP tool when using per-tool approval mode.

    POST /v1/convai/mcp-servers/{mcp_server_id}/tool-approvals

  • Write

    Create Mcp Tool Configuration Override

    Create configuration overrides for a specific MCP tool.

    POST /v1/convai/mcp-servers/{mcp_server_id}/tool-configs

  • Write

    Update Mcp Tool Configuration Override

    Update configuration overrides for a specific MCP tool.

    PATCH /v1/convai/mcp-servers/{mcp_server_id}/tool-configs/{tool_name}

  • Write

    Update Whatsapp Account

    Update a WhatsApp account

    PATCH /v1/convai/whatsapp-accounts/{phone_number_id}

  • Write

    Create A New Branch

    Create a new branch from a given version of any branch

    POST /v1/convai/agents/{agent_id}/branches

  • Write

    Merge A Branch Into A Target Branch

    Merge a branch into a target branch

    POST /v1/convai/agents/{agent_id}/branches/{source_branch_id}/merge

  • Write

    Rebase A Branch Onto Main

    Pull changes from a source branch (defaults to main) into this branch as a new version, preserving this branch's own changes on conflicts.

    POST /v1/convai/agents/{agent_id}/branches/{branch_id}/rebase

  • Write

    Create Or Update Deployments

    Create a new deployment for an agent

    POST /v1/convai/agents/{agent_id}/deployments

  • Write

    Create Agent Draft

    Create a new draft for an agent

    POST /v1/convai/agents/{agent_id}/drafts

  • Write

    Create A Merge Proposal

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

    POST /v1/convai/agents/{agent_id}/merge-proposals

  • Write

    Comment On A Merge Proposal

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

    POST /v1/convai/agents/{agent_id}/merge-proposals/{merge_proposal_id}/comments

  • Write

    Merge A Merge Proposal

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

    POST /v1/convai/agents/{agent_id}/merge-proposals/{merge_proposal_id}/merge

  • Write

    Create Procedure

    Create a new procedure for the agent on a branch.

    POST /v1/convai/agents/{agent_id}/branches/{branch_id}/procedures

  • Write

    Legacy: Compile Procedures

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

    POST /v1/convai/agents/{agent_id}/branches/{branch_id}/procedures/compile

  • Write

    Create Environment Variable

    Create a new environment variable for the workspace

    POST /v1/convai/environment-variables

  • Write

    Create Environment

    Create a workspace environment. Variables without a value for it fall back to their production value.

    POST /v1/convai/environments

  • Write

    Simulates A Conversation (deprecated)

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

    POST /v1/convai/agents/{agent_id}/simulate-conversation

  • Write

    Simulates A Conversation (Stream) (deprecated)

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

    POST /v1/convai/agents/{agent_id}/simulate-conversation/stream

  • Write

    Add To Knowledge Base (deprecated)

    Uploads a file or reference a webpage to use as part of the shared knowledge base

    POST /v1/convai/knowledge-base

  • Write

    Update Mcp Server Approval Policy (deprecated)

    Update the approval policy configuration for an MCP server. DEPRECATED: Use PATCH /mcp-servers/{id} endpoint instead.

    PATCH /v1/convai/mcp-servers/{mcp_server_id}/approval-policy

  • Destructive

    Patches An Agent Settings

    Patches an Agent settings

    PATCH /v1/convai/agents/{agent_id}

  • Destructive

    Delete Agent

    Delete an agent

    DELETE /v1/convai/agents/{agent_id}

  • Destructive

    Post Agent Hold Audio

    Sets the custom hold audio played on loop to callers waiting in the agent's concurrency wait queue. Replaces any previously uploaded clip.

    POST /v1/convai/agents/{agent_id}/hold-audio

  • Destructive

    Delete Agent Hold Audio

    Removes the agent's custom hold audio; queued callers hear the default hold tone again.

    DELETE /v1/convai/agents/{agent_id}/hold-audio

  • Destructive

    Delete Agent Test Folder

    Deletes an agent test folder by ID. Use force=true to delete a non-empty folder and all its contents.

    DELETE /v1/convai/agent-testing/folders/{folder_id}

  • Destructive

    Delete Conversation

    Delete a particular conversation

    DELETE /v1/convai/conversations/{conversation_id}

  • Destructive

    Unassign Conversation Tag

    Remove a single conversation tag from a conversation.

    DELETE /v1/convai/conversations/{conversation_id}/tags/{tag_id}

  • Destructive

    Update Conversation Tag

    Update a conversation tag's title and/or description. Restricted to the tag owner or a workspace admin.

    PATCH /v1/convai/tags/{tag_id}

  • Destructive

    Delete Conversation Tag

    Delete a conversation tag. Restricted to the tag owner or a workspace admin.

    DELETE /v1/convai/tags/{tag_id}

  • Destructive

    Delete Phone Number

    Delete Phone Number by ID

    DELETE /v1/convai/phone-numbers/{phone_number_id}

  • Destructive

    Delete File Upload

    Remove a file upload from a conversation. Only possible if the file hasn't already been used in the conversation.

    DELETE /v1/convai/conversations/{conversation_id}/files/{file_id}

  • Destructive

    Update Document

    Update the name, content and/or auto-sync settings of a document.

    PATCH /v1/convai/knowledge-base/{documentation_id}

  • Destructive

    Delete Knowledge Base Document Or Folder

    Delete a document or folder from the knowledge base.

    DELETE /v1/convai/knowledge-base/{documentation_id}

  • Destructive

    Update File Document

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

    PATCH /v1/convai/knowledge-base/{documentation_id}/update-file

  • Destructive

    Delete Rag Index.

    Delete RAG index for the knowledgebase document.

    DELETE /v1/convai/knowledge-base/{documentation_id}/rag-index/{rag_index_id}

  • Destructive

    Bulk Delete Knowledge Base Documents

    Delete multiple documents or folders from the knowledge base. Each id succeeds or fails independently.

    POST /v1/convai/knowledge-base/bulk-delete

  • Destructive

    Delete Tool

    Delete tool from the workspace.

    DELETE /v1/convai/tools/{tool_id}

  • Destructive

    Delete Convai Workspace Secret

    Delete a workspace secret if it's not in use

    DELETE /v1/convai/secrets/{secret_id}

  • Destructive

    Delete A Batch Call.

    Permanently delete a batch call and all recipient records. Conversations remain in history.

    DELETE /v1/convai/batch-calling/{batch_id}

  • Destructive

    Cancel A Batch Call.

    Cancel a running batch call and set all recipients to cancelled status.

    POST /v1/convai/batch-calling/{batch_id}/cancel

  • Destructive

    Delete Mcp Server

    Delete a specific MCP server configuration from the workspace.

    DELETE /v1/convai/mcp-servers/{mcp_server_id}

  • Destructive

    Delete Mcp Server Tool Approval

    Remove approval for a specific MCP tool when using per-tool approval mode.

    DELETE /v1/convai/mcp-servers/{mcp_server_id}/tool-approvals/{tool_name}

  • Destructive

    Delete Mcp Tool Configuration Override

    Remove configuration overrides for a specific MCP tool.

    DELETE /v1/convai/mcp-servers/{mcp_server_id}/tool-configs/{tool_name}

  • Destructive

    Delete Whatsapp Account

    Delete a WhatsApp account

    DELETE /v1/convai/whatsapp-accounts/{phone_number_id}

  • Destructive

    Update Agent Branch

    Update agent branch properties such as name, description, archiving status, protection level, and auto-rebase onto main

    PATCH /v1/convai/agents/{agent_id}/branches/{branch_id}

  • Destructive

    Delete Agent Draft

    Delete a draft for an agent

    DELETE /v1/convai/agents/{agent_id}/drafts

  • Destructive

    Update A Merge Proposal

    Edit an open merge_proposal's title or description, or close it. The author closing it is recorded as withdrawn; anyone else as rejected.

    PATCH /v1/convai/agents/{agent_id}/merge-proposals/{merge_proposal_id}

  • Destructive

    Review A Merge Proposal

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

    POST /v1/convai/agents/{agent_id}/merge-proposals/{merge_proposal_id}/reviews

  • Destructive

    Remove Procedure

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

    DELETE /v1/convai/agents/{agent_id}/branches/{branch_id}/procedures/{procedure_id}

  • Destructive

    Update Procedure Draft

    Create or update user's draft for a procedure

    PATCH /v1/convai/agents/{agent_id}/branches/{branch_id}/procedures/{procedure_id}/draft

  • Destructive

    Delete Procedure Draft

    Delete user's draft for a procedure, resetting to the committed version

    DELETE /v1/convai/agents/{agent_id}/branches/{branch_id}/procedures/{procedure_id}/draft

  • Destructive

    Update Environment Variable

    Replace 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}.

    PATCH /v1/convai/environment-variables/{env_var_id}

  • Destructive

    Delete Environment Variable

    Delete an environment variable and its values in all environments. WARNING: Agents are not checked. A variable that an agent still uses (custom LLM, webhooks or cloud storage export, on any branch or version) is deleted anyway, and that agent's conversations then fail. The delete is only rejected while tools, MCP servers or the workspace conversation initiation webhook use the variable.

    DELETE /v1/convai/environment-variables/{env_var_id}

  • Destructive

    Delete Environment

    Delete a workspace environment and remove its values from all environment variables. 'production' cannot be deleted.

    DELETE /v1/convai/environments/{environment}

Convai

  • Read

    Get Agent Response Test By Id

    Gets an agent response test by ID.

    GET /v1/convai/agent-testing/{test_id}

  • Read

    Get Agent Response Test Summaries By Ids

    Gets agent response test summaries for the requested test IDs.

    POST /v1/convai/agent-testing/summaries

  • Read

    List Agent Response Tests

    Lists all agent response tests with pagination support and optional search filtering.

    GET /v1/convai/agent-testing

  • Read

    List Test Invocations

    Lists all test invocations with pagination support and optional search filtering.

    GET /v1/convai/test-invocations

  • Read

    Get Test Invocation

    Gets a test invocation by ID.

    GET /v1/convai/test-invocations/{test_invocation_id}

  • Read

    List Agent Conversation Tickets

    List an agent's conversation triage tickets, ordered by most recently created first unless sorted by priority. These are tickets about the agent's own performance on a conversation (for triage with Architect), not tickets an agent opens for end users.

    GET /v1/convai/agents/{agent_id}/triage-tickets

  • Read

    List Workspace Conversation Tickets

    List conversation triage tickets across every agent in the workspace, ordered by most recently created first. Use this to build a workspace-wide view (for example, tickets assigned to the caller). Supports the same filters, sorting and search as the per-agent endpoint. Tickets for agents the caller cannot access are omitted.

    GET /v1/convai/triage-tickets

  • Read

    Get Agent Conversation Ticket Assignable Users

    All 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 /v1/convai/agents/{agent_id}/triage-tickets/assignable-users

  • Read

    Get Agent Conversation Ticket

    Get an agent conversation ticket by ID.

    GET /v1/convai/triage-tickets/{agentqa_ticket_id}

  • Write

    Create Agent Response Test

    Creates a new agent response test.

    POST /v1/convai/agent-testing/create

  • Write

    Update Agent Response Test

    Updates an agent response test by ID.

    PUT /v1/convai/agent-testing/{test_id}

  • Write

    Run Tests On The Agent

    Run selected tests on the agent with provided configuration. If the agent configuration is provided, it will be used to override default agent configuration.

    POST /v1/convai/agents/{agent_id}/run-tests

  • Write

    Update Test Invocation

    Updates the user-provided name of a test invocation.

    PATCH /v1/convai/test-invocations/{test_invocation_id}

  • Write

    Resubmit Tests

    Resubmits specific test runs from a test invocation.

    POST /v1/convai/test-invocations/{test_invocation_id}/resubmit

  • Write

    Create Manual Agent Ticket

    Manually raise a follow-up ticket 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.

    POST /v1/convai/agents/{agent_id}/triage-tickets

  • Write

    Create Agent Conversation Ticket

    Raise a ticket about an agent's performance on a conversation, for triage with Architect. Provide an overall comment and/or turn-level comments describing what went wrong.

    POST /v1/convai/triage-tickets

  • Write

    Add Comment To Agent Conversation Ticket

    Append a comment discussing how to resolve the ticket. Requires viewer access to the ticket's agent.

    POST /v1/convai/triage-tickets/{agentqa_ticket_id}/comments

  • Write

    Merge Agent Conversation Tickets

    Merge other open tickets of the same agent into this pending, in-progress, or resolved one. Their conversations move onto this ticket, its priority is raised to the highest among them, and they are kept with status 'merged'. Requires viewer access to the ticket's agent.

    POST /v1/convai/triage-tickets/{agentqa_ticket_id}/merge

  • Write

    Add Turn Comment To Agent Conversation Ticket

    Append a turn-level comment to a ticket. Requires viewer access to the ticket's agent.

    POST /v1/convai/triage-tickets/{agentqa_ticket_id}/turn-comments

  • Destructive

    Delete Agent Response Test

    Deletes an agent response test by ID.

    DELETE /v1/convai/agent-testing/{test_id}

  • Destructive

    Cancel Test Invocation

    Cancels all pending runs in a test invocation.

    POST /v1/convai/test-invocations/{test_invocation_id}/cancel

  • Destructive

    Update Agent Conversation Ticket

    Update a ticket's title, comment, status, priority, and/or assignee. Requires viewer access to the ticket's agent.

    PATCH /v1/convai/triage-tickets/{agentqa_ticket_id}

  • Destructive

    Delete Agent Conversation Ticket

    Delete an agent conversation ticket. Restricted to the ticket creator or a workspace admin.

    DELETE /v1/convai/triage-tickets/{agentqa_ticket_id}

Conversational AI

  • Read

    List Ongoing And Recent Crawl Jobs Created By A User

    Get a list of ongoing and recent crawl jobs for the user.

    GET /v1/convai/knowledge-base/crawl

  • Read

    Get Crawl Job Details

    Get details about a specific crawl job including status and progress.

    GET /v1/convai/knowledge-base/crawl/{crawl_job_id}

  • Write

    Create Crawl Job

    Create a crawl job to crawl the given URL with specified depth and page limits.

    POST /v1/convai/knowledge-base/crawl

  • Write

    Create Folder

    Create a folder used for grouping documents together.

    POST /v1/convai/knowledge-base/folder

  • Write

    Move Entity To Folder

    Moves the entity from one folder to another.

    POST /v1/convai/knowledge-base/{document_id}/move

  • Write

    Bulk Move Entities To Folder

    Moves multiple entities from one folder to another.

    POST /v1/convai/knowledge-base/bulk-move

  • Destructive

    Cancel Crawl Job

    Cancel a crawl job and delete all associated documents and folders.

    POST /v1/convai/knowledge-base/crawl/{crawl_job_id}/cancel

Agents Insights

  • Read

    Get Agent Conversation Topics

    Returns the latest topic discovery run results for a given agent.

    GET /v1/convai/agents/{agent_id}/topics

Speech Engine

  • Read

    List Speech Engines

    Returns a paginated list of Speech Engine resources.

    GET /v1/speech-engine

  • Read

    Get Speech Engine

    Retrieve a Speech Engine resource

    GET /v1/speech-engine/{speech_engine_id}

  • Write

    Create Speech Engine

    Create a new Speech Engine resource

    POST /v1/speech-engine

  • Write

    Update Speech Engine

    Update a Speech Engine resource (partial update)

    PATCH /v1/speech-engine/{speech_engine_id}

  • Write

    Duplicate Speech Engine

    Create a new Speech Engine resource by duplicating an existing one

    POST /v1/speech-engine/{speech_engine_id}/duplicate

  • Destructive

    Delete Speech Engine

    Delete a Speech Engine resource

    DELETE /v1/speech-engine/{speech_engine_id}

Agents Workspace Analytics

  • Write

    Run Conversation Analysis

    Run the analysis for a conversation using the agent's current evaluation criteria and data collection settings.

    POST /v1/convai/conversations/{conversation_id}/analysis/run

  • Write

    Run Conversation Evaluation

    Rerun a specific evaluation for a conversation.

    POST /v1/convai/conversations/{conversation_id}/analysis/evaluations/run

Realtime

  • Write

    Create Realtime Client Secret

    Create an ephemeral client secret for authenticating browser-based Realtime API sessions.

    POST /v1/convai/realtime/client_secrets

Music generation

  • Write

    Generate Composition Plan

    Generate a composition plan from a prompt.

    POST /v1/music/plan

  • Write

    Compose Music

    Compose a song from a prompt or a composition plan.

    POST /v1/music

  • Write

    Compose Music With A Detailed Response

    Compose a song from a prompt or a composition plan.

    POST /v1/music/detailed

  • Write

    Stream Composed Music With A Detailed Response

    Stream a song and its detailed metadata using Server-Sent Events (SSE).

    POST /v1/music/detailed/stream

  • Write

    Stream Composed Music

    Stream a composed song from a prompt or a composition plan.

    POST /v1/music/stream

  • Write

    Upload Music

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

    POST /v1/music/upload

  • Write

    Stem Separation

    Separate an audio file into individual stems. This endpoint might have high latency, depending on the length of the audio file.

    POST /v1/music/stem-separation

Music finetunes

  • Read

    Get Music Finetunes

    List music finetunes accessible to you (your own, workspace-shared, and ElevenLabs-curated), with optional filtering, sorting, and cursor pagination.

    GET /v1/music/finetunes

  • Read

    Get Music Finetune

    Get a music finetune.

    GET /v1/music/finetunes/{finetune_id}

  • Write

    Create Music Finetune

    Create a new music finetune

    POST /v1/music/finetunes

  • Destructive

    Update Music Finetune

    Update a music finetune.

    PATCH /v1/music/finetunes/{finetune_id}

  • Destructive

    Delete Music Finetune

    Delete a music finetune

    DELETE /v1/music/finetunes/{finetune_id}

Productions

  • Read

    List Orders

    Lists Productions orders in the workspace. Supports filtering by status and date range, with pagination.

    GET /v1/productions/orders

  • Read

    Get Order

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

    GET /v1/productions/orders/{order_id}

  • Read

    Get Media Info

    Retrieves metadata and a time-limited download URL for a previously uploaded media file.

    GET /v1/productions/orders/{order_id}/media/{media_id}

  • Read

    Get Order Deliverables

    Retrieves the delivered files for a completed order. Returns an empty list if the order is not yet completed.

    GET /v1/productions/orders/{order_id}/deliverables

  • Read

    Get Available Languages

    Returns the available languages for a given order item kind.

    GET /v1/productions/orders/languages/{order_item_kind}

  • Write

    Create Order

    Creates a new Productions order in the workspace. The order starts in the open state and can be configured with items before submission.

    POST /v1/productions/orders

  • Write

    Update Order

    Updates an open order.

    PATCH /v1/productions/orders/{order_id}

  • Write

    Register Media

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

    POST /v1/productions/orders/{order_id}/media

  • Write

    Upsert Order Item

    Adds or updates an order item on an open order. Returns the item ID and the quoted price.

    POST /v1/productions/orders/{order_id}/items

  • Write

    Submit Order

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

    POST /v1/productions/orders/{order_id}/submit

  • Destructive

    Remove Order Item

    Removes an order item from an open order.

    DELETE /v1/productions/orders/{order_id}/items/{item_id}

Pvc voices

  • Read

    Retrieve Voice Sample Audio

    Retrieve the first 30 seconds of voice sample audio with or without noise removal.

    GET /v1/voices/pvc/{voice_id}/samples/{sample_id}/audio

  • Read

    Retrieve Voice Sample Visual Waveform

    Retrieve the visual waveform of a voice sample.

    GET /v1/voices/pvc/{voice_id}/samples/{sample_id}/waveform

  • Read

    Retrieve Speaker Separation Status

    Retrieve the status of the speaker separation process and the list of detected speakers if complete.

    GET /v1/voices/pvc/{voice_id}/samples/{sample_id}/speakers

  • Read

    Retrieve Separated Speaker Audio

    Retrieve the separated audio for a specific speaker.

    GET /v1/voices/pvc/{voice_id}/samples/{sample_id}/speakers/{speaker_id}/audio

  • Read

    Get Pvc Voice Captcha

    Get captcha for PVC voice verification.

    GET /v1/voices/pvc/{voice_id}/captcha

  • Write

    Create Pvc Voice

    Creates a new PVC voice with metadata but no samples

    POST /v1/voices/pvc

  • Write

    Edit Pvc Voice

    Edit PVC voice metadata

    POST /v1/voices/pvc/{voice_id}

  • Write

    Add Samples To Pvc Voice

    Add audio samples to a PVC voice

    POST /v1/voices/pvc/{voice_id}/samples

  • Write

    Start Speaker Separation

    Start speaker separation process for a sample

    POST /v1/voices/pvc/{voice_id}/samples/{sample_id}/separate-speakers

  • Write

    Verify Pvc Voice Captcha

    Submit captcha verification for PVC voice.

    POST /v1/voices/pvc/{voice_id}/captcha

  • Write

    Run Pvc Training

    Start PVC training process for a voice.

    POST /v1/voices/pvc/{voice_id}/train

  • Write

    Request Manual Verification

    Request manual verification for a PVC voice.

    POST /v1/voices/pvc/{voice_id}/verification

  • Destructive

    Update Pvc Voice Sample

    Update a PVC voice sample - apply noise removal, select speaker, change trim times or file name.

    POST /v1/voices/pvc/{voice_id}/samples/{sample_id}

  • Destructive

    Delete Pvc Voice Sample

    Delete a sample from a PVC voice.

    DELETE /v1/voices/pvc/{voice_id}/samples/{sample_id}

Flows

  • Read

    List Video Generations

    List the video generations created through this API, newest first.

    GET /v1/flows/video

  • Read

    Get Video Generation

    Retrieve the status of a video generation, and retrieve its output URL once completed.

    GET /v1/flows/video/{generation_id}

  • Read

    List Image Generations

    List the image generations created through this API, newest first.

    GET /v1/flows/image

  • Read

    Get Image Generation

    Retrieve the status of an image generation, and retrieve its output URL once completed.

    GET /v1/flows/image/{generation_id}

  • Read

    List Speech Generations

    List the speech generations created through this API, newest first.

    GET /v1/flows/text-to-speech

  • Read

    Get Speech Generation

    Retrieve the status of a speech generation, and retrieve its output URL once completed.

    GET /v1/flows/text-to-speech/{generation_id}

  • Read

    List Template Runs

    List this template's runs created through this API, newest first.

    GET /v1/flows/templates/{template_id}/runs

  • Read

    Get Template Run

    Retrieve a template run: its `status`, rolled up from its outputs, and each output's own status and download URL once completed.

    GET /v1/flows/templates/{template_id}/runs/{run_id}

  • Read

    List Templates

    List 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 /v1/flows/templates

  • Read

    Get Template

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

    GET /v1/flows/templates/{template_id}

  • Write

    Create Video Generation

    Start a video generation with the selected model.

    POST /v1/flows/video

  • Write

    Create Image Generation

    Start an image generation with the selected model.

    POST /v1/flows/image

  • Write

    Create Speech Generation

    Start 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`.

    POST /v1/flows/text-to-speech

  • Write

    Create Template Run

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

    POST /v1/flows/templates/{template_id}/runs

Assets

  • Read

    List Assets

    List assets in the workspace, most recently created first.

    GET /v1/assets

  • Read

    Get Asset

    Retrieve a single asset by ID.

    GET /v1/assets/{asset_id}

  • Write

    Upload Asset

    Upload a new asset.

    POST /v1/assets

  • Destructive

    Delete Asset

    Delete an asset by ID.

    DELETE /v1/assets/{asset_id}

Access:all

  • Read

    Get Workspace Usage

    Returns credit usage broken down by product type over time. 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.

    POST /v1/workspace/analytics/query/usage-by-product-over-time

  • Read

    List Api Requests

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

    POST /v1/workspace/analytics/requests

Docs

  • Read

    Redirect To Mintlify

    Redirect To Mintlify.

    GET /docs

text-to-voice

  • Write

    [Deprecated] Generate A Voice Preview From Description (deprecated)

    **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`.

    POST /v1/text-to-voice/create-previews

dubbing

  • Read

    Get The Dubbing Resource For An Id. (deprecated)

    Given a dubbing ID generated from the '/v1/dubbing' endpoint with studio enabled, returns the dubbing resource.

    GET /v1/dubbing/resource/{dubbing_id}

  • Read

    Search The Elevenlabs Library For Voices Similar To A Speaker. (deprecated)

    Fetch the top 10 similar voices to a speaker, including the voice IDs, names, descriptions, and, where possible, a sample audio recording.

    GET /v1/dubbing/resource/{dubbing_id}/speaker/{speaker_id}/similar-voices

  • Read

    List Dubs (deprecated)

    List the dubs you have access to.

    GET /v1/dubbing

  • Read

    Get Dubbing (deprecated)

    Returns metadata about a dubbing project, including whether it's still in progress or not

    GET /v1/dubbing/{dubbing_id}

  • Read

    Get Dubbed File (deprecated)

    Returns 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 /v1/dubbing/{dubbing_id}/audio/{language_code}

  • Read

    Get Dubbed Transcript (deprecated)

    Returns transcript for the dub as an SRT or WEBVTT file.

    GET /v1/dubbing/{dubbing_id}/transcript/{language_code}

  • Read

    Retrieve A Transcript (deprecated)

    Fetch the transcript for one of the languages in a dub.

    GET /v1/dubbing/{dubbing_id}/transcripts/{language_code}/format/{format_type}

  • Write

    Add A Language To The Resource (deprecated)

    Adds the given ElevenLab Turbo V2/V2.5 language code to the resource. Does not automatically generate transcripts/translations/audio.

    POST /v1/dubbing/resource/{dubbing_id}/language

  • Write

    Create A Segment For The Speaker (deprecated)

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

    POST /v1/dubbing/resource/{dubbing_id}/speaker/{speaker_id}/segment

  • Write

    Modify A Single Segment (deprecated)

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

    PATCH /v1/dubbing/resource/{dubbing_id}/segment/{segment_id}/{language}

  • Write

    Move Segments Between Speakers (deprecated)

    Change the attribution of one or more segments to a different speaker.

    POST /v1/dubbing/resource/{dubbing_id}/migrate-segments

  • Write

    Transcribes Segments (deprecated)

    Regenerate the transcriptions for the specified segments. Does not automatically regenerate translations or dubs.

    POST /v1/dubbing/resource/{dubbing_id}/transcribe

  • Write

    Translates All Or Some Segments And Languages (deprecated)

    Regenerate the translations for either the entire resource or the specified segments/languages. Will automatically transcribe missing transcriptions. Will not automatically regenerate the dubs.

    POST /v1/dubbing/resource/{dubbing_id}/translate

  • Write

    Dubs All Or Some Segments And Languages (deprecated)

    Regenerate the dubs for either the entire resource or the specified segments/languages. Will automatically transcribe and translate any missing transcriptions and translations.

    POST /v1/dubbing/resource/{dubbing_id}/dub

  • Write

    Update Metadata For A Speaker (deprecated)

    Amend the metadata associated with a speaker, such as their voice. Both voice cloning and using voices from the ElevenLabs library are supported.

    PATCH /v1/dubbing/resource/{dubbing_id}/speaker/{speaker_id}

  • Write

    Create A New Speaker (deprecated)

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

    POST /v1/dubbing/resource/{dubbing_id}/speaker

  • Write

    Render Audio Or Video For The Given Language (deprecated)

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

    POST /v1/dubbing/resource/{dubbing_id}/render/{language}

  • Write

    Dub A Video Or An Audio File (deprecated)

    Dubs a provided audio or video file into given language.

    POST /v1/dubbing

  • Destructive

    Deletes A Single Segment (deprecated)

    Deletes a single segment from the dubbing.

    DELETE /v1/dubbing/resource/{dubbing_id}/segment/{segment_id}

  • Destructive

    Delete Dubbing (deprecated)

    Deletes a dubbing project.

    DELETE /v1/dubbing/{dubbing_id}

Other

  • Read

    Get Characters Usage Metrics (Deprecated) (deprecated)

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

    GET /v1/usage/character-stats

smb

  • Read

    Get All Services

    Get all services for the current workspace with optional filters

    GET /v1/smb/services

  • Read

    Get Service

    Get a specific service by ID

    GET /v1/smb/services/{service_id}

  • Read

    Get All Staff

    Get all staff for the current workspace

    GET /v1/smb/staff

  • Read

    Get Staff Member

    Get a specific staff member by ID

    GET /v1/smb/staff/{staff_id}

  • Read

    Get All Holidays

    Get all holidays/time-off entries for the current workspace with optional filters

    GET /v1/smb/holidays

  • Read

    Get Holiday

    Get a specific holiday by ID

    GET /v1/smb/holidays/{holiday_id}

  • Read

    List Locations

    List all business locations.

    GET /v1/smb/locations

  • Read

    Get Location

    Get a single location by ID.

    GET /v1/smb/locations/{location_id}

  • Read

    Get Agent Info

    Get all agent-affecting configuration with current workspace time

    GET /v1/smb/agent-info

  • Read

    List Knowledge Sources

    List all knowledge sources for the current workspace

    GET /v1/smb/knowledge-sources

  • Read

    Get Knowledge Source

    Get a specific knowledge source by ID

    GET /v1/smb/knowledge-sources/{source_id}

  • Read

    List Reseller Workspaces

    List workspaces attributed to the caller's reseller, with cursor-based pagination

    GET /v1/smb/reseller/workspaces

  • Read

    List Reseller Tier Ladder

    The reseller's live tier ladder, lowest rank first. The first entry is the trial. Without tier management the rest are the builtin tiers. Retired tiers are omitted

    GET /v1/smb/reseller/tier-ladder

  • Write

    Create Service

    Create a new service

    POST /v1/smb/services

  • Write

    Create Staff Member

    Create a new staff member

    POST /v1/smb/staff

  • Write

    Update Staff Member

    Update an existing staff member. Only the fields sent are changed.

    PUT /v1/smb/staff/{staff_id}

  • Write

    Create Holiday

    Create a new holiday

    POST /v1/smb/holidays

  • Write

    Update Holiday

    Update an existing holiday. Only the fields sent are changed.

    PUT /v1/smb/holidays/{holiday_id}

  • Write

    Create Location

    Add a new business location.

    POST /v1/smb/locations

  • Write

    Update Location

    Update an existing location. Only the fields sent are changed.

    PUT /v1/smb/locations/{location_id}

  • Write

    Update Agent Info

    Update all agent-affecting configuration (triggers agent regeneration)

    PUT /v1/smb/agent-info

  • Write

    Upload Knowledge Source

    Upload a file as a knowledge source

    POST /v1/smb/knowledge-sources

  • Write

    Add Url Source

    Add a URL as a knowledge source

    POST /v1/smb/knowledge-sources/urls

  • Write

    Provision Reseller Workspace

    Provision Reseller Workspace.

    POST /v1/smb/reseller/workspaces

  • Write

    Cancel Reseller Pending Downgrade

    Drop a scheduled downgrade, leaving the workspace on its current tier

    POST /v1/smb/reseller/workspaces/{workspace_id}/subscription/cancel-downgrade

  • Destructive

    Update Service

    Update an existing service. Only the fields sent are changed.

    PUT /v1/smb/services/{service_id}

  • Destructive

    Delete Service

    Delete a service

    DELETE /v1/smb/services/{service_id}

  • Destructive

    Confirm Service Update

    Save a service update after user confirmed price impact. Optionally reprice future events.

    POST /v1/smb/services/{service_id}/confirm-update

  • Destructive

    Delete Staff Member

    Delete a staff member

    DELETE /v1/smb/staff/{staff_id}

  • Destructive

    Delete Holiday

    Delete a holiday

    DELETE /v1/smb/holidays/{holiday_id}

  • Destructive

    Delete Location

    Delete a location.

    DELETE /v1/smb/locations/{location_id}

  • Destructive

    Delete Knowledge Source

    Delete a knowledge source

    DELETE /v1/smb/knowledge-sources/{source_id}

  • Destructive

    Assign Reseller Tier

    Subscribe a reseller-attributed workspace to one of the reseller's tiers

    POST /v1/smb/reseller/workspaces/{workspace_id}/subscription

  • Destructive

    Change Reseller Tier

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

    PATCH /v1/smb/reseller/workspaces/{workspace_id}/subscription

  • Destructive

    Unassign Reseller Tier

    End a reseller-attributed workspace's subscription at the end of the current billing period

    DELETE /v1/smb/reseller/workspaces/{workspace_id}/subscription

  • Destructive

    Restore Reseller Subscription

    Undo a pending unassignment so the subscription renews normally

    POST /v1/smb/reseller/workspaces/{workspace_id}/subscription/restore

See How connections work for access and permissions, or browse all integrations.

Reference date: October 29, 2026. ElevenLabs API docs.