@elevenlabs/elevenlabs-js 2.38.1 → 2.40.0

package/reference.md

@@ -4026,6 +4026,281 @@ await client.conversationalAi.deleteDocumentRagIndex("21m00Tcm4TlvDq8ikWAM", "21
 </dl>
 
 
+</dd>
+</dl>
+</details>
+
+## EnvironmentVariables
+<details><summary><code>client.environmentVariables.<a href="/src/api/resources/environmentVariables/client/Client.ts">list</a>({ ...params }) -> ElevenLabs.EnvironmentVariablesListResponse</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+List all environment variables for the workspace with optional filtering
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.environmentVariables.list({
+    cursor: "cursor",
+    pageSize: 1,
+    label: "label",
+    environment: "environment",
+    type: "string"
+});
+
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `ElevenLabs.EnvironmentVariablesListRequest` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `EnvironmentVariablesClient.RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.environmentVariables.<a href="/src/api/resources/environmentVariables/client/Client.ts">create</a>({ ...params }) -> ElevenLabs.EnvironmentVariableResponse</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Create a new environment variable for the workspace
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.environmentVariables.create({
+    type: "string",
+    label: "label",
+    values: {
+        "key": "value"
+    }
+});
+
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `ElevenLabs.EnvironmentVariablesCreateRequestBody` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `EnvironmentVariablesClient.RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.environmentVariables.<a href="/src/api/resources/environmentVariables/client/Client.ts">get</a>(env_var_id) -> ElevenLabs.EnvironmentVariableResponse</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Get a specific environment variable by ID
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.environmentVariables.get("env_var_id");
+
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**env_var_id:** `string` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `EnvironmentVariablesClient.RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.environmentVariables.<a href="/src/api/resources/environmentVariables/client/Client.ts">update</a>(env_var_id, { ...params }) -> ElevenLabs.EnvironmentVariableResponse</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Replace an environment variable's values. Use null to remove an environment (except production).
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.environmentVariables.update("env_var_id", {
+    values: {}
+});
+
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**env_var_id:** `string` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**request:** `ElevenLabs.UpdateEnvironmentVariableRequest` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `EnvironmentVariablesClient.RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
 </dd>
 </dl>
 </details>
@@ -4316,7 +4591,8 @@ Get a signed url to start a conversation with an agent with an agent that requir
 await client.conversationalAi.conversations.getSignedUrl({
     agentId: "21m00Tcm4TlvDq8ikWAM",
     includeConversationId: true,
-    branchId: "branch_id"
+    branchId: "branch_id",
+    environment: "environment"
 });
 
 ```
@@ -4383,7 +4659,8 @@ Get a WebRTC session token for real-time communication.
 await client.conversationalAi.conversations.getWebrtcToken({
     agentId: "21m00Tcm4TlvDq8ikWAM",
     participantName: "participant_name",
-    branchId: "branch_id"
+    branchId: "branch_id",
+    environment: "environment"
 });
 
 ```
@@ -5216,6 +5493,7 @@ await client.conversationalAi.agents.list({
     search: "search",
     archived: true,
     showOnlyOwnedAgents: true,
+    createdByUserId: "created_by_user_id",
     sortDirection: "asc",
     sortBy: "name",
     cursor: "cursor"
@@ -5991,10 +6269,12 @@ Get distinct users from conversations with pagination.
 ```typescript
 await client.conversationalAi.users.list({
     agentId: "agent_id",
+    branchId: "branch_id",
     callStartBeforeUnix: 1,
     callStartAfterUnix: 1,
     search: "search",
     pageSize: 1,
+    sortBy: "last_contact_unix_secs",
     cursor: "cursor"
 });
 
@@ -6510,6 +6790,7 @@ await client.conversationalAi.knowledgeBase.list({
     pageSize: 1,
     search: "search",
     showOnlyOwnedDocuments: true,
+    createdByUserId: "created_by_user_id",
     parentFolderId: "parent_folder_id",
     ancestorFolderId: "ancestor_folder_id",
     foldersFirst: true,
@@ -6653,6 +6934,7 @@ await client.conversationalAi.tools.list({
     search: "search",
     pageSize: 1,
     showOnlyOwnedDocuments: true,
+    createdByUserId: "created_by_user_id",
     sortDirection: "asc",
     sortBy: "name",
     cursor: "cursor"
@@ -6825,7 +7107,7 @@ await client.conversationalAi.tools.get("tool_id");
 </dl>
 </details>
 
-<details><summary><code>client.conversationalAi.tools.<a href="/src/api/resources/conversationalAi/resources/tools/client/Client.ts">delete</a>(tool_id) -> unknown</code></summary>
+<details><summary><code>client.conversationalAi.tools.<a href="/src/api/resources/conversationalAi/resources/tools/client/Client.ts">delete</a>(tool_id, { ...params }) -> unknown</code></summary>
 <dl>
 <dd>
 
@@ -6852,7 +7134,9 @@ Delete tool from the workspace.
 <dd>
 
 ```typescript
-await client.conversationalAi.tools.delete("tool_id");
+await client.conversationalAi.tools.delete("tool_id", {
+    force: true
+});
 
 ```
 </dd>
@@ -6876,6 +7160,14 @@ await client.conversationalAi.tools.delete("tool_id");
 <dl>
 <dd>
 
+**request:** `ElevenLabs.conversationalAi.ToolsDeleteRequest` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
 **requestOptions:** `ToolsClient.RequestOptions` 
     
 </dd>
@@ -10941,7 +11233,78 @@ await client.conversationalAi.knowledgeBase.documents.getSourceFileUrl("21m00Tcm
 <dl>
 <dd>
 
-Moves the entity from one folder to another.
+Moves the entity from one folder to another.
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.conversationalAi.knowledgeBase.documents.move("21m00Tcm4TlvDq8ikWAM");
+
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**document_id:** `string` — The id of a document from the knowledge base. This is returned on document addition.
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**request:** `ElevenLabs.conversationalAi.knowledgeBase.BodyMoveEntityToFolderV1ConvaiKnowledgeBaseDocumentIdMovePost` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `DocumentsClient.RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.conversationalAi.knowledgeBase.documents.<a href="/src/api/resources/conversationalAi/resources/knowledgeBase/resources/documents/client/Client.ts">bulkMove</a>({ ...params }) -> void</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Moves multiple entities from one folder to another.
 </dd>
 </dl>
 </dd>
@@ -10956,7 +11319,9 @@ Moves the entity from one folder to another.
 <dd>
 
 ```typescript
-await client.conversationalAi.knowledgeBase.documents.move("21m00Tcm4TlvDq8ikWAM");
+await client.conversationalAi.knowledgeBase.documents.bulkMove({
+    documentIds: ["21m00Tcm4TlvDq8ikWAM", "31m00Tcm4TlvDq8ikWBM"]
+});
 
 ```
 </dd>
@@ -10972,15 +11337,7 @@ await client.conversationalAi.knowledgeBase.documents.move("21m00Tcm4TlvDq8ikWAM
 <dl>
 <dd>
 
-**document_id:** `string` — The id of a document from the knowledge base. This is returned on document addition.
-    
-</dd>
-</dl>
-
-<dl>
-<dd>
-
-**request:** `ElevenLabs.conversationalAi.knowledgeBase.BodyMoveEntityToFolderV1ConvaiKnowledgeBaseDocumentIdMovePost` 
+**request:** `ElevenLabs.conversationalAi.knowledgeBase.BodyBulkMoveEntitiesToFolderV1ConvaiKnowledgeBaseBulkMovePost` 
     
 </dd>
 </dl>
@@ -11000,7 +11357,8 @@ await client.conversationalAi.knowledgeBase.documents.move("21m00Tcm4TlvDq8ikWAM
 </dl>
 </details>
 
-<details><summary><code>client.conversationalAi.knowledgeBase.documents.<a href="/src/api/resources/conversationalAi/resources/knowledgeBase/resources/documents/client/Client.ts">bulkMove</a>({ ...params }) -> void</code></summary>
+## ConversationalAi KnowledgeBase Document
+<details><summary><code>client.conversationalAi.knowledgeBase.document.<a href="/src/api/resources/conversationalAi/resources/knowledgeBase/resources/document/client/Client.ts">refresh</a>(documentation_id) -> ElevenLabs.DocumentRefreshResponse</code></summary>
 <dl>
 <dd>
 
@@ -11012,7 +11370,7 @@ await client.conversationalAi.knowledgeBase.documents.move("21m00Tcm4TlvDq8ikWAM
 <dl>
 <dd>
 
-Moves multiple entities from one folder to another.
+Manually refresh a URL document by re-fetching its content from the source URL.
 </dd>
 </dl>
 </dd>
@@ -11027,9 +11385,7 @@ Moves multiple entities from one folder to another.
 <dd>
 
 ```typescript
-await client.conversationalAi.knowledgeBase.documents.bulkMove({
-    documentIds: ["21m00Tcm4TlvDq8ikWAM", "31m00Tcm4TlvDq8ikWBM"]
-});
+await client.conversationalAi.knowledgeBase.document.refresh("21m00Tcm4TlvDq8ikWAM");
 
 ```
 </dd>
@@ -11045,7 +11401,7 @@ await client.conversationalAi.knowledgeBase.documents.bulkMove({
 <dl>
 <dd>
 
-**request:** `ElevenLabs.conversationalAi.knowledgeBase.BodyBulkMoveEntitiesToFolderV1ConvaiKnowledgeBaseBulkMovePost` 
+**documentation_id:** `string` — The id of a document from the knowledge base. This is returned on document addition.
     
 </dd>
 </dl>
@@ -11053,7 +11409,7 @@ await client.conversationalAi.knowledgeBase.documents.bulkMove({
 <dl>
 <dd>
 
-**requestOptions:** `DocumentsClient.RequestOptions` 
+**requestOptions:** `DocumentClient.RequestOptions` 
     
 </dd>
 </dl>
@@ -11065,7 +11421,6 @@ await client.conversationalAi.knowledgeBase.documents.bulkMove({
 </dl>
 </details>
 
-## ConversationalAi KnowledgeBase Document
 <details><summary><code>client.conversationalAi.knowledgeBase.document.<a href="/src/api/resources/conversationalAi/resources/knowledgeBase/resources/document/client/Client.ts">computeRagIndex</a>(documentation_id, { ...params }) -> ElevenLabs.RagDocumentIndexResponseModel</code></summary>
 <dl>
 <dd>
@@ -11204,7 +11559,7 @@ await client.conversationalAi.knowledgeBase.documents.summaries.get();
 </details>
 
 ## ConversationalAi KnowledgeBase Documents Chunk
-<details><summary><code>client.conversationalAi.knowledgeBase.documents.chunk.<a href="/src/api/resources/conversationalAi/resources/knowledgeBase/resources/documents/resources/chunk/client/Client.ts">get</a>(documentation_id, chunk_id) -> ElevenLabs.KnowledgeBaseDocumentChunkResponseModel</code></summary>
+<details><summary><code>client.conversationalAi.knowledgeBase.documents.chunk.<a href="/src/api/resources/conversationalAi/resources/knowledgeBase/resources/documents/resources/chunk/client/Client.ts">get</a>(documentation_id, chunk_id, { ...params }) -> ElevenLabs.KnowledgeBaseDocumentChunkResponseModel</code></summary>
 <dl>
 <dd>
 
@@ -11231,7 +11586,9 @@ Get details about a specific documentation part used by RAG.
 <dd>
 
 ```typescript
-await client.conversationalAi.knowledgeBase.documents.chunk.get("21m00Tcm4TlvDq8ikWAM", "chunk_id");
+await client.conversationalAi.knowledgeBase.documents.chunk.get("21m00Tcm4TlvDq8ikWAM", "chunk_id", {
+    embeddingModel: "e5_mistral_7b_instruct"
+});
 
 ```
 </dd>
@@ -11263,6 +11620,14 @@ await client.conversationalAi.knowledgeBase.documents.chunk.get("21m00Tcm4TlvDq8
 <dl>
 <dd>
 
+**request:** `ElevenLabs.conversationalAi.knowledgeBase.documents.ChunkGetRequest` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
 **requestOptions:** `ChunkClient.RequestOptions` 
     
 </dd>
@@ -17064,11 +17429,255 @@ await client.voices.samples.audio.get("voice_id", "sample_id");
 </dl>
 
 
+</dd>
+</dl>
+</details>
+
+## Workspace AuthConnections
+<details><summary><code>client.workspace.authConnections.<a href="/src/api/resources/workspace/resources/authConnections/client/Client.ts">list</a>() -> ElevenLabs.ListAuthConnectionsResponse</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Get all auth connections for the workspace
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.workspace.authConnections.list();
+
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**requestOptions:** `AuthConnectionsClient.RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.workspace.authConnections.<a href="/src/api/resources/workspace/resources/authConnections/client/Client.ts">create</a>({ ...params }) -> ElevenLabs.AuthConnectionsCreateResponse</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Create a new OAuth2 auth connection for the workspace
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.workspace.authConnections.create({
+    authType: "oauth2_client_credentials",
+    name: "name",
+    provider: "provider",
+    clientId: "client_id",
+    tokenUrl: "token_url",
+    clientSecret: "client_secret"
+});
+
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `ElevenLabs.AuthConnectionsCreateRequestBody` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `AuthConnectionsClient.RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.workspace.authConnections.<a href="/src/api/resources/workspace/resources/authConnections/client/Client.ts">delete</a>(auth_connection_id) -> unknown</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Delete an auth connection
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.workspace.authConnections.delete("auth_connection_id");
+
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**auth_connection_id:** `string` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `AuthConnectionsClient.RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
 </dd>
 </dl>
 </details>
 
 ## Workspace Groups
+<details><summary><code>client.workspace.groups.<a href="/src/api/resources/workspace/resources/groups/client/Client.ts">list</a>() -> Record<string, ElevenLabs.WorkspaceGroupResponseModel></code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Get all groups in the workspace
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.workspace.groups.list();
+
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**requestOptions:** `GroupsClient.RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
+</dd>
+</dl>
+</details>
+
 <details><summary><code>client.workspace.groups.<a href="/src/api/resources/workspace/resources/groups/client/Client.ts">search</a>({ ...params }) -> ElevenLabs.WorkspaceGroupByNameResponseModel[]</code></summary>
 <dl>
 <dd>