elevenlabs-convai {
    --el-bg-color: rgb(var(--background-light));
    --el-text-color: rgb(var(--gray-700));
    --el-border-color: rgb(var(--gray-400) / 0.2);
    --el-border-radius: 0.75rem;
    --el-btn-color: rgb(var(--primary-dark));
    --el-btn-text-color: #fff;
    --el-btn-radius: 32px;
    --el-focus-color: rgb(var(--primary-light));
}

.dark elevenlabs-convai {
    --el-bg-color: rgb(var(--background-dark));
    --el-text-color: rgb(var(--gray-300));
    --el-border-color: rgb(var(--gray-800));
    --el-border-radius: 0.75rem;
    --el-btn-color: rgb(var(--primary-light) / 0.1);
    --el-btn-text-color: rgb(var(--primary-light));
    --el-btn-radius: 32px;
    --el-focus-color: rgb(var(--primary-light));
}


(function() {
  // Create and append the script element
  var script = document.createElement('script');
  script.src = "https://elevenlabs.io/convai-widget/index.js";
  script.async = true;
  script.type = "text/javascript";
  document.head.appendChild(script);

  // hide convai on mobile
  var wrapper = document.createElement('div');
  wrapper.className = "hidden lg:block";

  // Create and append the widget element
  var widget = document.createElement('elevenlabs-convai');
  widget.setAttribute('agent-id', 'OZmXb9pmFsSkDE5dukJv');
  widget.setAttribute('avatar-orb-color-1', '#4D9CFF');
  widget.setAttribute('avatar-orb-color-2', '#9CE6E6');
  widget.innerHTML = `\
  <form slot="terms" class="prose text-sm">
    <h3>Terms and conditions</h3>
    <p>
      By clicking "Continue," I agree to the Terms of Service, acknowledge
      ElevenLabs' Privacy Policy.
    </p>
    <p>
      <label class="flex gap-2">
        <input class="h-5" required="required" type="checkbox" />
        I consent to the recording, collection and use of my voice and data
        derived from my voice to interpret my speech and provide customer
        support services.
      </label>
    </p>
    <p>
      <label class="flex gap-2">
        <input class="h-5" required="required" type="checkbox" />
        I consent to sharing my voice and data derived from my voice with 
        third-party service providers to train and improve our customer 
        support models.
      </label>
    </p>
    <p>
      <label class="flex gap-2">
        <input class="h-5" required="required" type="checkbox" />
        I understand that if I do not consent to the collection as 
        described above, ElevenLabs services cannot be provided to 
        me.
      </label>
    </p>
  </form>`;
  
  // Append widget to wrapper, then wrapper to body
  wrapper.appendChild(widget);
  document.body.appendChild(wrapper);
})();


Contact sales

Community

Documentation

ElevenLabs

product

Product

API Reference

Developer Guides

Conversational AI

Changelog

Go to elevenlabs.io

Blog

Help Center

Get metadata for a pronunciation dictionary

Get dictionary by id

Location

Message

Error Type

ValidationError

GetPronunciationDictionaryMetadataResponseModel

HTTPValidationError

Get Metadata For A Pronunciation Dictionary

Explore our Guides and API Reference to get the most out of ElevenLabs.

Developer Guides and API Reference Introduction | ElevenLabs Docs

Introduction

A guide on how to generate voiceovers using your voice on ElevenLabs.

Text to Speech Overview | ElevenLabs Docs

Overview

Voice Selection

Voice Settings

Model Selection

Effective techniques to guide ElevenLabs AI in adding pauses, conveying emotions, and pacing the speech.

Prompting

A guide on using our voice changer tool for the most natural-sounding speech-to-speech conversion

Get the most out of our Sound Effects Generator tool and learn how to create everything from blockbuster sound design for films to everyday sounds for your video game.

Sound Effects Overview | ElevenLabs Docs

Sound Effects Overview

Discover all the voices ElevenLabs has to offer

A curated set of voices for our core use cases.

Default Voices

Generate a unique voice from a text prompt.

Voice Design

Voice Lab Overview | ElevenLabs Docs

Guide for getting the most out of you cloned voices.

Instant Voice Cloning

Guide to getting the highest quality voice clone available.

Professional Voice Cloning

Discover AI voices from the ElevenLabs community

Voice Library Overview | ElevenLabs Docs

Learn how to share voices in the Voice Library.

Sharing Voices

Step-by-step guide to creating the highest quality voice clone available

Step-by-step Guide

Earn rewards for sharing voices in the Voice Library

Payouts

Projects Overview | ElevenLabs Docs

Dubbing made easy: reach a broader audience with ElevenLabs.

Dubbing Overview | ElevenLabs Docs

The ultimate end-to-end workflow for creating amazing dubs.

Studio

Elevate your projects with this guide into the Voiceover Studio.

Voiceover Studio Overview

Audio Native Overview | ElevenLabs Docs

An overview on how teams can collaborate in a shared workspace.

An overview on how to setup SSO (Single Sign-On) for your team.

SSO Setup

General troubleshooting guide and overview for some issues we've seen.

Start generating your first text-to-speech using Python and ElevenLabs API

Quickstart

How to control the server location for your requests

Specifying Server Location

Seven methods for reducing streaming latency, in order of highest to lowest effectiveness:

Reducing Latency

Models

How to convert text into speech, upload to S3, and share with a signed URL

How to Use Text-to-Speech

How to use text to speech with streaming in Python or Node.js

How to convert text to speech via websocket and save to mp3

Streaming Text-to-Speech

How to use text-to-speech with websocket streaming in Python or Node.js

Learn how to keep your voice stable across multiple generations

Combine Multiple Generations

How to add, view, and remove rules to pronunciation dictionaries with the Python SDK

How to Use Pronunciation Dictionaries

Integrating with Twilio

How to send an AI message through a phone call using Twilio and ElevenLabs in Node.js

Learn how to use the text to sound effects API to generate sound effects from text.

How to Use the Text to Sound Effects API

Learn how to automate the dubbing of audio and video files into various languages using the ElevenLabs API

How to Dub a Video

How to dub video and audio with ElevenLabs

Project Examples

Authentication

Streaming

Node Library

Python Library

Postman Library

Convert text to speech using our library of over 3,000 voices across 32 languages.

Text to Speech

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

Text to Speech with Timing

Convert text to speech in real-time using our library of over 3,000 voices across 32 languages.

Text to Speech Stream

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

Text to Speech Stream with Timing

Websockets

Transform any voice recording using the Speech-to-Speech API. Maintain full control over emotion, timing and delivery.

Voice Changer

Transform any voice recording using the Speech-to-Speech Streaming API. Maintain full control over emotion, timing and delivery.

Voice Changer Stream

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

Text to Sound Effects

Audio Isolation

Audio Isolation Stream

Generate voices from a single text prompt.

Generate Voice Previews

Add a generated voice to the voice library.

Save Voice from Preview

Dubs provided audio or video file into given language.

Dub Video/Audio File

Returns transcript for the dub as an SRT file.

Transcript

Returns dubbed file as a streamed file. Videos will be returned in MP4 format and audio only dubs will be returned in MP3.

Dubbed File

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

Project

Returns metadata about all your generated audio.

Get Generated Items

Returns information about an history item by its ID.

Get History Item By Id

Delete History Item

Get Audio From History Item

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.

Download History Items

Delete Sample

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

Get Audio From Sample

Gets extended information about the users subscription

Get User Subscription Info

Get User Info

Gets a list of all available voices for a user.

Get Voices | ElevenLabs API Reference

Get Voices

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 Default 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 Voice Settings

Get Voice

Delete Voice

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.

Edit Voice Settings

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

Add Voice

Edit Voice

Get Voice Library Voices | ElevenLabs API Reference

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

Add Sharing Voice

Returns a list of your projects together and its metadata.

Get Projects

Returns information about a specific project. This endpoint returns more detailed information about a project than GET api.elevenlabs.io/v1/projects.

Get Project By Id

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

Add Project

Delete Project

Starts conversion of a project and all of its chapters.

Convert Project

Get Project Snapshots

Stream the audio from a project snapshot.

Stream Project Audio

Returns a list of your chapters for a project together and its metadata.

Get Chapters

Returns information about a specific chapter.

Get Chapter By Id

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

Add Chapter To A Project

Delete Chapter

Convert Chapter

Gets information about all the snapshots of a chapter, each snapshot corresponds can be downloaded as audio. Whenever a chapter is converted a snapshot will be automatically created.

Get Chapter Snapshots

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

Stream Chapter Audio

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

Update Pronunciation Dictionaries

Creates a new pronunciation dictionary from a lexicon .PLS file

Add from file

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

Get dictionaries

Add rules to the pronunciation dictionary

Add rules

Remove rules from the pronunciation dictionary

Remove rules

Get PLS file with a pronunciation dictionary version rules

Download version by id

Get Models

Creates AudioNative enabled project, optionally starts conversion and returns project id and embeddable html snippet.

Creates Audionative Enabled Project.

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

API Reference

SDK Libraries

Endpoints

Administration

Legacy

Get dictionary by id

Headers

Path Parameters

Response