Reference

History

client.history.getAll({ ...params }) -> ElevenLabs.GetSpeechHistoryResponse

📝 Description

Returns metadata about all your generated audio.

🔌 Usage

await client.history.getAll({
    page_size: 1,
    voice_id: "pMsXgVXv3BLzUgSXRplE",
});

⚙️ Parameters

request: ElevenLabs.HistoryGetAllRequest

requestOptions: History.RequestOptions

client.history.get(historyItemId) -> ElevenLabs.SpeechHistoryItemResponse

📝 Description

Returns information about an history item by its ID.

🔌 Usage

await client.history.get("ja9xsmfGhxYcymxGcOGB");

⚙️ Parameters

historyItemId: string — History item ID to be used, you can use GET https://api.elevenlabs.io/v1/history to receive a list of history items and their IDs.

requestOptions: History.RequestOptions

client.history.delete(historyItemId) -> unknown

📝 Description

Delete a history item by its ID

🔌 Usage

await client.history.delete("ja9xsmfGhxYcymxGcOGB");

⚙️ Parameters

historyItemId: string — History item ID to be used, you can use GET https://api.elevenlabs.io/v1/history to receive a list of history items and their IDs.

requestOptions: History.RequestOptions

client.history.getAudio(historyItemId) -> stream.Readable

📝 Description

Returns the audio of an history item.

🔌 Usage

await client.history.getAudio("ja9xsmfGhxYcymxGcOGB");

⚙️ Parameters

historyItemId: string — History item ID to be used, you can use GET https://api.elevenlabs.io/v1/history to receive a list of history items and their IDs.

requestOptions: History.RequestOptions

client.history.download({ ...params }) -> void

📝 Description

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.

🔌 Usage

await client.history.download({
    history_item_ids: ["ja9xsmfGhxYcymxGcOGB"],
});

⚙️ Parameters

request: ElevenLabs.DownloadHistoryRequest

requestOptions: History.RequestOptions

TextToSoundEffects

AudioIsolation

Samples

client.samples.delete(voiceId, sampleId) -> unknown

📝 Description

Removes a sample by its ID.

🔌 Usage

await client.samples.delete("ja9xsmfGhxYcymxGcOGB", "pMsXgVXv3BLzUgSXRplE");

⚙️ Parameters

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

sampleId: string — Sample ID to be used, you can use GET https://api.elevenlabs.io/v1/voices/{voice_id} to list all the available samples for a voice.

requestOptions: Samples.RequestOptions

client.samples.getAudio(voiceId, sampleId) -> stream.Readable

📝 Description

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

🔌 Usage

await client.samples.getAudio("ja9xsmfGhxYcymxGcOGB", "pMsXgVXv3BLzUgSXRplE");

⚙️ Parameters

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

sampleId: string — Sample ID to be used, you can use GET https://api.elevenlabs.io/v1/voices/{voice_id} to list all the available samples for a voice.

requestOptions: Samples.RequestOptions

TextToSpeech

client.textToSpeech.convert(voiceId, { ...params }) -> stream.Readable

📝 Description

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

🔌 Usage

await client.textToSpeech.convert("pMsXgVXv3BLzUgSXRplE", {
    optimize_streaming_latency: "0",
    output_format: "mp3_22050_32",
    text: "It sure does, Jackie\u2026 My mama always said: \u201CIn Carolina, the air's so thick you can wear it!\u201D",
    voice_settings: {
        stability: 0.5,
        similarity_boost: 0.75,
        style: 0,
    },
});

⚙️ Parameters

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

request: ElevenLabs.TextToSpeechRequest

requestOptions: TextToSpeech.RequestOptions

client.textToSpeech.convertWithTimestamps(voiceId, { ...params }) -> unknown

📝 Description

Converts text into speech using a voice of your choice and returns JSON containing audio as a base64 encoded string together with information on when which character was spoken.

🔌 Usage

await client.textToSpeech.convertWithTimestamps("21m00Tcm4TlvDq8ikWAM", {
    text: "text",
});

⚙️ Parameters

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

request: ElevenLabs.TextToSpeechWithTimestampsRequest

requestOptions: TextToSpeech.RequestOptions

client.textToSpeech.convertAsStream(voiceId, { ...params }) -> stream.Readable

📝 Description

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

🔌 Usage

await client.textToSpeech.convertAsStream("pMsXgVXv3BLzUgSXRplE", {
    optimize_streaming_latency: "0",
    output_format: "mp3_22050_32",
    text: "It sure does, Jackie\u2026 My mama always said: \u201CIn Carolina, the air's so thick you can wear it!\u201D",
    voice_settings: {
        stability: 0.1,
        similarity_boost: 0.3,
        style: 0.2,
    },
});

⚙️ Parameters

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

request: ElevenLabs.StreamTextToSpeechRequest

requestOptions: TextToSpeech.RequestOptions

client.textToSpeech.streamWithTimestamps(voiceId, { ...params }) -> void

📝 Description

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.

🔌 Usage

await client.textToSpeech.streamWithTimestamps("21m00Tcm4TlvDq8ikWAM", {
    text: "text",
});

⚙️ Parameters

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

request: ElevenLabs.StreamTextToSpeechWithTimstampsRequest

requestOptions: TextToSpeech.RequestOptions

SpeechToSpeech

VoiceGeneration

client.voiceGeneration.generateParameters() -> ElevenLabs.VoiceGenerationParameterResponse

📝 Description

Get possible parameters for the /v1/voice-generation/generate-voice endpoint.

🔌 Usage

await client.voiceGeneration.generateParameters();

⚙️ Parameters

requestOptions: VoiceGeneration.RequestOptions

client.voiceGeneration.generate({ ...params }) -> stream.Readable

📝 Description

Generate a random voice based on parameters. This method returns a generated_voice_id in the response header, and a sample of the voice in the body. If you like the generated voice call /v1/voice-generation/create-voice with the generated_voice_id to create the voice.

🔌 Usage

await client.voiceGeneration.generate({
    gender: "female",
    accent: "american",
    age: "middle_aged",
    accent_strength: 2,
    text: "It sure does, Jackie\u2026 My mama always said: \u201CIn Carolina, the air's so thick you can wear it!\u201D",
});

⚙️ Parameters

request: ElevenLabs.GenerateVoiceRequest

requestOptions: VoiceGeneration.RequestOptions

client.voiceGeneration.createAPreviouslyGeneratedVoice({ ...params }) -> ElevenLabs.Voice

📝 Description

Create a previously generated voice. This endpoint should be called after you fetched a generated_voice_id using /v1/voice-generation/generate-voice.

🔌 Usage

await client.voiceGeneration.createAPreviouslyGeneratedVoice({
    voice_name: "Alex",
    voice_description: "Middle-aged American woman",
    generated_voice_id: "rbVJFu6SGRD1dbWpKnWl",
});

⚙️ Parameters

request: ElevenLabs.CreatePreviouslyGenertedVoiceRequest

requestOptions: VoiceGeneration.RequestOptions

TextToVoice

client.textToVoice.createPreviews({ ...params }) -> ElevenLabs.VoicePreviewsResponseModel

📝 Description

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. If you like the a voice previewand want to create the voice call /v1/text-to-voice/create-voice-from-preview with the generated_voice_id to create the voice.

🔌 Usage

await client.textToVoice.createPreviews({
    voice_description: "A sassy little squeaky mouse",
    text: "Every act of kindness, no matter how small, carries value and can make a difference, as no gesture of goodwill is ever wasted.",
});

⚙️ Parameters

request: ElevenLabs.VoicePreviewsRequestModel

requestOptions: TextToVoice.RequestOptions

client.textToVoice.createVoiceFromPreview({ ...params }) -> ElevenLabs.Voice

📝 Description

Create a voice from previously generated voice preview. This endpoint should be called after you fetched a generated_voice_id using /v1/text-to-voice/create-previews.

🔌 Usage

await client.textToVoice.createVoiceFromPreview({
    voice_name: "Little squeaky mouse",
    voice_description: "A sassy little squeaky mouse",
    generated_voice_id: "37HceQefKmEi3bGovXjL",
});

⚙️ Parameters

request: ElevenLabs.BodyCreateANewVoiceFromVoicePreviewV1TextToVoiceCreateVoiceFromPreviewPost

requestOptions: TextToVoice.RequestOptions

User

client.user.getSubscription() -> ElevenLabs.Subscription

📝 Description

Gets extended information about the users subscription

🔌 Usage

await client.user.getSubscription();

⚙️ Parameters

requestOptions: User.RequestOptions

client.user.get() -> ElevenLabs.User

📝 Description

Gets information about the user

🔌 Usage

await client.user.get();

⚙️ Parameters

requestOptions: User.RequestOptions

voices

client.voices.getAll({ ...params }) -> ElevenLabs.GetVoicesResponse

📝 Description

Gets a list of all available voices for a user.

🔌 Usage

await client.voices.getAll();

⚙️ Parameters

request: ElevenLabs.VoicesGetAllRequest

requestOptions: Voices.RequestOptions

client.voices.getDefaultSettings() -> ElevenLabs.VoiceSettings

📝 Description

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.

🔌 Usage

await client.voices.getDefaultSettings();

⚙️ Parameters

requestOptions: Voices.RequestOptions

client.voices.getSettings(voiceId) -> ElevenLabs.VoiceSettings

📝 Description

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.

🔌 Usage

await client.voices.getSettings("2EiwWnXFnvU5JabPnv8n");

⚙️ Parameters

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

requestOptions: Voices.RequestOptions

client.voices.get(voiceId, { ...params }) -> ElevenLabs.Voice

📝 Description

Returns metadata about a specific voice.

🔌 Usage

await client.voices.get("29vD33N1CtxCmqQRPOHJ");

⚙️ Parameters

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

request: ElevenLabs.VoicesGetRequest

requestOptions: Voices.RequestOptions

client.voices.delete(voiceId) -> unknown

📝 Description

Deletes a voice by its ID.

🔌 Usage

await client.voices.delete("29vD33N1CtxCmqQRPOHJ");

⚙️ Parameters

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

requestOptions: Voices.RequestOptions

client.voices.editSettings(voiceId, { ...params }) -> unknown

📝 Description

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.

🔌 Usage

await client.voices.editSettings("29vD33N1CtxCmqQRPOHJ", {
    stability: 0.1,
    similarity_boost: 0.3,
    style: 0.2,
});

⚙️ Parameters

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

request: ElevenLabs.VoiceSettings

requestOptions: Voices.RequestOptions

client.voices.add({ ...params }) -> ElevenLabs.AddVoiceIvcResponseModel

📝 Description

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

🔌 Usage

await client.voices.add({
    files: [fs.createReadStream("/path/to/your/file")],
    name: "Alex",
});

⚙️ Parameters

request: ElevenLabs.BodyAddVoiceV1VoicesAddPost

requestOptions: Voices.RequestOptions

client.voices.edit(voiceId, { ...params }) -> unknown

📝 Description

Edit a voice created by you.

🔌 Usage

await client.voices.edit("JBFqnCBsd6RMkjVDRZzb", {
    name: "George",
});

⚙️ Parameters

voiceId: string

request: ElevenLabs.BodyEditVoiceV1VoicesVoiceIdEditPost

requestOptions: Voices.RequestOptions

client.voices.addSharingVoice(publicUserId, voiceId, { ...params }) -> ElevenLabs.AddVoiceResponseModel

📝 Description

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

🔌 Usage

await client.voices.addSharingVoice(
    "63e84100a6bf7874ba37a1bab9a31828a379ec94b891b401653b655c5110880f",
    "sB1b5zUrxQVAFl2PhZFp",
    {
        new_name: "Alita",
    }
);

⚙️ Parameters

publicUserId: string — Public user ID used to publicly identify ElevenLabs users.

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

request: ElevenLabs.AddSharingVoiceRequest

requestOptions: Voices.RequestOptions

client.voices.getShared({ ...params }) -> ElevenLabs.GetLibraryVoicesResponse

📝 Description

Gets a list of shared voices.

🔌 Usage

await client.voices.getShared({
    page_size: 1,
    gender: "female",
    language: "en",
});

⚙️ Parameters

request: ElevenLabs.VoicesGetSharedRequest

requestOptions: Voices.RequestOptions

client.voices.getSimilarLibraryVoices({ ...params }) -> ElevenLabs.GetLibraryVoicesResponse

📝 Description

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.

🔌 Usage

await client.voices.getSimilarLibraryVoices({});

⚙️ Parameters

request: ElevenLabs.BodyGetSimilarLibraryVoicesV1SimilarVoicesPost

requestOptions: Voices.RequestOptions

client.voices.getAProfilePage(handle) -> ElevenLabs.ProfilePageResponseModel

📝 Description

Gets a profile page based on a handle

🔌 Usage

await client.voices.getAProfilePage("talexgeorge");

⚙️ Parameters

handle: string — Handle for a VA's profile page

requestOptions: Voices.RequestOptions

Projects

client.projects.getAll() -> ElevenLabs.GetProjectsResponse

📝 Description

Returns a list of your projects together and its metadata.

🔌 Usage

await client.projects.getAll();

⚙️ Parameters

requestOptions: Projects.RequestOptions

client.projects.add({ ...params }) -> ElevenLabs.AddProjectResponseModel

📝 Description

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

🔌 Usage

await client.projects.add({
    name: "name",
    default_title_voice_id: "default_title_voice_id",
    default_paragraph_voice_id: "default_paragraph_voice_id",
    default_model_id: "default_model_id",
});

⚙️ Parameters

request: ElevenLabs.BodyAddProjectV1ProjectsAddPost

requestOptions: Projects.RequestOptions

client.projects.get(projectId) -> ElevenLabs.ProjectExtendedResponseModel

📝 Description

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

🔌 Usage

await client.projects.get("21m00Tcm4TlvDq8ikWAM");

⚙️ Parameters

projectId: string — The project_id of the project, you can query GET https://api.elevenlabs.io/v1/projects to list all available projects.

requestOptions: Projects.RequestOptions

client.projects.editBasicProjectInfo(projectId, { ...params }) -> ElevenLabs.EditProjectResponseModel

📝 Description

Edits basic project info.

🔌 Usage

await client.projects.editBasicProjectInfo("21m00Tcm4TlvDq8ikWAM", {
    name: "name",
    default_title_voice_id: "default_title_voice_id",
    default_paragraph_voice_id: "default_paragraph_voice_id",
});

⚙️ Parameters

projectId: string — The project_id of the project, you can query GET https://api.elevenlabs.io/v1/projects to list all available projects.

request: ElevenLabs.BodyEditBasicProjectInfoV1ProjectsProjectIdPost

requestOptions: Projects.RequestOptions

client.projects.delete(projectId) -> unknown

📝 Description

Delete a project by its project_id.

🔌 Usage

await client.projects.delete("21m00Tcm4TlvDq8ikWAM");

⚙️ Parameters

projectId: string — The project_id of the project, you can query GET https://api.elevenlabs.io/v1/projects to list all available projects.

requestOptions: Projects.RequestOptions

client.projects.convert(projectId) -> unknown

📝 Description

Starts conversion of a project and all of its chapters.

🔌 Usage

await client.projects.convert("21m00Tcm4TlvDq8ikWAM");

⚙️ Parameters

projectId: string — The project_id of the project, you can query GET https://api.elevenlabs.io/v1/projects to list all available projects.

requestOptions: Projects.RequestOptions

client.projects.getSnapshots(projectId) -> ElevenLabs.ProjectSnapshotsResponse

📝 Description

Gets the snapshots of a project.

🔌 Usage

await client.projects.getSnapshots("21m00Tcm4TlvDq8ikWAM");

⚙️ Parameters

projectId: string — The project_id of the project, you can query GET https://api.elevenlabs.io/v1/projects to list all available projects.

requestOptions: Projects.RequestOptions

client.projects.streamArchive(projectId, projectSnapshotId) -> void

📝 Description

Streams archive with project audio.

🔌 Usage

await client.projects.streamArchive("21m00Tcm4TlvDq8ikWAM", "21m00Tcm4TlvDq8ikWAM");

⚙️ Parameters

projectId: string — The project_id of the project, you can query GET https://api.elevenlabs.io/v1/projects to list all available projects.

projectSnapshotId: string — The project_snapshot_id of the project snapshot. You can query GET /v1/projects/{project_id}/snapshots to list all available snapshots for a project.

requestOptions: Projects.RequestOptions

client.projects.addChapterToAProject(projectId, { ...params }) -> ElevenLabs.AddChapterResponseModel

📝 Description

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

🔌 Usage

await client.projects.addChapterToAProject("21m00Tcm4TlvDq8ikWAM", {
    name: "name",
});

⚙️ Parameters

projectId: string — The project_id of the project, you can query GET https://api.elevenlabs.io/v1/projects to list all available projects.

request: ElevenLabs.BodyAddChapterToAProjectV1ProjectsProjectIdChaptersAddPost

requestOptions: Projects.RequestOptions

client.projects.updatePronunciationDictionaries(projectId, { ...params }) -> unknown

📝 Description

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.

🔌 Usage

await client.projects.updatePronunciationDictionaries("21m00Tcm4TlvDq8ikWAM", {
    pronunciation_dictionary_locators: [
        {
            pronunciation_dictionary_id: "pronunciation_dictionary_id",
            version_id: "version_id",
        },
    ],
});

⚙️ Parameters

projectId: string — The project_id of the project, you can query GET https://api.elevenlabs.io/v1/projects to list all available projects.

request: ElevenLabs.UpdatePronunciationDictionariesRequest

requestOptions: Projects.RequestOptions

Chapters

client.chapters.getAll(projectId) -> ElevenLabs.GetChaptersResponse

📝 Description

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

🔌 Usage

await client.chapters.getAll("21m00Tcm4TlvDq8ikWAM");

⚙️ Parameters

projectId: string — The project_id of the project, you can query GET https://api.elevenlabs.io/v1/projects to list all available projects.

requestOptions: Chapters.RequestOptions

client.chapters.get(projectId, chapterId) -> ElevenLabs.ChapterResponse

📝 Description

Returns information about a specific chapter.

🔌 Usage

await client.chapters.get("21m00Tcm4TlvDq8ikWAM", "21m00Tcm4TlvDq8ikWAM");

⚙️ Parameters

projectId: string — The project_id of the project, you can query GET https://api.elevenlabs.io/v1/projects to list all available projects.

chapterId: string — The chapter_id of the chapter. You can query GET https://api.elevenlabs.io/v1/projects/{project_id}/chapters to list all available chapters for a project.

requestOptions: Chapters.RequestOptions

client.chapters.delete(projectId, chapterId) -> unknown

📝 Description

Delete a chapter by its chapter_id.

🔌 Usage

await client.chapters.delete("21m00Tcm4TlvDq8ikWAM", "21m00Tcm4TlvDq8ikWAM");

⚙️ Parameters

projectId: string — The project_id of the project, you can query GET https://api.elevenlabs.io/v1/projects to list all available projects.

chapterId: string — The chapter_id of the chapter. You can query GET https://api.elevenlabs.io/v1/projects/{project_id}/chapters to list all available chapters for a project.

requestOptions: Chapters.RequestOptions

client.chapters.convert(projectId, chapterId) -> unknown

📝 Description

Starts conversion of a specific chapter.

🔌 Usage

await client.chapters.convert("21m00Tcm4TlvDq8ikWAM", "21m00Tcm4TlvDq8ikWAM");

⚙️ Parameters

projectId: string — The project_id of the project, you can query GET https://api.elevenlabs.io/v1/projects to list all available projects.

chapterId: string — The chapter_id of the chapter. You can query GET https://api.elevenlabs.io/v1/projects/{project_id}/chapters to list all available chapters for a project.

requestOptions: Chapters.RequestOptions

client.chapters.getAllSnapshots(projectId, chapterId) -> ElevenLabs.ChapterSnapshotsResponse

📝 Description

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.

🔌 Usage

await client.chapters.getAllSnapshots("21m00Tcm4TlvDq8ikWAM", "21m00Tcm4TlvDq8ikWAM");

⚙️ Parameters

projectId: string — The project_id of the project, you can query GET https://api.elevenlabs.io/v1/projects to list all available projects.

chapterId: string — The chapter_id of the chapter. You can query GET https://api.elevenlabs.io/v1/projects/{project_id}/chapters to list all available chapters for a project.

requestOptions: Chapters.RequestOptions

client.chapters.streamSnapshot(projectId, chapterId, chapterSnapshotId, { ...params }) -> void

📝 Description

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.

🔌 Usage

await client.chapters.streamSnapshot("21m00Tcm4TlvDq8ikWAM", "21m00Tcm4TlvDq8ikWAM", "21m00Tcm4TlvDq8ikWAM");

⚙️ Parameters

projectId: string — The project_id of the project, you can query GET https://api.elevenlabs.io/v1/projects to list all available projects.

chapterId: string — The chapter_id of the chapter. You can query GET https://api.elevenlabs.io/v1/projects/{project_id}/chapters to list all available chapters for a project.

chapterSnapshotId: string — The chapter_snapshot_id of the chapter snapshot. You can query GET /v1/projects/{project_id}/chapters/{chapter_id}/snapshots to the all available snapshots for a chapter.

request: ElevenLabs.BodyStreamChapterAudioV1ProjectsProjectIdChaptersChapterIdSnapshotsChapterSnapshotIdStreamPost

requestOptions: Chapters.RequestOptions

Dubbing

client.dubbing.dubAVideoOrAnAudioFile({ ...params }) -> ElevenLabs.DoDubbingResponse

📝 Description

Dubs provided audio or video file into given language.

🔌 Usage

await client.dubbing.dubAVideoOrAnAudioFile({
    target_lang: "target_lang",
});

⚙️ Parameters

request: ElevenLabs.BodyDubAVideoOrAnAudioFileV1DubbingPost

requestOptions: Dubbing.RequestOptions

client.dubbing.getDubbingProjectMetadata(dubbingId) -> ElevenLabs.DubbingMetadataResponse

📝 Description

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

🔌 Usage

await client.dubbing.getDubbingProjectMetadata("dubbing_id");

⚙️ Parameters

dubbingId: string — ID of the dubbing project.

requestOptions: Dubbing.RequestOptions

client.dubbing.deleteDubbingProject(dubbingId) -> unknown

📝 Description

Deletes a dubbing project.

🔌 Usage

await client.dubbing.deleteDubbingProject("dubbing_id");

⚙️ Parameters

dubbingId: string — ID of the dubbing project.

requestOptions: Dubbing.RequestOptions

client.dubbing.getTranscriptForDub(dubbingId, languageCode, { ...params }) -> unknown

📝 Description

Returns transcript for the dub as an SRT file.

🔌 Usage

await client.dubbing.getTranscriptForDub("dubbing_id", "language_code");

⚙️ Parameters

dubbingId: string — ID of the dubbing project.

languageCode: string — ID of the language.

request: ElevenLabs.GetTranscriptForDubV1DubbingDubbingIdTranscriptLanguageCodeGetRequest

requestOptions: Dubbing.RequestOptions

Models

client.models.getAll() -> ElevenLabs.Model[]

📝 Description

Gets a list of available models.

🔌 Usage

await client.models.getAll();

⚙️ Parameters

requestOptions: Models.RequestOptions

AudioNative

client.audioNative.create({ ...params }) -> ElevenLabs.AudioNativeCreateProjectResponseModel

📝 Description

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

🔌 Usage

await client.audioNative.create({
    name: "name",
});

⚙️ Parameters

request: ElevenLabs.BodyCreatesAudioNativeEnabledProjectV1AudioNativePost

requestOptions: AudioNative.RequestOptions

Usage

client.usage.getCharactersUsageMetrics({ ...params }) -> ElevenLabs.UsageCharactersResponseModel

📝 Description

Returns the credit usage metrics for the current user or the entire workspace they are part of. The response will return a time axis with unix timestamps for each day and daily usage along that axis. The usage will be broken down by the specified breakdown type. For example, breakdown type "voice" will return the usage of each voice along the time axis.

🔌 Usage

await client.usage.getCharactersUsageMetrics({
    start_unix: 1,
    end_unix: 1,
});

⚙️ Parameters

request: ElevenLabs.UsageGetCharactersUsageMetricsRequest

requestOptions: Usage.RequestOptions

PronunciationDictionary

client.pronunciationDictionary.addFromFile({ ...params }) -> ElevenLabs.AddPronunciationDictionaryResponseModel

📝 Description

Creates a new pronunciation dictionary from a lexicon .PLS file

🔌 Usage

await client.pronunciationDictionary.addFromFile({
    name: "name",
});

⚙️ Parameters

request: ElevenLabs.BodyAddAPronunciationDictionaryV1PronunciationDictionariesAddFromFilePost

requestOptions: PronunciationDictionary.RequestOptions

client.pronunciationDictionary.addRulesToThePronunciationDictionary(pronunciationDictionaryId, { ...params }) -> ElevenLabs.AddPronunciationDictionaryRulesResponseModel

📝 Description

Add rules to the pronunciation dictionary

🔌 Usage

await client.pronunciationDictionary.addRulesToThePronunciationDictionary("21m00Tcm4TlvDq8ikWAM", {
    rules: [
        {
            type: "phoneme",
            string_to_replace: "rules",
            phoneme: "rules",
            alphabet: "rules",
        },
    ],
});

⚙️ Parameters

pronunciationDictionaryId: string — The id of the pronunciation dictionary

request: ElevenLabs.PronunciationDictionary

requestOptions: PronunciationDictionary.RequestOptions

client.pronunciationDictionary.removeRulesFromThePronunciationDictionary(pronunciationDictionaryId, { ...params }) -> ElevenLabs.RemovePronunciationDictionaryRulesResponseModel

📝 Description

Remove rules from the pronunciation dictionary

🔌 Usage

await client.pronunciationDictionary.removeRulesFromThePronunciationDictionary("21m00Tcm4TlvDq8ikWAM", {
    rule_strings: ["rule_strings"],
});

⚙️ Parameters

pronunciationDictionaryId: string — The id of the pronunciation dictionary

request: ElevenLabs.BodyRemoveRulesFromThePronunciationDictionaryV1PronunciationDictionariesPronunciationDictionaryIdRemoveRulesPost

requestOptions: PronunciationDictionary.RequestOptions

client.pronunciationDictionary.download(dictionaryId, versionId) -> string

📝 Description

Get PLS file with a pronunciation dictionary version rules

🔌 Usage

await client.pronunciationDictionary.download("Fm6AvNgS53NXe6Kqxp3e", "KZFyRUq3R6kaqhKI146w");

⚙️ Parameters

dictionaryId: string — The id of the pronunciation dictionary

versionId: string — The id of the version of the pronunciation dictionary

requestOptions: PronunciationDictionary.RequestOptions

client.pronunciationDictionary.get(pronunciationDictionaryId) -> ElevenLabs.GetPronunciationDictionaryMetadataResponse

📝 Description

Get metadata for a pronunciation dictionary

🔌 Usage

await client.pronunciationDictionary.get("Fm6AvNgS53NXe6Kqxp3e");

⚙️ Parameters

pronunciationDictionaryId: string — The id of the pronunciation dictionary

requestOptions: PronunciationDictionary.RequestOptions

client.pronunciationDictionary.getAll({ ...params }) -> ElevenLabs.GetPronunciationDictionariesMetadataResponseModel

📝 Description

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

🔌 Usage

await client.pronunciationDictionary.getAll({
    page_size: 1,
});

⚙️ Parameters

request: ElevenLabs.PronunciationDictionaryGetAllRequest

requestOptions: PronunciationDictionary.RequestOptions

Workspace

client.workspace.inviteUser({ ...params }) -> unknown

📝 Description

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.

🔌 Usage

await client.workspace.inviteUser({
    email: "email",
});

⚙️ Parameters

request: ElevenLabs.BodyInviteUserV1WorkspaceInvitesAddPost

requestOptions: Workspace.RequestOptions

client.workspace.deleteExistingInvitation({ ...params }) -> unknown

📝 Description

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

🔌 Usage

await client.workspace.deleteExistingInvitation({
    email: "email",
});

⚙️ Parameters

request: ElevenLabs.BodyDeleteExistingInvitationV1WorkspaceInvitesDelete

requestOptions: Workspace.RequestOptions

client.workspace.updateMember({ ...params }) -> unknown

📝 Description

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.

🔌 Usage

await client.workspace.updateMember({
    email: "email",
});

⚙️ Parameters

request: ElevenLabs.BodyUpdateMemberV1WorkspaceMembersPost

requestOptions: Workspace.RequestOptions

ConversationalAi

client.conversationalAi.getSignedUrl({ ...params }) -> ElevenLabs.ConversationSignedUrlResponseModel

📝 Description

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

🔌 Usage

await client.conversationalAi.getSignedUrl({
    agent_id: "21m00Tcm4TlvDq8ikWAM",
});

⚙️ Parameters

request: ElevenLabs.ConversationalAiGetSignedUrlRequest

requestOptions: ConversationalAi.RequestOptions

client.conversationalAi.createAgent({ ...params }) -> ElevenLabs.CreateAgentResponseModel

📝 Description

Create an agent from a config object

🔌 Usage

await client.conversationalAi.createAgent({
    conversation_config: {},
});

⚙️ Parameters

request: ElevenLabs.BodyCreateAgentV1ConvaiAgentsCreatePost

requestOptions: ConversationalAi.RequestOptions

client.conversationalAi.getAgent(agentId) -> ElevenLabs.GetAgentResponseModel

📝 Description

Retrieve config for an agent

🔌 Usage

await client.conversationalAi.getAgent("21m00Tcm4TlvDq8ikWAM");

⚙️ Parameters

agentId: string — The id of an agent. This is returned on agent creation.

requestOptions: ConversationalAi.RequestOptions

client.conversationalAi.deleteAgent(agentId) -> Record

📝 Description

Delete an agent

🔌 Usage

await client.conversationalAi.deleteAgent("21m00Tcm4TlvDq8ikWAM");

⚙️ Parameters

agentId: string — The id of an agent. This is returned on agent creation.

requestOptions: ConversationalAi.RequestOptions

client.conversationalAi.updateAgent(agentId, { ...params }) -> ElevenLabs.GetAgentResponseModel

📝 Description

Patches an Agent settings

🔌 Usage

await client.conversationalAi.updateAgent("21m00Tcm4TlvDq8ikWAM");

⚙️ Parameters

agentId: string — The id of an agent. This is returned on agent creation.

request: ElevenLabs.BodyPatchesAnAgentSettingsV1ConvaiAgentsAgentIdPatch

requestOptions: ConversationalAi.RequestOptions

client.conversationalAi.getWidget(agentId, { ...params }) -> ElevenLabs.GetAgentEmbedResponseModel

📝 Description

Retrieve the widget configuration for an agent

🔌 Usage

await client.conversationalAi.getWidget("21m00Tcm4TlvDq8ikWAM");

⚙️ Parameters

agentId: string — The id of an agent. This is returned on agent creation.

request: ElevenLabs.ConversationalAiGetWidgetRequest

requestOptions: ConversationalAi.RequestOptions

client.conversationalAi.getLink(agentId) -> ElevenLabs.GetAgentLinkResponseModel

📝 Description

Get the current link used to share the agent with others

🔌 Usage

await client.conversationalAi.getLink("21m00Tcm4TlvDq8ikWAM");

⚙️ Parameters

agentId: string — The id of an agent. This is returned on agent creation.

requestOptions: ConversationalAi.RequestOptions

client.conversationalAi.postAvatar(agentId, { ...params }) -> ElevenLabs.PostAgentAvatarResponseModel

📝 Description

Sets the avatar for an agent displayed in the widget

🔌 Usage

await client.conversationalAi.postAvatar("21m00Tcm4TlvDq8ikWAM", {
    avatar_file: fs.createReadStream("/path/to/your/file"),
});

⚙️ Parameters

agentId: string

request: ElevenLabs.BodyPostAgentAvatarV1ConvaiAgentsAgentIdAvatarPost

requestOptions: ConversationalAi.RequestOptions

client.conversationalAi.getKnowledgeBaseDocument(agentId, documentationId) -> ElevenLabs.GetKnowledgeBaseReponseModel

📝 Description

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

🔌 Usage

await client.conversationalAi.getKnowledgeBaseDocument("21m00Tcm4TlvDq8ikWAM", "21m00Tcm4TlvDq8ikWAM");

⚙️ Parameters

agentId: string — The id of an agent. This is returned on agent creation.

documentationId: string — The id of a document from the agent's knowledge base. This is returned on document addition.

requestOptions: ConversationalAi.RequestOptions

client.conversationalAi.addAgentSecret(agentId, { ...params }) -> ElevenLabs.AddAgentSecretResponseModel

📝 Description

Uploads a file or reference a webpage for the agent to use as part of it's knowledge base

🔌 Usage

await client.conversationalAi.addAgentSecret("21m00Tcm4TlvDq8ikWAM", {
    name: "name",
    secret_value: "secret_value",
});

⚙️ Parameters

agentId: string — The id of an agent. This is returned on agent creation.

request: ElevenLabs.BodyAddASecretToTheAgentWhichCanBeReferencedInToolCallsV1ConvaiAgentsAgentIdAddSecretPost

requestOptions: ConversationalAi.RequestOptions

client.conversationalAi.createKnowledgeBaseDocument(agentId, { ...params }) -> ElevenLabs.AddKnowledgeBaseResponseModel

📝 Description

Uploads a file or reference a webpage for the agent to use as part of it's knowledge base

🔌 Usage

await client.conversationalAi.createKnowledgeBaseDocument("21m00Tcm4TlvDq8ikWAM", {});

⚙️ Parameters

agentId: string

request: ElevenLabs.BodyAddToAgentSKnowledgeBaseV1ConvaiAgentsAgentIdAddToKnowledgeBasePost

requestOptions: ConversationalAi.RequestOptions

client.conversationalAi.getAgents({ ...params }) -> ElevenLabs.GetAgentsPageResponseModel

📝 Description

Returns a page of your agents and their metadata.

🔌 Usage

await client.conversationalAi.getAgents();

⚙️ Parameters

request: ElevenLabs.ConversationalAiGetAgentsRequest

requestOptions: ConversationalAi.RequestOptions

client.conversationalAi.getConversations({ ...params }) -> ElevenLabs.GetConversationsPageResponseModel

📝 Description

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

🔌 Usage

await client.conversationalAi.getConversations({
    agent_id: "21m00Tcm4TlvDq8ikWAM",
});

⚙️ Parameters

request: ElevenLabs.ConversationalAiGetConversationsRequest

requestOptions: ConversationalAi.RequestOptions

client.conversationalAi.getConversation(conversationId) -> ElevenLabs.GetConversationResponseModel

📝 Description

Get the details of a particular conversation

🔌 Usage

await client.conversationalAi.getConversation("21m00Tcm4TlvDq8ikWAM");

⚙️ Parameters

conversationId: string — The id of the conversation you're taking the action on.

requestOptions: ConversationalAi.RequestOptions

client.conversationalAi.getConversationAudio(conversationId) -> void

📝 Description

Get the audio recording of a particular conversation

🔌 Usage

await client.conversationalAi.getConversationAudio("21m00Tcm4TlvDq8ikWAM");

⚙️ Parameters

conversationId: string — The id of the conversation you're taking the action on.

requestOptions: ConversationalAi.RequestOptions

Files

reference.md

Latest commit

History

reference.md

File metadata and controls

Reference

History

📝 Description

🔌 Usage

⚙️ Parameters

📝 Description

🔌 Usage

⚙️ Parameters

📝 Description

🔌 Usage

⚙️ Parameters

📝 Description

🔌 Usage

⚙️ Parameters

📝 Description

🔌 Usage

⚙️ Parameters

TextToSoundEffects

AudioIsolation

Samples

📝 Description

🔌 Usage

⚙️ Parameters

📝 Description

🔌 Usage

⚙️ Parameters

TextToSpeech

📝 Description

🔌 Usage

⚙️ Parameters

📝 Description

🔌 Usage

⚙️ Parameters

📝 Description

🔌 Usage

⚙️ Parameters

📝 Description

🔌 Usage

⚙️ Parameters

SpeechToSpeech

VoiceGeneration

📝 Description

🔌 Usage

⚙️ Parameters

📝 Description

🔌 Usage

⚙️ Parameters

📝 Description

🔌 Usage

⚙️ Parameters

TextToVoice

📝 Description

🔌 Usage

⚙️ Parameters

📝 Description

🔌 Usage

⚙️ Parameters

User

📝 Description

🔌 Usage

⚙️ Parameters

📝 Description

🔌 Usage

⚙️ Parameters

voices

📝 Description

🔌 Usage

⚙️ Parameters

📝 Description

🔌 Usage

⚙️ Parameters

📝 Description

🔌 Usage

⚙️ Parameters