@elevenlabs/elevenlabs-js 2.6.0 → 2.8.0

package/reference.md

@@ -1,5 +1,62 @@
 # Reference
 
+<details><summary><code>client.<a href="/src/Client.ts">saveAVoicePreview</a>() -> void</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Add a generated voice to the voice library.
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.saveAVoicePreview();
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**requestOptions:** `ElevenLabsClient.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+##
+
 ## History
 
 <details><summary><code>client.history.<a href="/src/api/resources/history/client/Client.ts">list</a>({ ...params }) -> ElevenLabs.GetSpeechHistoryResponse</code></summary>
@@ -1005,73 +1062,6 @@ await client.textToVoice.createPreviews({
 </dl>
 </details>
 
-<details><summary><code>client.textToVoice.<a href="/src/api/resources/textToVoice/client/Client.ts">createVoiceFromPreview</a>({ ...params }) -> ElevenLabs.Voice</code></summary>
-<dl>
-<dd>
-
-#### 📝 Description
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-Add a generated voice to the voice library.
-
-</dd>
-</dl>
-</dd>
-</dl>
-
-#### 🔌 Usage
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-```typescript
-await client.textToVoice.createVoiceFromPreview({
-    voiceName: "Sassy squeaky mouse",
-    voiceDescription: "A sassy squeaky mouse",
-    generatedVoiceId: "37HceQefKmEi3bGovXjL",
-});
-```
-
-</dd>
-</dl>
-</dd>
-</dl>
-
-#### ⚙️ Parameters
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-**request:** `ElevenLabs.SaveVoicePreviewRequest`
-
-</dd>
-</dl>
-
-<dl>
-<dd>
-
-**requestOptions:** `TextToVoice.RequestOptions`
-
-</dd>
-</dl>
-</dd>
-</dl>
-
-</dd>
-</dl>
-</details>
-
 <details><summary><code>client.textToVoice.<a href="/src/api/resources/textToVoice/client/Client.ts">create</a>({ ...params }) -> ElevenLabs.Voice</code></summary>
 <dl>
 <dd>
@@ -1887,6 +1877,69 @@ await client.studio.createPodcast({
 
 ## Dubbing
 
+<details><summary><code>client.dubbing.<a href="/src/api/resources/dubbing/client/Client.ts">list</a>({ ...params }) -> ElevenLabs.DubbingMetadataPageResponseModel</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+List the dubs you have access to.
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.dubbing.list();
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `ElevenLabs.DubbingListRequest`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `Dubbing.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
 <details><summary><code>client.dubbing.<a href="/src/api/resources/dubbing/client/Client.ts">create</a>({ ...params }) -> ElevenLabs.DoDubbingResponse</code></summary>
 <dl>
 <dd>
@@ -2667,6 +2720,63 @@ await client.pronunciationDictionaries.list();
 </dl>
 </details>
 
+## ServiceAccounts
+
+<details><summary><code>client.serviceAccounts.<a href="/src/api/resources/serviceAccounts/client/Client.ts">list</a>() -> ElevenLabs.WorkspaceServiceAccountListResponseModel</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+List all service accounts in the workspace
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.serviceAccounts.list();
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**requestOptions:** `ServiceAccounts.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
 ## Webhooks
 
 <details><summary><code>client.webhooks.<a href="/src/api/resources/webhooks/client/Client.ts">list</a>({ ...params }) -> ElevenLabs.WorkspaceWebhookListResponseModel</code></summary>
@@ -2736,7 +2846,7 @@ await client.webhooks.list({
 
 ## SpeechToText
 
-<details><summary><code>client.speechToText.<a href="/src/api/resources/speechToText/client/Client.ts">convert</a>({ ...params }) -> ElevenLabs.SpeechToTextChunkResponseModel</code></summary>
+<details><summary><code>client.speechToText.<a href="/src/api/resources/speechToText/client/Client.ts">convert</a>({ ...params }) -> ElevenLabs.SpeechToTextConvertResponse</code></summary>
 <dl>
 <dd>
 
@@ -2748,7 +2858,7 @@ await client.webhooks.list({
 <dl>
 <dd>
 
-Transcribe an audio or video file. If webhook is set to true, the request will be processed asynchronously and results sent to configured webhooks.
+Transcribe an audio or video file. If webhook is set to true, the request will be processed asynchronously and results sent to configured webhooks. When use_multi_channel is true and the provided audio has multiple channels, a 'transcripts' object with separate transcripts for each channel is returned. Otherwise, returns a single transcript.
 
 </dd>
 </dl>
@@ -3264,7 +3374,7 @@ await client.conversationalAi.conversations.getSignedUrl({
 </dl>
 </details>
 
-<details><summary><code>client.conversationalAi.conversations.<a href="/src/api/resources/conversationalAi/resources/conversations/client/Client.ts">list</a>({ ...params }) -> ElevenLabs.GetConversationsPageResponseModel</code></summary>
+<details><summary><code>client.conversationalAi.conversations.<a href="/src/api/resources/conversationalAi/resources/conversations/client/Client.ts">getWebrtcToken</a>({ ...params }) -> ElevenLabs.TokenResponseModel</code></summary>
 <dl>
 <dd>
 
@@ -3276,7 +3386,7 @@ await client.conversationalAi.conversations.getSignedUrl({
 <dl>
 <dd>
 
-Get all conversations of agents that user owns. With option to restrict to a specific agent.
+Get a WebRTC session token for real-time communication.
 
 </dd>
 </dl>
@@ -3292,7 +3402,9 @@ 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.getWebrtcToken({
+    agentId: "21m00Tcm4TlvDq8ikWAM",
+});
 ```
 
 </dd>
@@ -3308,7 +3420,7 @@ await client.conversationalAi.conversations.list();
 <dl>
 <dd>
 
-**request:** `ElevenLabs.conversationalAi.ConversationsListRequest`
+**request:** `ElevenLabs.conversationalAi.ConversationsGetWebrtcTokenRequest`
 
 </dd>
 </dl>
@@ -3327,7 +3439,7 @@ await client.conversationalAi.conversations.list();
 </dl>
 </details>
 
-<details><summary><code>client.conversationalAi.conversations.<a href="/src/api/resources/conversationalAi/resources/conversations/client/Client.ts">get</a>(conversationId) -> ElevenLabs.GetConversationResponseModel</code></summary>
+<details><summary><code>client.conversationalAi.conversations.<a href="/src/api/resources/conversationalAi/resources/conversations/client/Client.ts">list</a>({ ...params }) -> ElevenLabs.GetConversationsPageResponseModel</code></summary>
 <dl>
 <dd>
 
@@ -3339,7 +3451,7 @@ await client.conversationalAi.conversations.list();
 <dl>
 <dd>
 
-Get the details of a particular conversation
+Get all conversations of agents that user owns. With option to restrict to a specific agent.
 
 </dd>
 </dl>
@@ -3355,7 +3467,7 @@ Get the details of a particular conversation
 <dd>
 
 ```typescript
-await client.conversationalAi.conversations.get("123");
+await client.conversationalAi.conversations.list();
 ```
 
 </dd>
@@ -3371,7 +3483,7 @@ await client.conversationalAi.conversations.get("123");
 <dl>
 <dd>
 
-**conversationId:** `string` — The id of the conversation you're taking the action on.
+**request:** `ElevenLabs.conversationalAi.ConversationsListRequest`
 
 </dd>
 </dl>
@@ -3390,7 +3502,7 @@ await client.conversationalAi.conversations.get("123");
 </dl>
 </details>
 
-<details><summary><code>client.conversationalAi.conversations.<a href="/src/api/resources/conversationalAi/resources/conversations/client/Client.ts">delete</a>(conversationId) -> unknown</code></summary>
+<details><summary><code>client.conversationalAi.conversations.<a href="/src/api/resources/conversationalAi/resources/conversations/client/Client.ts">get</a>(conversationId) -> ElevenLabs.GetConversationResponseModel</code></summary>
 <dl>
 <dd>
 
@@ -3402,7 +3514,7 @@ await client.conversationalAi.conversations.get("123");
 <dl>
 <dd>
 
-Delete a particular conversation
+Get the details of a particular conversation
 
 </dd>
 </dl>
@@ -3418,7 +3530,7 @@ Delete a particular conversation
 <dd>
 
 ```typescript
-await client.conversationalAi.conversations.delete("21m00Tcm4TlvDq8ikWAM");
+await client.conversationalAi.conversations.get("123");
 ```
 
 </dd>
@@ -3453,9 +3565,7 @@ await client.conversationalAi.conversations.delete("21m00Tcm4TlvDq8ikWAM");
 </dl>
 </details>
 
-## ConversationalAi Twilio
-
-<details><summary><code>client.conversationalAi.twilio.<a href="/src/api/resources/conversationalAi/resources/twilio/client/Client.ts">outboundCall</a>({ ...params }) -> ElevenLabs.TwilioOutboundCallResponse</code></summary>
+<details><summary><code>client.conversationalAi.conversations.<a href="/src/api/resources/conversationalAi/resources/conversations/client/Client.ts">delete</a>(conversationId) -> unknown</code></summary>
 <dl>
 <dd>
 
@@ -3467,7 +3577,7 @@ await client.conversationalAi.conversations.delete("21m00Tcm4TlvDq8ikWAM");
 <dl>
 <dd>
 
-Handle an outbound call via Twilio
+Delete a particular conversation
 
 </dd>
 </dl>
@@ -3483,8 +3593,73 @@ Handle an outbound call via Twilio
 <dd>
 
 ```typescript
-await client.conversationalAi.twilio.outboundCall({
-    agentId: "agent_id",
+await client.conversationalAi.conversations.delete("21m00Tcm4TlvDq8ikWAM");
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**conversationId:** `string` — The id of the conversation you're taking the action on.
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `Conversations.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+## ConversationalAi Twilio
+
+<details><summary><code>client.conversationalAi.twilio.<a href="/src/api/resources/conversationalAi/resources/twilio/client/Client.ts">outboundCall</a>({ ...params }) -> ElevenLabs.TwilioOutboundCallResponse</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Handle an outbound call via Twilio
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.conversationalAi.twilio.outboundCall({
+    agentId: "agent_id",
     agentPhoneNumberId: "agent_phone_number_id",
     toNumber: "to_number",
 });
@@ -3951,7 +4126,7 @@ Run a conversation between the agent and a simulated user.
 await client.conversationalAi.agents.simulateConversation("21m00Tcm4TlvDq8ikWAM", {
     simulationSpecification: {
         simulatedUserConfig: {
-            first_message: "Hello, how can I help you today?",
+            firstMessage: "Hello, how can I help you today?",
             language: "en",
         },
     },
@@ -4029,7 +4204,7 @@ Run a conversation between the agent and a simulated user and stream back the re
 await client.conversationalAi.agents.simulateConversationStream("21m00Tcm4TlvDq8ikWAM", {
     simulationSpecification: {
         simulatedUserConfig: {
-            first_message: "Hello, how can I help you today?",
+            firstMessage: "Hello, how can I help you today?",
             language: "en",
         },
     },
@@ -8424,6 +8599,299 @@ await client.pronunciationDictionaries.rules.remove("21m00Tcm4TlvDq8ikWAM", {
 </dl>
 </details>
 
+## ServiceAccounts ApiKeys
+
+<details><summary><code>client.serviceAccounts.apiKeys.<a href="/src/api/resources/serviceAccounts/resources/apiKeys/client/Client.ts">list</a>(serviceAccountUserId) -> ElevenLabs.WorkspaceApiKeyListResponseModel</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Get all API keys for a service account
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.serviceAccounts.apiKeys.list("service_account_user_id");
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**serviceAccountUserId:** `string`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `ApiKeys.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.serviceAccounts.apiKeys.<a href="/src/api/resources/serviceAccounts/resources/apiKeys/client/Client.ts">create</a>(serviceAccountUserId, { ...params }) -> ElevenLabs.WorkspaceCreateApiKeyResponseModel</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Create a new API key for a service account
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.serviceAccounts.apiKeys.create("service_account_user_id", {
+    name: "name",
+    permissions: ["text_to_speech"],
+});
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**serviceAccountUserId:** `string`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**request:** `ElevenLabs.serviceAccounts.BodyCreateServiceAccountApiKeyV1ServiceAccountsServiceAccountUserIdApiKeysPost`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `ApiKeys.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.serviceAccounts.apiKeys.<a href="/src/api/resources/serviceAccounts/resources/apiKeys/client/Client.ts">delete</a>(serviceAccountUserId, apiKeyId) -> unknown</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Delete an existing API key for a service account
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.serviceAccounts.apiKeys.delete("service_account_user_id", "api_key_id");
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**serviceAccountUserId:** `string`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**apiKeyId:** `string`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `ApiKeys.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.serviceAccounts.apiKeys.<a href="/src/api/resources/serviceAccounts/resources/apiKeys/client/Client.ts">update</a>(serviceAccountUserId, apiKeyId, { ...params }) -> unknown</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Update an existing API key for a service account
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.serviceAccounts.apiKeys.update("service_account_user_id", "api_key_id", {
+    isEnabled: true,
+    name: "Sneaky Fox",
+    permissions: ["text_to_speech"],
+});
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**serviceAccountUserId:** `string`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**apiKeyId:** `string`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**request:** `ElevenLabs.serviceAccounts.BodyEditServiceAccountApiKeyV1ServiceAccountsServiceAccountUserIdApiKeysApiKeyIdPatch`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `ApiKeys.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
 ## Studio Projects
 
 <details><summary><code>client.studio.projects.<a href="/src/api/resources/studio/resources/projects/client/Client.ts">list</a>() -> ElevenLabs.GetProjectsResponse</code></summary>
@@ -8511,9 +8979,6 @@ Creates a new Studio project, it can be either initialized as blank, from a docu
 ```typescript
 await client.studio.projects.create({
     name: "name",
-    defaultTitleVoiceId: "default_title_voice_id",
-    defaultParagraphVoiceId: "default_paragraph_voice_id",
-    defaultModelId: "default_model_id",
 });
 ```