# Reference ## History
client.history.getAll({ ...params }) -> ElevenLabs.GetSpeechHistoryResponse
#### 📝 Description
Returns a list of your generated audio.
#### 🔌 Usage
```typescript await client.history.getAll(); ```
#### ⚙️ Parameters
**request:** `ElevenLabs.HistoryGetAllRequest`
**requestOptions:** `History.RequestOptions`
client.history.get(historyItemId) -> ElevenLabs.SpeechHistoryItemResponse
#### 📝 Description
Retrieves a history item.
#### 🔌 Usage
```typescript await client.history.get("VW7YKqPnjY4h39yTbx2L"); ```
#### ⚙️ Parameters
**historyItemId:** `string` — ID of the history item to be used. You can use the [Get generated items](/docs/api-reference/history/get-all) endpoint to retrieve a list of history items.
**requestOptions:** `History.RequestOptions`
client.history.delete(historyItemId) -> ElevenLabs.DeleteHistoryItemResponse
#### 📝 Description
Delete a history item by its ID
#### 🔌 Usage
```typescript await client.history.delete("VW7YKqPnjY4h39yTbx2L"); ```
#### ⚙️ Parameters
**historyItemId:** `string` — ID of the history item to be used. You can use the [Get generated items](/docs/api-reference/history/get-all) endpoint to retrieve a list of history items.
**requestOptions:** `History.RequestOptions`
## TextToSoundEffects
client.textToSoundEffects.convert({ ...params }) -> stream.Readable
#### 📝 Description
Turn text into sound effects for your videos, voice-overs or video games using the most advanced sound effects model in the world.
#### 🔌 Usage
```typescript await client.textToSoundEffects.convert({ text: "Spacious braam suitable for high-impact movie trailer moments", }); ```
#### ⚙️ Parameters
**request:** `ElevenLabs.CreateSoundEffectRequest`
**requestOptions:** `TextToSoundEffects.RequestOptions`
## AudioIsolation ## Samples
client.samples.delete(voiceId, sampleId) -> ElevenLabs.DeleteSampleResponse
#### 📝 Description
Removes a sample by its ID.
#### 🔌 Usage
```typescript await client.samples.delete("21m00Tcm4TlvDq8ikWAM", "VW7YKqPnjY4h39yTbx2L"); ```
#### ⚙️ Parameters
**voiceId:** `string` — ID of the voice to be used. You can use the [Get voices](/docs/api-reference/voices/search) endpoint list all the available voices.
**sampleId:** `string` — ID of the sample to be used. You can use the [Get voices](/docs/api-reference/voices/get) endpoint 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
```typescript await client.textToSpeech.convert("JBFqnCBsd6RMkjVDRZzb", { output_format: "mp3_44100_128", text: "The first move is what sets everything in motion.", model_id: "eleven_multilingual_v2", }); ```
#### ⚙️ Parameters
**voiceId:** `string` — ID of the voice to be used. Use the [Get voices](/docs/api-reference/voices/search) endpoint list all the available voices.
**request:** `ElevenLabs.TextToSpeechRequest`
**requestOptions:** `TextToSpeech.RequestOptions`
client.textToSpeech.convertWithTimestamps(voiceId, { ...params }) -> ElevenLabs.AudioWithTimestampsResponse
#### 📝 Description
Generate speech from text with precise character-level timing information for audio-text synchronization.
#### 🔌 Usage
```typescript await client.textToSpeech.convertWithTimestamps("21m00Tcm4TlvDq8ikWAM", { text: "This is a test for the API of ElevenLabs.", }); ```
#### ⚙️ 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
```typescript await client.textToSpeech.convertAsStream("JBFqnCBsd6RMkjVDRZzb", { output_format: "mp3_44100_128", text: "The first move is what sets everything in motion.", model_id: "eleven_multilingual_v2", }); ```
#### ⚙️ Parameters
**voiceId:** `string` — ID of the voice to be used. Use the [Get voices](/docs/api-reference/voices/search) endpoint list all the available voices.
**request:** `ElevenLabs.StreamTextToSpeechRequest`
**requestOptions:** `TextToSpeech.RequestOptions`
client.textToSpeech.streamWithTimestamps(voiceId, { ...params }) -> core.Stream
#### 📝 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
```typescript const response = await client.textToSpeech.streamWithTimestamps("JBFqnCBsd6RMkjVDRZzb", { output_format: "mp3_44100_128", text: "The first move is what sets everything in motion.", model_id: "eleven_multilingual_v2", }); for await (const item of response) { console.log(item); } ```
#### ⚙️ Parameters
**voiceId:** `string` — ID of the voice to be used. Use the [Get voices](/docs/api-reference/voices/search) endpoint list all the available voices.
**request:** `ElevenLabs.StreamTextToSpeechWithTimestampsRequest`
**requestOptions:** `TextToSpeech.RequestOptions`
## SpeechToSpeech
client.speechToSpeech.convert(voiceId, { ...params }) -> stream.Readable
#### 📝 Description
Transform audio from one voice to another. Maintain full control over emotion, timing and delivery.
#### 🔌 Usage
```typescript await client.speechToSpeech.convert("JBFqnCBsd6RMkjVDRZzb", { audio: fs.createReadStream("/path/to/your/file"), output_format: "mp3_44100_128", model_id: "eleven_multilingual_sts_v2", }); ```
#### ⚙️ Parameters
**voiceId:** `string`
**request:** `ElevenLabs.BodySpeechToSpeechV1SpeechToSpeechVoiceIdPost`
**requestOptions:** `SpeechToSpeech.RequestOptions`
client.speechToSpeech.convertAsStream(voiceId, { ...params }) -> stream.Readable
#### 📝 Description
Stream audio from one voice to another. Maintain full control over emotion, timing and delivery.
#### 🔌 Usage
```typescript await client.speechToSpeech.convertAsStream("JBFqnCBsd6RMkjVDRZzb", { audio: fs.createReadStream("/path/to/your/file"), output_format: "mp3_44100_128", model_id: "eleven_multilingual_sts_v2", }); ```
#### ⚙️ Parameters
**voiceId:** `string`
**request:** `ElevenLabs.BodySpeechToSpeechStreamingV1SpeechToSpeechVoiceIdStreamPost`
**requestOptions:** `SpeechToSpeech.RequestOptions`
## TextToVoice
client.textToVoice.createPreviews({ ...params }) -> ElevenLabs.VoiceDesignPreviewResponse
#### 📝 Description
Create a voice from a text prompt.
#### 🔌 Usage
```typescript await client.textToVoice.createPreviews({ voice_description: "A sassy squeaky mouse", }); ```
#### ⚙️ Parameters
**request:** `ElevenLabs.VoiceDesignRequest`
**requestOptions:** `TextToVoice.RequestOptions`
client.textToVoice.createVoiceFromPreview({ ...params }) -> ElevenLabs.Voice
#### 📝 Description
Add a generated voice to the voice library.
#### 🔌 Usage
```typescript await client.textToVoice.createVoiceFromPreview({ voice_name: "Sassy squeaky mouse", voice_description: "A sassy squeaky mouse", generated_voice_id: "37HceQefKmEi3bGovXjL", }); ```
#### ⚙️ Parameters
**request:** `ElevenLabs.SaveVoicePreviewRequest`
**requestOptions:** `TextToVoice.RequestOptions`
## User
client.user.getSubscription() -> ElevenLabs.Subscription
#### 📝 Description
Gets extended information about the users subscription
#### 🔌 Usage
```typescript await client.user.getSubscription(); ```
#### ⚙️ Parameters
**requestOptions:** `User.RequestOptions`
client.user.get() -> ElevenLabs.User
#### 📝 Description
Gets information about the user
#### 🔌 Usage
```typescript await client.user.get(); ```
#### ⚙️ Parameters
**requestOptions:** `User.RequestOptions`
## Voices
client.voices.getAll({ ...params }) -> ElevenLabs.GetVoicesResponse
#### 📝 Description
Returns a list of all available voices for a user.
#### 🔌 Usage
```typescript await client.voices.getAll(); ```
#### ⚙️ Parameters
**request:** `ElevenLabs.VoicesGetAllRequest`
**requestOptions:** `Voices.RequestOptions`
client.voices.search({ ...params }) -> ElevenLabs.GetVoicesV2Response
#### 📝 Description
Gets a list of all available voices for a user with search, filtering and pagination.
#### 🔌 Usage
```typescript await client.voices.search({ include_total_count: true, }); ```
#### ⚙️ Parameters
**request:** `ElevenLabs.VoicesSearchRequest`
**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
```typescript 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
```typescript await client.voices.getSettings("21m00Tcm4TlvDq8ikWAM"); ```
#### ⚙️ 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
```typescript await client.voices.get("21m00Tcm4TlvDq8ikWAM"); ```
#### ⚙️ Parameters
**voiceId:** `string` — ID of the voice to be used. You can use the [Get voices](/docs/api-reference/voices/search) endpoint list all the available voices.
**request:** `ElevenLabs.VoicesGetRequest`
**requestOptions:** `Voices.RequestOptions`
client.voices.delete(voiceId) -> ElevenLabs.DeleteVoiceResponseModel
#### 📝 Description
Deletes a voice by its ID.
#### 🔌 Usage
```typescript await client.voices.delete("21m00Tcm4TlvDq8ikWAM"); ```
#### ⚙️ Parameters
**voiceId:** `string` — ID of the voice to be used. You can use the [Get voices](/docs/api-reference/voices/search) endpoint list all the available voices.
**requestOptions:** `Voices.RequestOptions`
client.voices.editSettings(voiceId, { ...params }) -> ElevenLabs.EditVoiceSettingsResponseModel
#### 📝 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
```typescript await client.voices.editSettings("21m00Tcm4TlvDq8ikWAM", { stability: 1, similarity_boost: 1, style: 0, use_speaker_boost: true, speed: 1, }); ```
#### ⚙️ Parameters
**voiceId:** `string` — ID of the voice to be used. You can use the [Get voices](/docs/api-reference/voices/search) endpoint list all the available voices.
**request:** `ElevenLabs.VoiceSettings`
**requestOptions:** `Voices.RequestOptions`
client.voices.add({ ...params }) -> ElevenLabs.AddVoiceIvcResponseModel
#### 📝 Description
Create a voice clone and add it to your Voices
#### 🔌 Usage
```typescript await client.voices.add({ files: [fs.createReadStream("/path/to/your/file")], name: "name", }); ```
#### ⚙️ Parameters
**request:** `ElevenLabs.BodyAddVoiceV1VoicesAddPost`
**requestOptions:** `Voices.RequestOptions`
client.voices.edit(voiceId, { ...params }) -> ElevenLabs.EditVoiceResponseModel
#### 📝 Description
Edit a voice created by you.
#### 🔌 Usage
```typescript await client.voices.edit("21m00Tcm4TlvDq8ikWAM", { name: "name", }); ```
#### ⚙️ Parameters
**voiceId:** `string`
**request:** `ElevenLabs.BodyEditVoiceV1VoicesVoiceIdEditPost`
**requestOptions:** `Voices.RequestOptions`
client.voices.addSharingVoice(publicUserId, voiceId, { ...params }) -> ElevenLabs.AddVoiceResponseModel
#### 📝 Description
Add a shared voice to your collection of Voices
#### 🔌 Usage
```typescript await client.voices.addSharingVoice( "63e06b7e7cafdc46be4d2e0b3f045940231ae058d508589653d74d1265a574ca", "21m00Tcm4TlvDq8ikWAM", { new_name: "John Smith", }, ); ```
#### ⚙️ Parameters
**publicUserId:** `string` — Public user ID used to publicly identify ElevenLabs users.
**voiceId:** `string` — ID of the voice to be used. You can use the [Get voices](/docs/api-reference/voices/search) endpoint list all the available voices.
**request:** `ElevenLabs.BodyAddSharedVoiceV1VoicesAddPublicUserIdVoiceIdPost`
**requestOptions:** `Voices.RequestOptions`
client.voices.getShared({ ...params }) -> ElevenLabs.GetLibraryVoicesResponse
#### 📝 Description
Retrieves a list of shared voices.
#### 🔌 Usage
```typescript await client.voices.getShared({ featured: true, reader_app_enabled: true, }); ```
#### ⚙️ 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
```typescript await client.voices.getSimilarLibraryVoices({}); ```
#### ⚙️ Parameters
**request:** `ElevenLabs.BodyGetSimilarLibraryVoicesV1SimilarVoicesPost`
**requestOptions:** `Voices.RequestOptions`
## Studio
client.studio.createPodcast({ ...params }) -> ElevenLabs.PodcastProjectResponseModel
#### 📝 Description
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.
#### 🔌 Usage
```typescript await client.studio.createPodcast({ model_id: "21m00Tcm4TlvDq8ikWAM", mode: { type: "conversation", conversation: { host_voice_id: "aw1NgEzBg83R7vgmiJt6", guest_voice_id: "aw1NgEzBg83R7vgmiJt7", }, }, source: { text: "This is a test podcast.", }, }); ```
#### ⚙️ Parameters
**request:** `ElevenLabs.BodyCreatePodcastV1StudioPodcastsPost`
**requestOptions:** `Studio.RequestOptions`
## Dubbing
client.dubbing.getDubbingResource(dubbingId) -> ElevenLabs.DubbingResource
#### 📝 Description
Given a dubbing ID generated from the '/v1/dubbing' endpoint with studio enabled, returns the dubbing resource.
#### 🔌 Usage
```typescript await client.dubbing.getDubbingResource("dubbing_id"); ```
#### ⚙️ Parameters
**dubbingId:** `string` — ID of the dubbing project.
**requestOptions:** `Dubbing.RequestOptions`
client.dubbing.addLanguageToResource(dubbingId, { ...params }) -> ElevenLabs.LanguageAddedResponse
#### 📝 Description
Adds the given ElevenLab Turbo V2/V2.5 language code to the resource. Does not automatically generate transcripts/translations/audio.
#### 🔌 Usage
```typescript await client.dubbing.addLanguageToResource("dubbing_id"); ```
#### ⚙️ Parameters
**dubbingId:** `string` — ID of the dubbing project.
**request:** `ElevenLabs.BodyAddALanguageToTheResourceV1DubbingResourceDubbingIdLanguagePost`
**requestOptions:** `Dubbing.RequestOptions`
client.dubbing.updateSegmentLanguage(dubbingId, segmentId, language, { ...params }) -> ElevenLabs.SegmentUpdateResponse
#### 📝 Description
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.
#### 🔌 Usage
```typescript await client.dubbing.updateSegmentLanguage("dubbing_id", "segment_id", "language"); ```
#### ⚙️ Parameters
**dubbingId:** `string` — ID of the dubbing project.
**segmentId:** `string` — ID of the segment
**language:** `string` — ID of the language.
**request:** `ElevenLabs.SegmentUpdatePayload`
**requestOptions:** `Dubbing.RequestOptions`
client.dubbing.deleteSegment(dubbingId, segmentId) -> ElevenLabs.SegmentDeleteResponse
#### 📝 Description
Deletes a single segment from the dubbing.
#### 🔌 Usage
```typescript await client.dubbing.deleteSegment("dubbing_id", "segment_id"); ```
#### ⚙️ Parameters
**dubbingId:** `string` — ID of the dubbing project.
**segmentId:** `string` — ID of the segment
**requestOptions:** `Dubbing.RequestOptions`
client.dubbing.transcribeSegments(dubbingId, { ...params }) -> ElevenLabs.SegmentTranscriptionResponse
#### 📝 Description
Regenerate the transcriptions for the specified segments. Does not automatically regenerate translations or dubs.
#### 🔌 Usage
```typescript await client.dubbing.transcribeSegments("dubbing_id", { segments: ["segments"], }); ```
#### ⚙️ Parameters
**dubbingId:** `string` — ID of the dubbing project.
**request:** `ElevenLabs.BodyTranscribesSegmentsV1DubbingResourceDubbingIdTranscribePost`
**requestOptions:** `Dubbing.RequestOptions`
client.dubbing.translateSegments(dubbingId, { ...params }) -> ElevenLabs.SegmentTranslationResponse
#### 📝 Description
Regenerate the translations for either the entire resource or the specified segments/languages. Will automatically transcribe missing transcriptions. Will not automatically regenerate the dubs.
#### 🔌 Usage
```typescript await client.dubbing.translateSegments("dubbing_id", { segments: ["segments"], }); ```
#### ⚙️ Parameters
**dubbingId:** `string` — ID of the dubbing project.
**request:** `ElevenLabs.BodyTranslatesAllOrSomeSegmentsAndLanguagesV1DubbingResourceDubbingIdTranslatePost`
**requestOptions:** `Dubbing.RequestOptions`
client.dubbing.dubSegments(dubbingId, { ...params }) -> ElevenLabs.SegmentDubResponse
#### 📝 Description
Regenerate the dubs for either the entire resource or the specified segments/languages. Will automatically transcribe and translate any missing transcriptions and translations.
#### 🔌 Usage
```typescript await client.dubbing.dubSegments("dubbing_id", { segments: ["segments"], }); ```
#### ⚙️ Parameters
**dubbingId:** `string` — ID of the dubbing project.
**request:** `ElevenLabs.BodyDubsAllOrSomeSegmentsAndLanguagesV1DubbingResourceDubbingIdDubPost`
**requestOptions:** `Dubbing.RequestOptions`
client.dubbing.renderDub(dubbingId, language, { ...params }) -> ElevenLabs.DubbingRenderResponseModel
#### 📝 Description
Regenerate the dubs for either the entire resource or the specified segments/languages. Will automatically transcribe and translate any missing transcriptions and translations.
#### 🔌 Usage
```typescript await client.dubbing.renderDub("dubbing_id", "language", { render_type: "mp4", }); ```
#### ⚙️ Parameters
**dubbingId:** `string` — ID of the dubbing project.
**language:** `string` — Render this language
**request:** `ElevenLabs.BodyRenderAudioOrVideoForTheGivenLanguageV1DubbingResourceDubbingIdRenderLanguagePost`
**requestOptions:** `Dubbing.RequestOptions`
client.dubbing.dubAVideoOrAnAudioFile({ ...params }) -> ElevenLabs.DoDubbingResponse
#### 📝 Description
Dubs a provided audio or video file into given language.
#### 🔌 Usage
```typescript await client.dubbing.dubAVideoOrAnAudioFile({}); ```
#### ⚙️ 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
```typescript await client.dubbing.getDubbingProjectMetadata("dubbing_id"); ```
#### ⚙️ Parameters
**dubbingId:** `string` — ID of the dubbing project.
**requestOptions:** `Dubbing.RequestOptions`
client.dubbing.deleteDubbingProject(dubbingId) -> ElevenLabs.DeleteDubbingResponseModel
#### 📝 Description
Deletes a dubbing project.
#### 🔌 Usage
```typescript await client.dubbing.deleteDubbingProject("dubbing_id"); ```
#### ⚙️ Parameters
**dubbingId:** `string` — ID of the dubbing project.
**requestOptions:** `Dubbing.RequestOptions`
client.dubbing.getTranscriptForDub(dubbingId, languageCode, { ...params }) -> string
#### 📝 Description
Returns transcript for the dub as an SRT or WEBVTT file.
#### 🔌 Usage
```typescript await client.dubbing.getTranscriptForDub("dubbing_id", "language_code"); ```
#### ⚙️ Parameters
**dubbingId:** `string` — ID of the dubbing project.
**languageCode:** `string` — ID of the language.
**request:** `ElevenLabs.DubbingGetTranscriptForDubRequest`
**requestOptions:** `Dubbing.RequestOptions`
## Models
client.models.getAll() -> ElevenLabs.Model[]
#### 📝 Description
Gets a list of available models.
#### 🔌 Usage
```typescript await client.models.getAll(); ```
#### ⚙️ Parameters
**requestOptions:** `Models.RequestOptions`
## AudioNative
client.audioNative.create({ ...params }) -> ElevenLabs.AudioNativeCreateProjectResponseModel
#### 📝 Description
Creates Audio Native enabled project, optionally starts conversion and returns project ID and embeddable HTML snippet.
#### 🔌 Usage
```typescript await client.audioNative.create({ name: "name", }); ```
#### ⚙️ Parameters
**request:** `ElevenLabs.BodyCreatesAudioNativeEnabledProjectV1AudioNativePost`
**requestOptions:** `AudioNative.RequestOptions`
client.audioNative.getSettings(projectId) -> ElevenLabs.GetAudioNativeProjectSettingsResponseModel
#### 📝 Description
Get player settings for the specific project.
#### 🔌 Usage
```typescript await client.audioNative.getSettings("21m00Tcm4TlvDq8ikWAM"); ```
#### ⚙️ Parameters
**projectId:** `string` — The ID of the Studio project.
**requestOptions:** `AudioNative.RequestOptions`
client.audioNative.updateContent(projectId, { ...params }) -> ElevenLabs.AudioNativeEditContentResponseModel
#### 📝 Description
Updates content for the specific AudioNative Project.
#### 🔌 Usage
```typescript await client.audioNative.updateContent("21m00Tcm4TlvDq8ikWAM", {}); ```
#### ⚙️ Parameters
**projectId:** `string`
**request:** `ElevenLabs.BodyUpdateAudioNativeProjectContentV1AudioNativeProjectIdContentPost`
**requestOptions:** `AudioNative.RequestOptions`
## Usage
client.usage.getCharactersUsageMetrics({ ...params }) -> ElevenLabs.UsageCharactersResponseModel
#### 📝 Description
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.
#### 🔌 Usage
```typescript 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
```typescript await client.pronunciationDictionary.addFromFile({ name: "name", }); ```
#### ⚙️ Parameters
**request:** `ElevenLabs.BodyAddAPronunciationDictionaryV1PronunciationDictionariesAddFromFilePost`
**requestOptions:** `PronunciationDictionary.RequestOptions`
client.pronunciationDictionary.addFromRules({ ...params }) -> ElevenLabs.AddPronunciationDictionaryResponseModel
#### 📝 Description
Creates a new pronunciation dictionary from provided rules.
#### 🔌 Usage
```typescript await client.pronunciationDictionary.addFromRules({ rules: [ { type: "alias", string_to_replace: "Thailand", alias: "tie-land", }, ], name: "My Dictionary", }); ```
#### ⚙️ Parameters
**request:** `ElevenLabs.BodyAddAPronunciationDictionaryV1PronunciationDictionariesAddFromRulesPost`
**requestOptions:** `PronunciationDictionary.RequestOptions`
client.pronunciationDictionary.addRules(pronunciationDictionaryId, { ...params }) -> ElevenLabs.PronunciationDictionaryRulesResponseModel
#### 📝 Description
Add rules to the pronunciation dictionary
#### 🔌 Usage
```typescript await client.pronunciationDictionary.addRules("21m00Tcm4TlvDq8ikWAM", { rules: [ { type: "alias", string_to_replace: "Thailand", alias: "tie-land", }, ], }); ```
#### ⚙️ Parameters
**pronunciationDictionaryId:** `string` — The id of the pronunciation dictionary
**request:** `ElevenLabs.PronunciationDictionary`
**requestOptions:** `PronunciationDictionary.RequestOptions`
client.pronunciationDictionary.removeRules(pronunciationDictionaryId, { ...params }) -> ElevenLabs.PronunciationDictionaryRulesResponseModel
#### 📝 Description
Remove rules from the pronunciation dictionary
#### 🔌 Usage
```typescript await client.pronunciationDictionary.removeRules("21m00Tcm4TlvDq8ikWAM", { rule_strings: ["rule_strings"], }); ```
#### ⚙️ Parameters
**pronunciationDictionaryId:** `string` — The id of the pronunciation dictionary
**request:** `ElevenLabs.RemovePronunciationDictionaryRulesRequest`
**requestOptions:** `PronunciationDictionary.RequestOptions`
client.pronunciationDictionary.get(pronunciationDictionaryId) -> ElevenLabs.GetPronunciationDictionaryMetadataResponse
#### 📝 Description
Get metadata for a pronunciation dictionary
#### 🔌 Usage
```typescript await client.pronunciationDictionary.get("21m00Tcm4TlvDq8ikWAM"); ```
#### ⚙️ 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
```typescript await client.pronunciationDictionary.getAll(); ```
#### ⚙️ Parameters
**request:** `ElevenLabs.PronunciationDictionaryGetAllRequest`
**requestOptions:** `PronunciationDictionary.RequestOptions`
## Workspace
client.workspace.searchUserGroups({ ...params }) -> ElevenLabs.WorkspaceGroupByNameResponseModel[]
#### 📝 Description
Searches for user groups in the workspace. Multiple or no groups may be returned.
#### 🔌 Usage
```typescript await client.workspace.searchUserGroups({ name: "name", }); ```
#### ⚙️ Parameters
**request:** `ElevenLabs.SearchUserGroupsV1WorkspaceGroupsSearchGetRequest`
**requestOptions:** `Workspace.RequestOptions`
client.workspace.deleteMemberFromUserGroup(groupId, { ...params }) -> ElevenLabs.DeleteWorkspaceGroupMemberResponseModel
#### 📝 Description
Removes a member from the specified group. This endpoint may only be called by workspace administrators.
#### 🔌 Usage
```typescript await client.workspace.deleteMemberFromUserGroup("group_id", { email: "email", }); ```
#### ⚙️ Parameters
**groupId:** `string` — The ID of the target group.
**request:** `ElevenLabs.BodyDeleteMemberFromUserGroupV1WorkspaceGroupsGroupIdMembersRemovePost`
**requestOptions:** `Workspace.RequestOptions`
client.workspace.addMemberToUserGroup(groupId, { ...params }) -> ElevenLabs.AddWorkspaceGroupMemberResponseModel
#### 📝 Description
Adds a member of your workspace to the specified group. This endpoint may only be called by workspace administrators.
#### 🔌 Usage
```typescript await client.workspace.addMemberToUserGroup("group_id", { email: "email", }); ```
#### ⚙️ Parameters
**groupId:** `string` — The ID of the target group.
**request:** `ElevenLabs.AddMemberToGroupRequest`
**requestOptions:** `Workspace.RequestOptions`
client.workspace.inviteUser({ ...params }) -> ElevenLabs.AddWorkspaceInviteResponseModel
#### 📝 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. If the user is already in the workspace a 400 error will be returned.
#### 🔌 Usage
```typescript await client.workspace.inviteUser({ email: "john.doe@testmail.com", }); ```
#### ⚙️ Parameters
**request:** `ElevenLabs.InviteUserRequest`
**requestOptions:** `Workspace.RequestOptions`
client.workspace.inviteMultipleUsers({ ...params }) -> ElevenLabs.AddWorkspaceInviteResponseModel
#### 📝 Description
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 administrators.
#### 🔌 Usage
```typescript await client.workspace.inviteMultipleUsers({ emails: ["emails"], }); ```
#### ⚙️ Parameters
**request:** `ElevenLabs.BodyInviteMultipleUsersV1WorkspaceInvitesAddBulkPost`
**requestOptions:** `Workspace.RequestOptions`
client.workspace.deleteExistingInvitation({ ...params }) -> ElevenLabs.DeleteWorkspaceInviteResponseModel
#### 📝 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
```typescript await client.workspace.deleteExistingInvitation({ email: "john.doe@testmail.com", }); ```
#### ⚙️ Parameters
**request:** `ElevenLabs.BodyDeleteExistingInvitationV1WorkspaceInvitesDelete`
**requestOptions:** `Workspace.RequestOptions`
client.workspace.updateMember({ ...params }) -> ElevenLabs.UpdateWorkspaceMemberResponseModel
#### 📝 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
```typescript await client.workspace.updateMember({ email: "email", }); ```
#### ⚙️ Parameters
**request:** `ElevenLabs.UpdateMemberRequest`
**requestOptions:** `Workspace.RequestOptions`
client.workspace.deleteMember({ ...params }) -> ElevenLabs.DeleteWorkspaceMemberResponseModel
#### 📝 Description
Deletes a workspace member. This endpoint may only be called by workspace administrators.
#### 🔌 Usage
```typescript await client.workspace.deleteMember({ email: "email", }); ```
#### ⚙️ Parameters
**request:** `ElevenLabs.BodyDeleteMemberV1WorkspaceMembersDelete`
**requestOptions:** `Workspace.RequestOptions`
client.workspace.getResource(resourceId, { ...params }) -> ElevenLabs.ResourceMetadataResponseModel
#### 📝 Description
Gets the metadata of a resource by ID.
#### 🔌 Usage
```typescript await client.workspace.getResource("resource_id", { resource_type: "voice", }); ```
#### ⚙️ Parameters
**resourceId:** `string` — The ID of the target resource.
**request:** `ElevenLabs.GetResourceV1WorkspaceResourcesResourceIdGetRequest`
**requestOptions:** `Workspace.RequestOptions`
client.workspace.shareWorkspaceResource(resourceId, { ...params }) -> unknown
#### 📝 Description
Grants a role on a workspace resource to a user or a group. It overrides any existing role this user/service account/group/workspace api key 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 api key, pass the api key id. The resource will be shared with the service account associated with the api key. You must have admin access to the resource to share it.
#### 🔌 Usage
```typescript await client.workspace.shareWorkspaceResource("resource_id", { role: "admin", resource_type: "voice", }); ```
#### ⚙️ Parameters
**resourceId:** `string` — The ID of the target resource.
**request:** `ElevenLabs.BodyShareWorkspaceResourceV1WorkspaceResourcesResourceIdSharePost`
**requestOptions:** `Workspace.RequestOptions`
client.workspace.unshareWorkspaceResource(resourceId, { ...params }) -> unknown
#### 📝 Description
Removes any existing role on a workspace resource from a user, service account, group or workspace 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 api key, pass the api key id. The resource will be unshared from the service account associated with the api key. You must have admin access to the resource to unshare it. You cannot remove permissions from the user who created the resource.
#### 🔌 Usage
```typescript await client.workspace.unshareWorkspaceResource("resource_id", { resource_type: "voice", }); ```
#### ⚙️ Parameters
**resourceId:** `string` — The ID of the target resource.
**request:** `ElevenLabs.BodyUnshareWorkspaceResourceV1WorkspaceResourcesResourceIdUnsharePost`
**requestOptions:** `Workspace.RequestOptions`
## SpeechToText
client.speechToText.convert({ ...params }) -> ElevenLabs.SpeechToTextChunkResponseModel
#### 📝 Description
Transcribe an audio or video file.
#### 🔌 Usage
```typescript await client.speechToText.convert({ model_id: "model_id", }); ```
#### ⚙️ Parameters
**request:** `ElevenLabs.BodySpeechToTextV1SpeechToTextPost`
**requestOptions:** `SpeechToText.RequestOptions`
## ForcedAlignment
client.forcedAlignment.create({ ...params }) -> ElevenLabs.ForcedAlignmentResponseModel
#### 📝 Description
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.
#### 🔌 Usage
```typescript await client.forcedAlignment.create({ file: fs.createReadStream("/path/to/your/file"), text: "text", }); ```
#### ⚙️ Parameters
**request:** `ElevenLabs.BodyCreateForcedAlignmentV1ForcedAlignmentPost`
**requestOptions:** `ForcedAlignment.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
```typescript await client.conversationalAi.getSignedUrl({ agent_id: "21m00Tcm4TlvDq8ikWAM", }); ```
#### ⚙️ Parameters
**request:** `ElevenLabs.ConversationalAiGetSignedUrlRequest`
**requestOptions:** `ConversationalAi.RequestOptions`
client.conversationalAi.twilioOutboundCall({ ...params }) -> ElevenLabs.TwilioOutboundCallResponse
#### 📝 Description
Handle an outbound call via Twilio
#### 🔌 Usage
```typescript await client.conversationalAi.twilioOutboundCall({ agent_id: "agent_id", agent_phone_number_id: "agent_phone_number_id", to_number: "to_number", }); ```
#### ⚙️ Parameters
**request:** `ElevenLabs.BodyHandleAnOutboundCallViaTwilioV1ConvaiTwilioOutboundCallPost`
**requestOptions:** `ConversationalAi.RequestOptions`
client.conversationalAi.createAgent({ ...params }) -> ElevenLabs.CreateAgentResponseModel
#### 📝 Description
Create an agent from a config object
#### 🔌 Usage
```typescript 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
```typescript 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) -> void
#### 📝 Description
Delete an agent
#### 🔌 Usage
```typescript 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
```typescript await client.conversationalAi.updateAgent("21m00Tcm4TlvDq8ikWAM"); ```
#### ⚙️ Parameters
**agentId:** `string` — The id of an agent. This is returned on agent creation.
**request:** `ElevenLabs.UpdateAgentRequest`
**requestOptions:** `ConversationalAi.RequestOptions`
client.conversationalAi.getAgentWidget(agentId, { ...params }) -> ElevenLabs.GetAgentEmbedResponseModel
#### 📝 Description
Retrieve the widget configuration for an agent
#### 🔌 Usage
```typescript await client.conversationalAi.getAgentWidget("21m00Tcm4TlvDq8ikWAM"); ```
#### ⚙️ Parameters
**agentId:** `string` — The id of an agent. This is returned on agent creation.
**request:** `ElevenLabs.ConversationalAiGetAgentWidgetRequest`
**requestOptions:** `ConversationalAi.RequestOptions`
client.conversationalAi.getAgentLink(agentId) -> ElevenLabs.GetAgentLinkResponseModel
#### 📝 Description
Get the current link used to share the agent with others
#### 🔌 Usage
```typescript await client.conversationalAi.getAgentLink("21m00Tcm4TlvDq8ikWAM"); ```
#### ⚙️ Parameters
**agentId:** `string` — The id of an agent. This is returned on agent creation.
**requestOptions:** `ConversationalAi.RequestOptions`
client.conversationalAi.postAgentAvatar(agentId, { ...params }) -> ElevenLabs.PostAgentAvatarResponseModel
#### 📝 Description
Sets the avatar for an agent displayed in the widget
#### 🔌 Usage
```typescript await client.conversationalAi.postAgentAvatar("21m00Tcm4TlvDq8ikWAM", { avatar_file: fs.createReadStream("/path/to/your/file"), }); ```
#### ⚙️ Parameters
**agentId:** `string`
**request:** `ElevenLabs.BodyPostAgentAvatarV1ConvaiAgentsAgentIdAvatarPost`
**requestOptions:** `ConversationalAi.RequestOptions`
client.conversationalAi.getAgents({ ...params }) -> ElevenLabs.GetAgentsPageResponseModel
#### 📝 Description
Returns a list of your agents and their metadata.
#### 🔌 Usage
```typescript 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
```typescript await client.conversationalAi.getConversations(); ```
#### ⚙️ Parameters
**request:** `ElevenLabs.ConversationalAiGetConversationsRequest`
**requestOptions:** `ConversationalAi.RequestOptions`
client.conversationalAi.getConversation(conversationId) -> ElevenLabs.GetConversationResponseModel
#### 📝 Description
Get the details of a particular conversation
#### 🔌 Usage
```typescript await client.conversationalAi.getConversation("123"); ```
#### ⚙️ Parameters
**conversationId:** `string` — The id of the conversation you're taking the action on.
**requestOptions:** `ConversationalAi.RequestOptions`
client.conversationalAi.deleteConversation(conversationId) -> unknown
#### 📝 Description
Delete a particular conversation
#### 🔌 Usage
```typescript await client.conversationalAi.deleteConversation("21m00Tcm4TlvDq8ikWAM"); ```
#### ⚙️ Parameters
**conversationId:** `string` — The id of the conversation you're taking the action on.
**requestOptions:** `ConversationalAi.RequestOptions`
client.conversationalAi.postConversationFeedback(conversationId, { ...params }) -> unknown
#### 📝 Description
Send the feedback for the given conversation
#### 🔌 Usage
```typescript await client.conversationalAi.postConversationFeedback("21m00Tcm4TlvDq8ikWAM", { feedback: "like", }); ```
#### ⚙️ Parameters
**conversationId:** `string` — The id of the conversation you're taking the action on.
**request:** `ElevenLabs.BodySendConversationFeedbackV1ConvaiConversationsConversationIdFeedbackPost`
**requestOptions:** `ConversationalAi.RequestOptions`
client.conversationalAi.createPhoneNumber({ ...params }) -> ElevenLabs.CreatePhoneNumberResponseModel
#### 📝 Description
Import Phone Number from provider configuration (Twilio or SIP trunk)
#### 🔌 Usage
```typescript await client.conversationalAi.createPhoneNumber({ provider: "twilio", phone_number: "phone_number", label: "label", sid: "sid", token: "token", }); ```
#### ⚙️ Parameters
**request:** `ElevenLabs.ConversationalAiCreatePhoneNumberRequestBody`
**requestOptions:** `ConversationalAi.RequestOptions`
client.conversationalAi.getPhoneNumber(phoneNumberId) -> ElevenLabs.ConversationalAiGetPhoneNumberResponse
#### 📝 Description
Retrieve Phone Number details by ID
#### 🔌 Usage
```typescript await client.conversationalAi.getPhoneNumber("TeaqRRdTcIfIu2i7BYfT"); ```
#### ⚙️ Parameters
**phoneNumberId:** `string` — The id of an agent. This is returned on agent creation.
**requestOptions:** `ConversationalAi.RequestOptions`
client.conversationalAi.deletePhoneNumber(phoneNumberId) -> unknown
#### 📝 Description
Delete Phone Number by ID
#### 🔌 Usage
```typescript await client.conversationalAi.deletePhoneNumber("TeaqRRdTcIfIu2i7BYfT"); ```
#### ⚙️ Parameters
**phoneNumberId:** `string` — The id of an agent. This is returned on agent creation.
**requestOptions:** `ConversationalAi.RequestOptions`
client.conversationalAi.updatePhoneNumber(phoneNumberId, { ...params }) -> ElevenLabs.ConversationalAiUpdatePhoneNumberResponse
#### 📝 Description
Update Phone Number details by ID
#### 🔌 Usage
```typescript await client.conversationalAi.updatePhoneNumber("TeaqRRdTcIfIu2i7BYfT"); ```
#### ⚙️ Parameters
**phoneNumberId:** `string` — The id of an agent. This is returned on agent creation.
**request:** `ElevenLabs.UpdatePhoneNumberRequest`
**requestOptions:** `ConversationalAi.RequestOptions`
client.conversationalAi.getPhoneNumbers() -> ElevenLabs.ConversationalAiGetPhoneNumbersResponseItem[]
#### 📝 Description
Retrieve all Phone Numbers
#### 🔌 Usage
```typescript await client.conversationalAi.getPhoneNumbers(); ```
#### ⚙️ Parameters
**requestOptions:** `ConversationalAi.RequestOptions`
client.conversationalAi.getKnowledgeBaseList({ ...params }) -> ElevenLabs.GetKnowledgeBaseListResponseModel
#### 📝 Description
Get a list of available knowledge base documents
#### 🔌 Usage
```typescript await client.conversationalAi.getKnowledgeBaseList(); ```
#### ⚙️ Parameters
**request:** `ElevenLabs.ConversationalAiGetKnowledgeBaseListRequest`
**requestOptions:** `ConversationalAi.RequestOptions`
client.conversationalAi.addToKnowledgeBase({ ...params }) -> ElevenLabs.AddKnowledgeBaseResponseModel
#### 📝 Description
Upload a file or webpage URL to create a knowledge base document.
After creating the document, update the agent's knowledge base by calling [Update agent](/docs/conversational-ai/api-reference/agents/update-agent).
#### 🔌 Usage
```typescript await client.conversationalAi.addToKnowledgeBase({}); ```
#### ⚙️ Parameters
**request:** `ElevenLabs.BodyAddToKnowledgeBaseV1ConvaiKnowledgeBasePost`
**requestOptions:** `ConversationalAi.RequestOptions`
client.conversationalAi.createKnowledgeBaseUrlDocument({ ...params }) -> ElevenLabs.AddKnowledgeBaseResponseModel
#### 📝 Description
Create a knowledge base document generated by scraping the given webpage.
#### 🔌 Usage
```typescript await client.conversationalAi.createKnowledgeBaseUrlDocument({ url: "url", }); ```
#### ⚙️ Parameters
**request:** `ElevenLabs.BodyCreateUrlDocumentV1ConvaiKnowledgeBaseUrlPost`
**requestOptions:** `ConversationalAi.RequestOptions`
client.conversationalAi.createKnowledgeBaseFileDocument({ ...params }) -> ElevenLabs.AddKnowledgeBaseResponseModel
#### 📝 Description
Create a knowledge base document generated form the uploaded file.
#### 🔌 Usage
```typescript await client.conversationalAi.createKnowledgeBaseFileDocument({ file: fs.createReadStream("/path/to/your/file"), }); ```
#### ⚙️ Parameters
**request:** `ElevenLabs.BodyCreateFileDocumentV1ConvaiKnowledgeBaseFilePost`
**requestOptions:** `ConversationalAi.RequestOptions`
client.conversationalAi.createKnowledgeBaseTextDocument({ ...params }) -> ElevenLabs.AddKnowledgeBaseResponseModel
#### 📝 Description
Create a knowledge base document containing the provided text.
#### 🔌 Usage
```typescript await client.conversationalAi.createKnowledgeBaseTextDocument({ text: "text", }); ```
#### ⚙️ Parameters
**request:** `ElevenLabs.BodyCreateTextDocumentV1ConvaiKnowledgeBaseTextPost`
**requestOptions:** `ConversationalAi.RequestOptions`
client.conversationalAi.getKnowledgeBaseDocumentById(documentationId) -> ElevenLabs.ConversationalAiGetKnowledgeBaseDocumentByIdResponse
#### 📝 Description
Get details about a specific documentation making up the agent's knowledge base
#### 🔌 Usage
```typescript await client.conversationalAi.getKnowledgeBaseDocumentById("21m00Tcm4TlvDq8ikWAM"); ```
#### ⚙️ Parameters
**documentationId:** `string` — The id of a document from the knowledge base. This is returned on document addition.
**requestOptions:** `ConversationalAi.RequestOptions`
client.conversationalAi.deleteKnowledgeBaseDocument(documentationId) -> unknown
#### 📝 Description
Delete a document from the knowledge base
#### 🔌 Usage
```typescript await client.conversationalAi.deleteKnowledgeBaseDocument("21m00Tcm4TlvDq8ikWAM"); ```
#### ⚙️ Parameters
**documentationId:** `string` — The id of a document from the knowledge base. This is returned on document addition.
**requestOptions:** `ConversationalAi.RequestOptions`
client.conversationalAi.updateKnowledgeBaseDocument(documentationId, { ...params }) -> ElevenLabs.ConversationalAiUpdateKnowledgeBaseDocumentResponse
#### 📝 Description
Update the name of a document
#### 🔌 Usage
```typescript await client.conversationalAi.updateKnowledgeBaseDocument("21m00Tcm4TlvDq8ikWAM", { name: "name", }); ```
#### ⚙️ Parameters
**documentationId:** `string` — The id of a document from the knowledge base. This is returned on document addition.
**request:** `ElevenLabs.BodyUpdateDocumentV1ConvaiKnowledgeBaseDocumentationIdPatch`
**requestOptions:** `ConversationalAi.RequestOptions`
client.conversationalAi.getDependentAgents(documentationId, { ...params }) -> ElevenLabs.GetKnowledgeBaseDependentAgentsResponseModel
#### 📝 Description
Get a list of agents depending on this knowledge base document
#### 🔌 Usage
```typescript await client.conversationalAi.getDependentAgents("21m00Tcm4TlvDq8ikWAM"); ```
#### ⚙️ Parameters
**documentationId:** `string` — The id of a document from the knowledge base. This is returned on document addition.
**request:** `ElevenLabs.ConversationalAiGetDependentAgentsRequest`
**requestOptions:** `ConversationalAi.RequestOptions`
client.conversationalAi.getKnowledgeBaseDocumentContent(documentationId) -> void
#### 📝 Description
Get the entire content of a document from the knowledge base
#### 🔌 Usage
```typescript await client.conversationalAi.getKnowledgeBaseDocumentContent("21m00Tcm4TlvDq8ikWAM"); ```
#### ⚙️ Parameters
**documentationId:** `string` — The id of a document from the knowledge base. This is returned on document addition.
**requestOptions:** `ConversationalAi.RequestOptions`
client.conversationalAi.getKnowledgeBaseDocumentPartById(documentationId, chunkId) -> ElevenLabs.KnowledgeBaseDocumentChunkResponseModel
#### 📝 Description
Get details about a specific documentation part used by RAG.
#### 🔌 Usage
```typescript await client.conversationalAi.getKnowledgeBaseDocumentPartById("21m00Tcm4TlvDq8ikWAM", "chunk_id"); ```
#### ⚙️ Parameters
**documentationId:** `string` — The id of a document from the knowledge base. This is returned on document addition.
**chunkId:** `string` — The id of a document RAG chunk from the knowledge base.
**requestOptions:** `ConversationalAi.RequestOptions`
client.conversationalAi.getSettings() -> ElevenLabs.GetConvAiSettingsResponseModel
#### 📝 Description
Retrieve Convai settings for the workspace
#### 🔌 Usage
```typescript await client.conversationalAi.getSettings(); ```
#### ⚙️ Parameters
**requestOptions:** `ConversationalAi.RequestOptions`
client.conversationalAi.updateSettings({ ...params }) -> ElevenLabs.GetConvAiSettingsResponseModel
#### 📝 Description
Update Convai settings for the workspace
#### 🔌 Usage
```typescript await client.conversationalAi.updateSettings(); ```
#### ⚙️ Parameters
**request:** `ElevenLabs.PatchConvAiSettingsRequest`
**requestOptions:** `ConversationalAi.RequestOptions`
client.conversationalAi.getDashboardSettings() -> ElevenLabs.GetConvAiDashboardSettingsResponseModel
#### 📝 Description
Retrieve Convai dashboard settings for the workspace
#### 🔌 Usage
```typescript await client.conversationalAi.getDashboardSettings(); ```
#### ⚙️ Parameters
**requestOptions:** `ConversationalAi.RequestOptions`
client.conversationalAi.updateDashboardSettings({ ...params }) -> ElevenLabs.GetConvAiDashboardSettingsResponseModel
#### 📝 Description
Update Convai dashboard settings for the workspace
#### 🔌 Usage
```typescript await client.conversationalAi.updateDashboardSettings(); ```
#### ⚙️ Parameters
**request:** `ElevenLabs.PatchConvAiDashboardSettingsRequest`
**requestOptions:** `ConversationalAi.RequestOptions`
client.conversationalAi.getSecrets() -> ElevenLabs.GetWorkspaceSecretsResponseModel
#### 📝 Description
Get all workspace secrets for the user
#### 🔌 Usage
```typescript await client.conversationalAi.getSecrets(); ```
#### ⚙️ Parameters
**requestOptions:** `ConversationalAi.RequestOptions`
client.conversationalAi.createSecret({ ...params }) -> ElevenLabs.PostWorkspaceSecretResponseModel
#### 📝 Description
Create a new secret for the workspace
#### 🔌 Usage
```typescript await client.conversationalAi.createSecret({ name: "name", value: "value", }); ```
#### ⚙️ Parameters
**request:** `ElevenLabs.PostWorkspaceSecretRequest`
**requestOptions:** `ConversationalAi.RequestOptions`
client.conversationalAi.deleteSecret(secretId) -> void
#### 📝 Description
Delete a workspace secret if it's not in use
#### 🔌 Usage
```typescript await client.conversationalAi.deleteSecret("secret_id"); ```
#### ⚙️ Parameters
**secretId:** `string`
**requestOptions:** `ConversationalAi.RequestOptions`
client.conversationalAi.getBatchCall(batchId) -> ElevenLabs.BatchCallDetailedResponse
#### 📝 Description
Get detailed information about a batch call including all recipients.
#### 🔌 Usage
```typescript await client.conversationalAi.getBatchCall("batch_id"); ```
#### ⚙️ Parameters
**batchId:** `string`
**requestOptions:** `ConversationalAi.RequestOptions`
## ConversationalAi Agents
client.conversationalAi.agents.simulateConversation(agentId, { ...params }) -> ElevenLabs.AgentSimulatedChatTestResponseModel
#### 📝 Description
Run a conversation between the agent and a simulated user.
#### 🔌 Usage
```typescript await client.conversationalAi.agents.simulateConversation("21m00Tcm4TlvDq8ikWAM", { simulation_specification: { simulated_user_config: { first_message: "Hello, how can I help you today?", language: "en", }, }, }); ```
#### ⚙️ Parameters
**agentId:** `string` — The id of an agent. This is returned on agent creation.
**request:** `ElevenLabs.conversationalAi.BodySimulatesAConversationV1ConvaiAgentsAgentIdSimulateConversationPost`
**requestOptions:** `Agents.RequestOptions`
client.conversationalAi.agents.simulateConversationStream(agentId, { ...params }) -> void
#### 📝 Description
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.
#### 🔌 Usage
```typescript await client.conversationalAi.agents.simulateConversationStream("21m00Tcm4TlvDq8ikWAM", { simulation_specification: { simulated_user_config: { first_message: "Hello, how can I help you today?", language: "en", }, }, }); ```
#### ⚙️ Parameters
**agentId:** `string` — The id of an agent. This is returned on agent creation.
**request:** `ElevenLabs.conversationalAi.BodySimulatesAConversationStreamV1ConvaiAgentsAgentIdSimulateConversationStreamPost`
**requestOptions:** `Agents.RequestOptions`
## ConversationalAi SipTrunk
client.conversationalAi.sipTrunk.outboundCall({ ...params }) -> ElevenLabs.SipTrunkOutboundCallResponse
#### 📝 Description
Handle an outbound call via SIP trunk
#### 🔌 Usage
```typescript await client.conversationalAi.sipTrunk.outboundCall({ agent_id: "agent_id", agent_phone_number_id: "agent_phone_number_id", to_number: "to_number", }); ```
#### ⚙️ Parameters
**request:** `ElevenLabs.conversationalAi.BodyHandleAnOutboundCallViaSipTrunkV1ConvaiSipTrunkOutboundCallPost`
**requestOptions:** `SipTrunk.RequestOptions`
## ConversationalAi KnowledgeBase Document
client.conversationalAi.knowledgeBase.document.computeRagIndex(documentationId, { ...params }) -> ElevenLabs.RagIndexResponseModel
#### 📝 Description
In case the document is not RAG indexed, it triggers rag indexing task, otherwise it just returns the current status.
#### 🔌 Usage
```typescript await client.conversationalAi.knowledgeBase.document.computeRagIndex("21m00Tcm4TlvDq8ikWAM", { model: "e5_mistral_7b_instruct", }); ```
#### ⚙️ Parameters
**documentationId:** `string` — The id of a document from the knowledge base. This is returned on document addition.
**request:** `ElevenLabs.conversationalAi.knowledgeBase.RagIndexRequestModel`
**requestOptions:** `Document.RequestOptions`
## Dubbing Speaker
client.dubbing.speaker.update(dubbingId, speakerId, { ...params }) -> ElevenLabs.SpeakerUpdatedResponse
#### 📝 Description
Amend the metadata associated with a speaker, such as their voice. Both voice cloning and using voices from the ElevenLabs library are supported.
#### 🔌 Usage
```typescript await client.dubbing.speaker.update("dubbing_id", "speaker_id"); ```
#### ⚙️ Parameters
**dubbingId:** `string` — ID of the dubbing project.
**speakerId:** `string` — ID of the speaker.
**request:** `ElevenLabs.dubbing.BodyUpdateMetadataForASpeakerV1DubbingResourceDubbingIdSpeakerSpeakerIdPatch`
**requestOptions:** `Speaker.RequestOptions`
client.dubbing.speaker.similarVoices(dubbingId, speakerId) -> ElevenLabs.SimilarVoicesForSpeakerResponse
#### 📝 Description
Fetch the top 10 similar voices to a speaker, including the voice IDs, names, descriptions, and, where possible, a sample audio recording.
#### 🔌 Usage
```typescript await client.dubbing.speaker.similarVoices("dubbing_id", "speaker_id"); ```
#### ⚙️ Parameters
**dubbingId:** `string` — ID of the dubbing project.
**speakerId:** `string` — ID of the speaker.
**requestOptions:** `Speaker.RequestOptions`
## Dubbing Speaker Segment
client.dubbing.speaker.segment.create(dubbingId, speakerId, { ...params }) -> ElevenLabs.SegmentCreateResponse
#### 📝 Description
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.
#### 🔌 Usage
```typescript await client.dubbing.speaker.segment.create("dubbing_id", "speaker_id", { start_time: 1.1, end_time: 1.1, }); ```
#### ⚙️ Parameters
**dubbingId:** `string` — ID of the dubbing project.
**speakerId:** `string` — ID of the speaker.
**request:** `ElevenLabs.dubbing.speaker.SegmentCreatePayload`
**requestOptions:** `Segment.RequestOptions`
## Studio Projects
client.studio.projects.getAll() -> ElevenLabs.GetProjectsResponse
#### 📝 Description
Returns a list of your Studio projects with metadata.
#### 🔌 Usage
```typescript await client.studio.projects.getAll(); ```
#### ⚙️ Parameters
**requestOptions:** `Projects.RequestOptions`
client.studio.projects.add({ ...params }) -> ElevenLabs.AddProjectResponseModel
#### 📝 Description
Creates a new Studio project, it can be either initialized as blank, from a document or from a URL.
#### 🔌 Usage
```typescript await client.studio.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.studio.BodyCreateStudioProjectV1StudioProjectsPost`
**requestOptions:** `Projects.RequestOptions`
client.studio.projects.get(projectId) -> ElevenLabs.ProjectExtendedResponse
#### 📝 Description
Returns information about a specific Studio project. This endpoint returns more detailed information about a project than `GET /v1/studio`.
#### 🔌 Usage
```typescript await client.studio.projects.get("21m00Tcm4TlvDq8ikWAM"); ```
#### ⚙️ Parameters
**projectId:** `string` — The ID of the project to be used. You can use the [List projects](/docs/api-reference/studio/get-projects) endpoint to list all the available projects.
**requestOptions:** `Projects.RequestOptions`
client.studio.projects.updateMetadata(projectId, { ...params }) -> ElevenLabs.EditProjectResponseModel
#### 📝 Description
Updates the specified Studio project by setting the values of the parameters passed.
#### 🔌 Usage
```typescript await client.studio.projects.updateMetadata("21m00Tcm4TlvDq8ikWAM", { name: "Project 1", default_title_voice_id: "21m00Tcm4TlvDq8ikWAM", default_paragraph_voice_id: "21m00Tcm4TlvDq8ikWAM", }); ```
#### ⚙️ Parameters
**projectId:** `string` — The ID of the project to be used. You can use the [List projects](/docs/api-reference/studio/get-projects) endpoint to list all the available projects.
**request:** `ElevenLabs.studio.BodyUpdateStudioProjectV1StudioProjectsProjectIdPost`
**requestOptions:** `Projects.RequestOptions`
client.studio.projects.delete(projectId) -> ElevenLabs.DeleteProjectResponseModel
#### 📝 Description
Deletes a Studio project.
#### 🔌 Usage
```typescript await client.studio.projects.delete("21m00Tcm4TlvDq8ikWAM"); ```
#### ⚙️ Parameters
**projectId:** `string` — The ID of the project to be used. You can use the [List projects](/docs/api-reference/studio/get-projects) endpoint to list all the available projects.
**requestOptions:** `Projects.RequestOptions`
client.studio.projects.updateContent(projectId, { ...params }) -> ElevenLabs.EditProjectResponseModel
#### 📝 Description
Updates Studio project content.
#### 🔌 Usage
```typescript await client.studio.projects.updateContent("21m00Tcm4TlvDq8ikWAM", {}); ```
#### ⚙️ Parameters
**projectId:** `string`
**request:** `ElevenLabs.studio.BodyUpdateStudioProjectContentV1StudioProjectsProjectIdContentPost`
**requestOptions:** `Projects.RequestOptions`
client.studio.projects.convert(projectId) -> ElevenLabs.ConvertProjectResponseModel
#### 📝 Description
Starts conversion of a Studio project and all of its chapters.
#### 🔌 Usage
```typescript await client.studio.projects.convert("21m00Tcm4TlvDq8ikWAM"); ```
#### ⚙️ Parameters
**projectId:** `string` — The ID of the project to be used. You can use the [List projects](/docs/api-reference/studio/get-projects) endpoint to list all the available projects.
**requestOptions:** `Projects.RequestOptions`
client.studio.projects.getSnapshots(projectId) -> ElevenLabs.ProjectSnapshotsResponse
#### 📝 Description
Retrieves a list of snapshots for a Studio project.
#### 🔌 Usage
```typescript await client.studio.projects.getSnapshots("21m00Tcm4TlvDq8ikWAM"); ```
#### ⚙️ Parameters
**projectId:** `string` — The ID of the Studio project.
**requestOptions:** `Projects.RequestOptions`
client.studio.projects.getProjectSnapshot(projectId, projectSnapshotId) -> ElevenLabs.ProjectSnapshotExtendedResponseModel
#### 📝 Description
Returns the project snapshot.
#### 🔌 Usage
```typescript await client.studio.projects.getProjectSnapshot("21m00Tcm4TlvDq8ikWAM", "21m00Tcm4TlvDq8ikWAM"); ```
#### ⚙️ Parameters
**projectId:** `string` — The ID of the Studio project.
**projectSnapshotId:** `string` — The ID of the Studio project snapshot.
**requestOptions:** `Projects.RequestOptions`
client.studio.projects.updatePronunciationDictionaries(projectId, { ...params }) -> ElevenLabs.CreatePronunciationDictionaryResponseModel
#### 📝 Description
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.
#### 🔌 Usage
```typescript await client.studio.projects.updatePronunciationDictionaries("21m00Tcm4TlvDq8ikWAM", { pronunciation_dictionary_locators: [ { pronunciation_dictionary_id: "pronunciation_dictionary_id", }, ], }); ```
#### ⚙️ Parameters
**projectId:** `string` — The ID of the project to be used. You can use the [List projects](/docs/api-reference/studio/get-projects) endpoint to list all the available projects.
**request:** `ElevenLabs.studio.BodyCreatePronunciationDictionariesV1StudioProjectsProjectIdPronunciationDictionariesPost`
**requestOptions:** `Projects.RequestOptions`
## Studio Chapters
client.studio.chapters.getAll(projectId) -> ElevenLabs.GetChaptersResponse
#### 📝 Description
Returns a list of a Studio project's chapters.
#### 🔌 Usage
```typescript await client.studio.chapters.getAll("21m00Tcm4TlvDq8ikWAM"); ```
#### ⚙️ Parameters
**projectId:** `string` — The ID of the Studio project.
**requestOptions:** `Chapters.RequestOptions`
client.studio.chapters.create(projectId, { ...params }) -> ElevenLabs.AddChapterResponseModel
#### 📝 Description
Creates a new chapter either as blank or from a URL.
#### 🔌 Usage
```typescript await client.studio.chapters.create("21m00Tcm4TlvDq8ikWAM", { name: "Chapter 1", }); ```
#### ⚙️ Parameters
**projectId:** `string` — The ID of the Studio project.
**request:** `ElevenLabs.studio.BodyCreateChapterV1StudioProjectsProjectIdChaptersPost`
**requestOptions:** `Chapters.RequestOptions`
client.studio.chapters.get(projectId, chapterId) -> ElevenLabs.ChapterWithContentResponseModel
#### 📝 Description
Returns information about a specific chapter.
#### 🔌 Usage
```typescript await client.studio.chapters.get("21m00Tcm4TlvDq8ikWAM", "21m00Tcm4TlvDq8ikWAM"); ```
#### ⚙️ Parameters
**projectId:** `string` — The ID of the project to be used. You can use the [List projects](/docs/api-reference/studio/get-projects) endpoint to list all the available projects.
**chapterId:** `string` — The ID of the chapter to be used. You can use the [List project chapters](/docs/api-reference/studio/get-chapters) endpoint to list all the available chapters.
**requestOptions:** `Chapters.RequestOptions`
client.studio.chapters.edit(projectId, chapterId, { ...params }) -> ElevenLabs.EditChapterResponseModel
#### 📝 Description
Updates a chapter.
#### 🔌 Usage
```typescript await client.studio.chapters.edit("21m00Tcm4TlvDq8ikWAM", "21m00Tcm4TlvDq8ikWAM"); ```
#### ⚙️ Parameters
**projectId:** `string` — The ID of the project to be used. You can use the [List projects](/docs/api-reference/studio/get-projects) endpoint to list all the available projects.
**chapterId:** `string` — The ID of the chapter to be used. You can use the [List project chapters](/docs/api-reference/studio/get-chapters) endpoint to list all the available chapters.
**request:** `ElevenLabs.studio.BodyUpdateChapterV1StudioProjectsProjectIdChaptersChapterIdPost`
**requestOptions:** `Chapters.RequestOptions`
client.studio.chapters.delete(projectId, chapterId) -> ElevenLabs.DeleteChapterResponseModel
#### 📝 Description
Deletes a chapter.
#### 🔌 Usage
```typescript await client.studio.chapters.delete("21m00Tcm4TlvDq8ikWAM", "21m00Tcm4TlvDq8ikWAM"); ```
#### ⚙️ Parameters
**projectId:** `string` — The ID of the project to be used. You can use the [List projects](/docs/api-reference/studio/get-projects) endpoint to list all the available projects.
**chapterId:** `string` — The ID of the chapter to be used. You can use the [List project chapters](/docs/api-reference/studio/get-chapters) endpoint to list all the available chapters.
**requestOptions:** `Chapters.RequestOptions`
client.studio.chapters.convert(projectId, chapterId) -> ElevenLabs.ConvertChapterResponseModel
#### 📝 Description
Starts conversion of a specific chapter.
#### 🔌 Usage
```typescript await client.studio.chapters.convert("21m00Tcm4TlvDq8ikWAM", "21m00Tcm4TlvDq8ikWAM"); ```
#### ⚙️ Parameters
**projectId:** `string` — The ID of the project to be used. You can use the [List projects](/docs/api-reference/studio/get-projects) endpoint to list all the available projects.
**chapterId:** `string` — The ID of the chapter to be used. You can use the [List project chapters](/docs/api-reference/studio/get-chapters) endpoint to list all the available chapters.
**requestOptions:** `Chapters.RequestOptions`
client.studio.chapters.getAllSnapshots(projectId, chapterId) -> ElevenLabs.ChapterSnapshotsResponse
#### 📝 Description
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.
#### 🔌 Usage
```typescript await client.studio.chapters.getAllSnapshots("21m00Tcm4TlvDq8ikWAM", "21m00Tcm4TlvDq8ikWAM"); ```
#### ⚙️ Parameters
**projectId:** `string` — The ID of the project to be used. You can use the [List projects](/docs/api-reference/studio/get-projects) endpoint to list all the available projects.
**chapterId:** `string` — The ID of the chapter to be used. You can use the [List project chapters](/docs/api-reference/studio/get-chapters) endpoint to list all the available chapters.
**requestOptions:** `Chapters.RequestOptions`
client.studio.chapters.getChapterSnapshot(projectId, chapterId, chapterSnapshotId) -> ElevenLabs.ChapterSnapshotExtendedResponseModel
#### 📝 Description
Returns the chapter snapshot.
#### 🔌 Usage
```typescript await client.studio.chapters.getChapterSnapshot("21m00Tcm4TlvDq8ikWAM", "21m00Tcm4TlvDq8ikWAM", "21m00Tcm4TlvDq8ikWAM"); ```
#### ⚙️ Parameters
**projectId:** `string` — The ID of the Studio project.
**chapterId:** `string` — The ID of the chapter.
**chapterSnapshotId:** `string` — The ID of the chapter snapshot.
**requestOptions:** `Chapters.RequestOptions`
## Voices Pvc
client.voices.pvc.create({ ...params }) -> ElevenLabs.AddVoiceResponseModel
#### 📝 Description
Creates a new PVC voice with metadata but no samples
#### 🔌 Usage
```typescript await client.voices.pvc.create({ name: "John Smith", language: "en", }); ```
#### ⚙️ Parameters
**request:** `ElevenLabs.voices.CreatePvcVoiceRequest`
**requestOptions:** `Pvc.RequestOptions`
client.voices.pvc.update(voiceId, { ...params }) -> ElevenLabs.AddVoiceResponseModel
#### 📝 Description
Edit PVC voice metadata
#### 🔌 Usage
```typescript await client.voices.pvc.update("21m00Tcm4TlvDq8ikWAM"); ```
#### ⚙️ 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.voices.BodyEditPvcVoiceV1VoicesPvcVoiceIdPost`
**requestOptions:** `Pvc.RequestOptions`
client.voices.pvc.train(voiceId, { ...params }) -> ElevenLabs.StartPvcVoiceTrainingResponseModel
#### 📝 Description
Start PVC training process for a voice.
#### 🔌 Usage
```typescript await client.voices.pvc.train("21m00Tcm4TlvDq8ikWAM"); ```
#### ⚙️ 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.voices.BodyRunPvcTrainingV1VoicesPvcVoiceIdTrainPost`
**requestOptions:** `Pvc.RequestOptions`
## Voices Pvc Samples
client.voices.pvc.samples.create(voiceId, { ...params }) -> ElevenLabs.VoiceSample[]
#### 📝 Description
Add audio samples to a PVC voice
#### 🔌 Usage
```typescript await client.voices.pvc.samples.create("21m00Tcm4TlvDq8ikWAM", { files: [fs.createReadStream("/path/to/your/file")], }); ```
#### ⚙️ Parameters
**voiceId:** `string`
**request:** `ElevenLabs.voices.pvc.BodyAddSamplesToPvcVoiceV1VoicesPvcVoiceIdSamplesPost`
**requestOptions:** `Samples.RequestOptions`
client.voices.pvc.samples.update(voiceId, sampleId, { ...params }) -> ElevenLabs.AddVoiceResponseModel
#### 📝 Description
Update a PVC voice sample - apply noise removal, or select speaker.
#### 🔌 Usage
```typescript await client.voices.pvc.samples.update("21m00Tcm4TlvDq8ikWAM", "VW7YKqPnjY4h39yTbx2L"); ```
#### ⚙️ 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
**request:** `ElevenLabs.voices.pvc.BodyUpdatePvcVoiceSampleV1VoicesPvcVoiceIdSamplesSampleIdPost`
**requestOptions:** `Samples.RequestOptions`
client.voices.pvc.samples.delete(voiceId, sampleId) -> ElevenLabs.DeleteVoiceSampleResponseModel
#### 📝 Description
Delete a sample from a PVC voice.
#### 🔌 Usage
```typescript await client.voices.pvc.samples.delete("21m00Tcm4TlvDq8ikWAM", "VW7YKqPnjY4h39yTbx2L"); ```
#### ⚙️ 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
**requestOptions:** `Samples.RequestOptions`
## Voices Pvc Verification
client.voices.pvc.verification.request(voiceId, { ...params }) -> ElevenLabs.RequestPvcManualVerificationResponseModel
#### 📝 Description
Request manual verification for a PVC voice.
#### 🔌 Usage
```typescript await client.voices.pvc.verification.request("21m00Tcm4TlvDq8ikWAM", { files: [fs.createReadStream("/path/to/your/file")], }); ```
#### ⚙️ Parameters
**voiceId:** `string`
**request:** `ElevenLabs.voices.pvc.BodyRequestManualVerificationV1VoicesPvcVoiceIdVerificationPost`
**requestOptions:** `Verification.RequestOptions`
## Voices Pvc Samples Audio
client.voices.pvc.samples.audio.get(voiceId, sampleId) -> ElevenLabs.VoiceSamplePreviewResponseModel
#### 📝 Description
Retrieve the first 30 seconds of voice sample audio with or without noise removal.
#### 🔌 Usage
```typescript await client.voices.pvc.samples.audio.get("21m00Tcm4TlvDq8ikWAM", "VW7YKqPnjY4h39yTbx2L"); ```
#### ⚙️ 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
**requestOptions:** `Audio.RequestOptions`
## Voices Pvc Samples Waveform
client.voices.pvc.samples.waveform.get(voiceId, sampleId) -> ElevenLabs.VoiceSampleVisualWaveformResponseModel
#### 📝 Description
Retrieve the visual waveform of a voice sample.
#### 🔌 Usage
```typescript await client.voices.pvc.samples.waveform.get("21m00Tcm4TlvDq8ikWAM", "VW7YKqPnjY4h39yTbx2L"); ```
#### ⚙️ 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
**requestOptions:** `Waveform.RequestOptions`
## Voices Pvc Samples Speakers
client.voices.pvc.samples.speakers.get(voiceId, sampleId) -> ElevenLabs.SpeakerSeparationResponseModel
#### 📝 Description
Retrieve the status of the speaker separation process and the list of detected speakers if complete.
#### 🔌 Usage
```typescript await client.voices.pvc.samples.speakers.get("21m00Tcm4TlvDq8ikWAM", "VW7YKqPnjY4h39yTbx2L"); ```
#### ⚙️ 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
**requestOptions:** `Speakers.RequestOptions`
client.voices.pvc.samples.speakers.separate(voiceId, sampleId) -> ElevenLabs.StartSpeakerSeparationResponseModel
#### 📝 Description
Start speaker separation process for a sample
#### 🔌 Usage
```typescript await client.voices.pvc.samples.speakers.separate("21m00Tcm4TlvDq8ikWAM", "VW7YKqPnjY4h39yTbx2L"); ```
#### ⚙️ 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
**requestOptions:** `Speakers.RequestOptions`
## Voices Pvc Samples Speakers Audio
client.voices.pvc.samples.speakers.audio.get(voiceId, sampleId, speakerId) -> ElevenLabs.SpeakerAudioResponseModel
#### 📝 Description
Retrieve the separated audio for a specific speaker.
#### 🔌 Usage
```typescript await client.voices.pvc.samples.speakers.audio.get( "21m00Tcm4TlvDq8ikWAM", "VW7YKqPnjY4h39yTbx2L", "VW7YKqPnjY4h39yTbx2L", ); ```
#### ⚙️ 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
**speakerId:** `string` — Speaker ID to be used, you can use GET https://api.elevenlabs.io/v1/voices/{voice_id}/samples/{sample_id}/speakers to list all the available speakers for a sample.
**requestOptions:** `Audio.RequestOptions`
## Voices Pvc Verification Captcha
client.voices.pvc.verification.captcha.get(voiceId) -> void
#### 📝 Description
Get captcha for PVC voice verification.
#### 🔌 Usage
```typescript await client.voices.pvc.verification.captcha.get("21m00Tcm4TlvDq8ikWAM"); ```
#### ⚙️ Parameters
**voiceId:** `string` — Voice ID to be used, you can use https://api.elevenlabs.io/v1/voices to list all the available voices.
**requestOptions:** `Captcha.RequestOptions`
client.voices.pvc.verification.captcha.verify(voiceId, { ...params }) -> ElevenLabs.VerifyPvcVoiceCaptchaResponseModel
#### 📝 Description
Submit captcha verification for PVC voice.
#### 🔌 Usage
```typescript await client.voices.pvc.verification.captcha.verify("21m00Tcm4TlvDq8ikWAM", { recording: fs.createReadStream("/path/to/your/file"), }); ```
#### ⚙️ Parameters
**voiceId:** `string`
**request:** `ElevenLabs.voices.pvc.verification.BodyVerifyPvcVoiceCaptchaV1VoicesPvcVoiceIdCaptchaPost`
**requestOptions:** `Captcha.RequestOptions`