@elevenlabs/elevenlabs-js 2.16.0 → 2.18.0

package/reference.md

@@ -87,7 +87,17 @@ Returns a list of your generated audio.
 <dd>
 
 ```typescript
-await client.history.list();
+await client.history.list({
+    pageSize: 1,
+    startAfterHistoryItemId: "start_after_history_item_id",
+    voiceId: "voice_id",
+    modelId: "model_id",
+    dateBeforeUnix: 1,
+    dateAfterUnix: 1,
+    sortDirection: "asc",
+    search: "search",
+    source: "TTS",
+});
 ```
 
 </dd>
@@ -577,7 +587,7 @@ await client.textToSpeech.convert("JBFqnCBsd6RMkjVDRZzb", {
 <dl>
 <dd>
 
-**request:** `ElevenLabs.TextToSpeechRequest`
+**request:** `ElevenLabs.BodyTextToSpeechFull`
 
 </dd>
 </dl>
@@ -625,6 +635,9 @@ Generate speech from text with precise character-level timing information for au
 
 ```typescript
 await client.textToSpeech.convertWithTimestamps("21m00Tcm4TlvDq8ikWAM", {
+    enableLogging: true,
+    optimizeStreamingLatency: 1,
+    outputFormat: "mp3_22050_32",
     text: "This is a test for the API of ElevenLabs.",
 });
 ```
@@ -1155,6 +1168,7 @@ Create a voice from a text prompt.
 
 ```typescript
 await client.textToVoice.createPreviews({
+    outputFormat: "mp3_22050_32",
     voiceDescription: "A sassy squeaky mouse",
 });
 ```
@@ -1287,6 +1301,7 @@ Design a voice via a prompt. This method returns a list of voice previews. Each
 
 ```typescript
 await client.textToVoice.design({
+    outputFormat: "mp3_22050_32",
     voiceDescription: "A sassy squeaky mouse",
 });
 ```
@@ -1352,6 +1367,7 @@ Remix an existing voice via a prompt. This method returns a list of voice previe
 
 ```typescript
 await client.textToVoice.remix("21m00Tcm4TlvDq8ikWAM", {
+    outputFormat: "mp3_22050_32",
     voiceDescription: "Make the voice have a higher pitch.",
 });
 ```
@@ -1483,7 +1499,9 @@ Returns a list of all available voices for a user.
 <dd>
 
 ```typescript
-await client.voices.getAll();
+await client.voices.getAll({
+    showLegacy: true,
+});
 ```
 
 </dd>
@@ -1547,6 +1565,15 @@ Gets a list of all available voices for a user with search, filtering and pagina
 
 ```typescript
 await client.voices.search({
+    nextPageToken: "next_page_token",
+    pageSize: 1,
+    search: "search",
+    sort: "sort",
+    sortDirection: "sort_direction",
+    voiceType: "voice_type",
+    category: "category",
+    fineTuningState: "fine_tuning_state",
+    collectionId: "collection_id",
     includeTotalCount: true,
 });
 ```
@@ -1611,7 +1638,9 @@ Returns metadata about a specific voice.
 <dd>
 
 ```typescript
-await client.voices.get("21m00Tcm4TlvDq8ikWAM");
+await client.voices.get("21m00Tcm4TlvDq8ikWAM", {
+    withSettings: true,
+});
 ```
 
 </dd>
@@ -1900,8 +1929,22 @@ Retrieves a list of shared voices.
 
 ```typescript
 await client.voices.getShared({
+    pageSize: 1,
+    category: "professional",
+    gender: "gender",
+    age: "age",
+    accent: "accent",
+    language: "language",
+    locale: "locale",
+    search: "search",
     featured: true,
+    minNoticePeriodDays: 1,
+    includeCustomRates: true,
+    includeLiveModerated: true,
     readerAppEnabled: true,
+    ownerId: "owner_id",
+    sort: "sort",
+    page: 1,
 });
 ```
 
@@ -2107,7 +2150,14 @@ List the dubs you have access to.
 <dd>
 
 ```typescript
-await client.dubbing.list();
+await client.dubbing.list({
+    cursor: "cursor",
+    pageSize: 1,
+    dubbingStatus: "dubbing",
+    filterByCreator: "personal",
+    orderBy: "created_at",
+    orderDirection: "DESCENDING",
+});
 ```
 
 </dd>
@@ -2170,7 +2220,12 @@ Dubs a provided audio or video file into given language.
 <dd>
 
 ```typescript
-await client.dubbing.create({});
+await client.dubbing.create({
+    file: fs.createReadStream("/path/to/your/file"),
+    csvFile: fs.createReadStream("/path/to/your/file"),
+    foregroundAudioFile: fs.createReadStream("/path/to/your/file"),
+    backgroundAudioFile: fs.createReadStream("/path/to/your/file"),
+});
 ```
 
 </dd>
@@ -2622,6 +2677,11 @@ Returns the usage metrics for the current user or the entire workspace they are
 await client.usage.get({
     startUnix: 1,
     endUnix: 1,
+    includeWorkspaceMetrics: true,
+    breakdownType: "none",
+    aggregationInterval: "hour",
+    aggregationBucketSize: 1,
+    metric: "credits",
 });
 ```
 
@@ -2688,6 +2748,7 @@ Creates a new pronunciation dictionary from a lexicon .PLS file
 
 ```typescript
 await client.pronunciationDictionaries.createFromFile({
+    file: fs.createReadStream("/path/to/your/file"),
     name: "name",
 });
 ```
@@ -2982,7 +3043,7 @@ await client.pronunciationDictionaries.download("dictionary_id", "version_id");
 <dl>
 <dd>
 
-**versionId:** `string` — The id of the version of the pronunciation dictionary
+**versionId:** `string` — The id of the pronunciation dictionary version
 
 </dd>
 </dl>
@@ -3029,7 +3090,12 @@ Get a list of the pronunciation dictionaries you have access to and their metada
 <dd>
 
 ```typescript
-await client.pronunciationDictionaries.list();
+await client.pronunciationDictionaries.list({
+    cursor: "cursor",
+    pageSize: 1,
+    sort: "creation_time_unix",
+    sortDirection: "sort_direction",
+});
 ```
 
 </dd>
@@ -3219,6 +3285,8 @@ Transcribe an audio or video file. If webhook is set to true, the request will b
 
 ```typescript
 await client.speechToText.convert({
+    file: fs.createReadStream("/path/to/your/file"),
+    enableLogging: true,
     modelId: "model_id",
 });
 ```
@@ -3353,7 +3421,9 @@ Upload a file or webpage URL to create a knowledge base document. <br> <Note> Af
 <dd>
 
 ```typescript
-await client.conversationalAi.addToKnowledgeBase({});
+await client.conversationalAi.addToKnowledgeBase({
+    agentId: "agent_id",
+});
 ```
 
 </dd>
@@ -3577,80 +3647,6 @@ await client.conversationalAi.ragIndexOverview();
 </dl>
 </details>
 
-<details><summary><code>client.conversationalAi.<a href="/src/api/resources/conversationalAi/client/Client.ts">updateSecret</a>(secretId, { ...params }) -> ElevenLabs.PostWorkspaceSecretResponseModel</code></summary>
-<dl>
-<dd>
-
-#### 📝 Description
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-Update an existing secret for the workspace
-
-</dd>
-</dl>
-</dd>
-</dl>
-
-#### 🔌 Usage
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-```typescript
-await client.conversationalAi.updateSecret("secret_id", {
-    name: "name",
-    value: "value",
-});
-```
-
-</dd>
-</dl>
-</dd>
-</dl>
-
-#### ⚙️ Parameters
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-**secretId:** `string`
-
-</dd>
-</dl>
-
-<dl>
-<dd>
-
-**request:** `ElevenLabs.PatchWorkspaceSecretRequest`
-
-</dd>
-</dl>
-
-<dl>
-<dd>
-
-**requestOptions:** `ConversationalAi.RequestOptions`
-
-</dd>
-</dl>
-</dd>
-</dl>
-
-</dd>
-</dl>
-</details>
-
 ## Music
 
 <details><summary><code>client.music.<a href="/src/api/resources/music/client/Client.ts">compose</a>({ ...params }) -> ReadableStream<Uint8Array></code></summary>
@@ -3682,13 +3678,14 @@ Compose a song from a prompt or a composition plan.
 
 ```typescript
 await client.music.compose({
-    respectSectionsDurations: undefined,
     prompt: undefined,
     musicPrompt: undefined,
     compositionPlan: undefined,
     musicLengthMs: undefined,
     modelId: undefined,
     seed: undefined,
+    forceInstrumental: undefined,
+    respectSectionsDurations: undefined,
 });
 ```
 
@@ -3759,6 +3756,7 @@ await client.music.composeDetailed({
     musicLengthMs: undefined,
     modelId: undefined,
     seed: undefined,
+    forceInstrumental: undefined,
 });
 ```
 
@@ -3829,6 +3827,7 @@ await client.music.stream({
     musicLengthMs: undefined,
     modelId: undefined,
     seed: undefined,
+    forceInstrumental: undefined,
 });
 ```
 
@@ -3896,6 +3895,7 @@ Get a signed url to start a conversation with an agent with an agent that requir
 ```typescript
 await client.conversationalAi.conversations.getSignedUrl({
     agentId: "21m00Tcm4TlvDq8ikWAM",
+    includeConversationId: true,
 });
 ```
 
@@ -3961,6 +3961,7 @@ Get a WebRTC session token for real-time communication.
 ```typescript
 await client.conversationalAi.conversations.getWebrtcToken({
     agentId: "21m00Tcm4TlvDq8ikWAM",
+    participantName: "participant_name",
 });
 ```
 
@@ -4024,7 +4025,16 @@ Get all conversations of agents that user owns. With option to restrict to a spe
 <dd>
 
 ```typescript
-await client.conversationalAi.conversations.list();
+await client.conversationalAi.conversations.list({
+    cursor: "cursor",
+    agentId: "agent_id",
+    callSuccessful: "success",
+    callStartBeforeUnix: 1,
+    callStartAfterUnix: 1,
+    userId: "user_id",
+    pageSize: 1,
+    summaryMode: "exclude",
+});
 ```
 
 </dd>
@@ -4546,7 +4556,13 @@ Returns a list of your agents and their metadata.
 <dd>
 
 ```typescript
-await client.conversationalAi.agents.list();
+await client.conversationalAi.agents.list({
+    pageSize: 1,
+    search: "search",
+    sortDirection: "asc",
+    sortBy: "name",
+    cursor: "cursor",
+});
 ```
 
 </dd>
@@ -5284,7 +5300,11 @@ Lists all agent response tests with pagination support and optional search filte
 <dd>
 
 ```typescript
-await client.conversationalAi.tests.list();
+await client.conversationalAi.tests.list({
+    cursor: "cursor",
+    pageSize: 1,
+    search: "search",
+});
 ```
 
 </dd>
@@ -5741,7 +5761,15 @@ Get a list of available knowledge base documents
 <dd>
 
 ```typescript
-await client.conversationalAi.knowledgeBase.list();
+await client.conversationalAi.knowledgeBase.list({
+    pageSize: 1,
+    search: "search",
+    showOnlyOwnedDocuments: true,
+    sortDirection: "asc",
+    sortBy: "name",
+    useTypesense: true,
+    cursor: "cursor",
+});
 ```
 
 </dd>
@@ -6135,7 +6163,10 @@ Get a list of agents depending on this tool
 <dd>
 
 ```typescript
-await client.conversationalAi.tools.getDependentAgents("tool_id");
+await client.conversationalAi.tools.getDependentAgents("tool_id", {
+    cursor: "cursor",
+    pageSize: 1,
+});
 ```
 
 </dd>
@@ -6484,6 +6515,80 @@ await client.conversationalAi.secrets.delete("secret_id");
 </dl>
 </details>
 
+<details><summary><code>client.conversationalAi.secrets.<a href="/src/api/resources/conversationalAi/resources/secrets/client/Client.ts">update</a>(secretId, { ...params }) -> ElevenLabs.PostWorkspaceSecretResponseModel</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Update an existing secret for the workspace
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.conversationalAi.secrets.update("secret_id", {
+    name: "name",
+    value: "value",
+});
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**secretId:** `string`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**request:** `ElevenLabs.conversationalAi.PatchWorkspaceSecretRequest`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `Secrets.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
 ## ConversationalAi BatchCalls
 
 <details><summary><code>client.conversationalAi.batchCalls.<a href="/src/api/resources/conversationalAi/resources/batchCalls/client/Client.ts">create</a>({ ...params }) -> ElevenLabs.BatchCallResponse</code></summary>
@@ -6586,7 +6691,10 @@ Get all batch calls for the current workspace.
 <dd>
 
 ```typescript
-await client.conversationalAi.batchCalls.list();
+await client.conversationalAi.batchCalls.list({
+    limit: 1,
+    lastDoc: "last_doc",
+});
 ```
 
 </dd>
@@ -7168,7 +7276,9 @@ Retrieve the widget configuration for an agent
 <dd>
 
 ```typescript
-await client.conversationalAi.agents.widget.get("21m00Tcm4TlvDq8ikWAM");
+await client.conversationalAi.agents.widget.get("21m00Tcm4TlvDq8ikWAM", {
+    conversationSignature: "conversation_signature",
+});
 ```
 
 </dd>
@@ -7974,7 +8084,9 @@ Get details about a specific documentation making up the agent's knowledge base
 <dd>
 
 ```typescript
-await client.conversationalAi.knowledgeBase.documents.get("21m00Tcm4TlvDq8ikWAM");
+await client.conversationalAi.knowledgeBase.documents.get("21m00Tcm4TlvDq8ikWAM", {
+    agentId: "agent_id",
+});
 ```
 
 </dd>
@@ -8045,7 +8157,9 @@ Delete a document from the knowledge base
 <dd>
 
 ```typescript
-await client.conversationalAi.knowledgeBase.documents.delete("21m00Tcm4TlvDq8ikWAM");
+await client.conversationalAi.knowledgeBase.documents.delete("21m00Tcm4TlvDq8ikWAM", {
+    force: true,
+});
 ```
 
 </dd>
@@ -8189,7 +8303,10 @@ Get a list of agents depending on this knowledge base document
 <dd>
 
 ```typescript
-await client.conversationalAi.knowledgeBase.documents.getAgents("21m00Tcm4TlvDq8ikWAM");
+await client.conversationalAi.knowledgeBase.documents.getAgents("21m00Tcm4TlvDq8ikWAM", {
+    cursor: "cursor",
+    pageSize: 1,
+});
 ```
 
 </dd>
@@ -8732,6 +8849,73 @@ await client.conversationalAi.mcpServers.toolApprovals.delete("mcp_server_id", "
 
 ## ConversationalAi Tests Invocations
 
+<details><summary><code>client.conversationalAi.tests.invocations.<a href="/src/api/resources/conversationalAi/resources/tests/resources/invocations/client/Client.ts">list</a>({ ...params }) -> ElevenLabs.GetTestInvocationsPageResponseModel</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Lists all test invocations with pagination support and optional search filtering.
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.conversationalAi.tests.invocations.list({
+    agentId: "agent_id",
+    pageSize: 1,
+    cursor: "cursor",
+});
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `ElevenLabs.conversationalAi.tests.InvocationsListRequest`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `Invocations.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
 <details><summary><code>client.conversationalAi.tests.invocations.<a href="/src/api/resources/conversationalAi/resources/tests/resources/invocations/client/Client.ts">get</a>(testInvocationId) -> ElevenLabs.GetTestSuiteInvocationResponseModel</code></summary>
 <dl>
 <dd>
@@ -10585,6 +10769,7 @@ Creates a new Studio project, it can be either initialized as blank, from a docu
 
 ```typescript
 await client.studio.projects.create({
+    fromDocument: fs.createReadStream("/path/to/your/file"),
     name: "name",
 });
 ```
@@ -10649,7 +10834,9 @@ Returns information about a specific Studio project. This endpoint returns more
 <dd>
 
 ```typescript
-await client.studio.projects.get("21m00Tcm4TlvDq8ikWAM");
+await client.studio.projects.get("21m00Tcm4TlvDq8ikWAM", {
+    shareId: "share_id",
+});
 ```
 
 </dd>
@@ -10893,6 +11080,85 @@ await client.studio.projects.convert("21m00Tcm4TlvDq8ikWAM");
 </dl>
 </details>
 
+## Studio Projects PronunciationDictionaries
+
+<details><summary><code>client.studio.projects.pronunciationDictionaries.<a href="/src/api/resources/studio/resources/projects/resources/pronunciationDictionaries/client/Client.ts">create</a>(projectId, { ...params }) -> ElevenLabs.CreatePronunciationDictionaryResponseModel</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+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.
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.studio.projects.pronunciationDictionaries.create("21m00Tcm4TlvDq8ikWAM", {
+    pronunciationDictionaryLocators: [
+        {
+            pronunciationDictionaryId: "pronunciation_dictionary_id",
+        },
+    ],
+});
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**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.
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**request:** `ElevenLabs.studio.projects.BodyCreatePronunciationDictionariesV1StudioProjectsProjectIdPronunciationDictionariesPost`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `PronunciationDictionaries.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
 ## Studio Projects Content
 
 <details><summary><code>client.studio.projects.content.<a href="/src/api/resources/studio/resources/projects/resources/content/client/Client.ts">update</a>(projectId, { ...params }) -> ElevenLabs.EditProjectResponseModel</code></summary>
@@ -10923,7 +11189,9 @@ Updates Studio project content.
 <dd>
 
 ```typescript
-await client.studio.projects.content.update("21m00Tcm4TlvDq8ikWAM", {});
+await client.studio.projects.content.update("21m00Tcm4TlvDq8ikWAM", {
+    fromDocument: fs.createReadStream("/path/to/your/file"),
+});
 ```
 
 </dd>
@@ -11684,85 +11952,6 @@ await client.studio.projects.chapters.convert("21m00Tcm4TlvDq8ikWAM", "21m00Tcm4
 </dl>
 </details>
 
-## Studio Projects PronunciationDictionaries
-
-<details><summary><code>client.studio.projects.pronunciationDictionaries.<a href="/src/api/resources/studio/resources/projects/resources/pronunciationDictionaries/client/Client.ts">create</a>(projectId, { ...params }) -> ElevenLabs.CreatePronunciationDictionaryResponseModel</code></summary>
-<dl>
-<dd>
-
-#### 📝 Description
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-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.
-
-</dd>
-</dl>
-</dd>
-</dl>
-
-#### 🔌 Usage
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-```typescript
-await client.studio.projects.pronunciationDictionaries.create("21m00Tcm4TlvDq8ikWAM", {
-    pronunciationDictionaryLocators: [
-        {
-            pronunciationDictionaryId: "pronunciation_dictionary_id",
-        },
-    ],
-});
-```
-
-</dd>
-</dl>
-</dd>
-</dl>
-
-#### ⚙️ Parameters
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-**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.
-
-</dd>
-</dl>
-
-<dl>
-<dd>
-
-**request:** `ElevenLabs.studio.projects.BodyCreatePronunciationDictionariesV1StudioProjectsProjectIdPronunciationDictionariesPost`
-
-</dd>
-</dl>
-
-<dl>
-<dd>
-
-**requestOptions:** `PronunciationDictionaries.RequestOptions`
-
-</dd>
-</dl>
-</dd>
-</dl>
-
-</dd>
-</dl>
-</details>
-
 ## Studio Projects Chapters Snapshots
 
 <details><summary><code>client.studio.projects.chapters.snapshots.<a href="/src/api/resources/studio/resources/projects/resources/chapters/resources/snapshots/client/Client.ts">list</a>(projectId, chapterId) -> ElevenLabs.ChapterSnapshotsResponse</code></summary>
@@ -12692,7 +12881,7 @@ await client.voices.pvc.samples.create("21m00Tcm4TlvDq8ikWAM", {
 <dl>
 <dd>
 
-Update a PVC voice sample - apply noise removal, or select speaker.
+Update a PVC voice sample - apply noise removal, select speaker, change trim times or file name.
 
 </dd>
 </dl>