@elevenlabs/elevenlabs-js 2.3.0 → 2.4.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/Client.js +2 -2
- package/api/resources/conversationalAi/client/Client.d.ts +3 -0
- package/api/resources/conversationalAi/client/Client.js +17 -12
- package/api/resources/conversationalAi/resources/agents/client/Client.d.ts +14 -0
- package/api/resources/conversationalAi/resources/agents/client/Client.js +74 -0
- package/api/resources/conversationalAi/resources/agents/client/requests/BodyDuplicateAgentV1ConvaiAgentsAgentIdDuplicatePost.d.ts +11 -0
- package/api/resources/conversationalAi/resources/agents/client/requests/index.d.ts +1 -0
- package/api/resources/conversationalAi/resources/index.d.ts +2 -0
- package/api/resources/conversationalAi/resources/index.js +3 -1
- package/api/resources/conversationalAi/resources/tools/client/Client.d.ts +126 -0
- package/api/resources/conversationalAi/resources/tools/client/Client.js +506 -0
- package/api/resources/conversationalAi/resources/tools/client/index.d.ts +2 -0
- package/api/resources/conversationalAi/resources/tools/client/index.js +17 -0
- package/api/resources/conversationalAi/resources/tools/client/requests/ToolsGetDependentAgentsRequest.d.ts +17 -0
- package/api/resources/conversationalAi/resources/tools/client/requests/index.d.ts +1 -0
- package/api/resources/conversationalAi/resources/tools/client/requests/index.js +2 -0
- package/api/resources/conversationalAi/resources/tools/index.d.ts +1 -0
- package/api/resources/conversationalAi/resources/tools/index.js +17 -0
- package/api/resources/dubbing/client/Client.js +3 -0
- package/api/resources/dubbing/client/requests/BodyDubAVideoOrAnAudioFileV1DubbingPost.d.ts +2 -0
- package/api/resources/textToVoice/client/Client.d.ts +32 -0
- package/api/resources/textToVoice/client/Client.js +162 -0
- package/api/resources/textToVoice/client/requests/BodyCreateANewVoiceFromVoicePreviewV1TextToVoicePost.d.ts +23 -0
- package/api/resources/textToVoice/client/requests/VoiceDesignRequestModel.d.ts +36 -0
- package/api/resources/textToVoice/client/requests/index.d.ts +2 -0
- package/api/resources/textToVoice/types/TextToVoiceDesignRequestOutputFormat.d.ts +28 -0
- package/api/resources/textToVoice/types/TextToVoiceDesignRequestOutputFormat.js +27 -0
- package/api/resources/textToVoice/types/VoiceDesignRequestModelModelId.d.ts +11 -0
- package/api/resources/textToVoice/types/VoiceDesignRequestModelModelId.js +10 -0
- package/api/resources/textToVoice/types/index.d.ts +2 -0
- package/api/resources/textToVoice/types/index.js +2 -0
- package/api/resources/workspace/client/Client.d.ts +39 -0
- package/api/resources/workspace/client/Client.js +205 -0
- package/api/resources/workspace/client/requests/BodyUpdateDefaultSharingPreferencesV1WorkspaceDefaultSharingPreferencesPost.d.ts +13 -0
- package/api/resources/workspace/client/requests/index.d.ts +1 -0
- package/api/types/AgentConfigOverride.d.ts +1 -1
- package/api/types/AgentConfigOverrideConfig.d.ts +1 -1
- package/api/types/AsrProvider.d.ts +5 -1
- package/api/types/AsrProvider.js +5 -0
- package/api/types/{BuiltInTools.d.ts → BuiltInToolsInput.d.ts} +1 -1
- package/api/types/BuiltInToolsOutput.d.ts +16 -0
- package/api/types/ClientToolConfigInput.d.ts +0 -1
- package/api/types/ClientToolConfigOutput.d.ts +0 -1
- package/api/types/ConvAiStoredSecretDependencies.d.ts +1 -1
- package/api/types/ConvAiStoredSecretDependenciesAgentsItem.d.ts +13 -0
- package/api/types/ConversationChargingCommonModel.d.ts +2 -0
- package/api/types/DefaultSharingPreferencesResponseModel.d.ts +8 -0
- package/api/types/GetToolDependentAgentsResponseModel.d.ts +9 -0
- package/api/types/GetToolDependentAgentsResponseModelAgentsItem.d.ts +13 -0
- package/api/types/McpToolConfigInput.d.ts +0 -1
- package/api/types/McpToolConfigOutput.d.ts +0 -1
- package/api/types/PromptAgent.d.ts +1 -27
- package/api/types/PromptAgentApiModelInput.d.ts +32 -0
- package/{dist/api/types/PromptAgentInputToolsItem.d.ts → api/types/PromptAgentApiModelInputToolsItem.d.ts} +2 -2
- package/api/types/PromptAgentApiModelOutput.d.ts +32 -0
- package/api/types/PromptAgentApiModelOutputToolsItem.d.ts +22 -0
- package/api/types/{PromptAgentOverride.d.ts → PromptAgentApiModelOverride.d.ts} +1 -1
- package/api/types/{PromptAgentOverrideConfig.d.ts → PromptAgentApiModelOverrideConfig.d.ts} +1 -1
- package/api/types/PromptAgentDbModel.d.ts +3 -3
- package/api/types/SystemToolConfigInput.d.ts +0 -1
- package/api/types/SystemToolConfigOutput.d.ts +0 -1
- package/api/types/ToolRequestModel.d.ts +8 -0
- package/{dist/api/types/PromptAgentDbModelToolsItem.d.ts → api/types/ToolRequestModelToolConfig.d.ts} +3 -3
- package/api/types/ToolRequestModelToolConfig.js +5 -0
- package/api/types/ToolResponseModel.d.ts +10 -0
- package/api/types/ToolResponseModel.js +5 -0
- package/api/types/{PromptAgentOutputToolsItem.d.ts → ToolResponseModelToolConfig.d.ts} +2 -2
- package/api/types/ToolResponseModelToolConfig.js +5 -0
- package/api/types/ToolsResponseModel.d.ts +7 -0
- package/api/types/ToolsResponseModel.js +5 -0
- package/api/types/WebhookToolConfigInput.d.ts +0 -1
- package/api/types/WebhookToolConfigOutput.d.ts +0 -1
- package/api/types/WorkspaceGroupPermission.d.ts +22 -0
- package/api/types/WorkspaceGroupPermission.js +24 -0
- package/api/types/WorkspaceGroupResponseModel.d.ts +10 -0
- package/api/types/WorkspaceGroupResponseModel.js +5 -0
- package/api/types/index.d.ts +20 -11
- package/api/types/index.js +20 -11
- package/dist/Client.js +2 -2
- package/dist/api/resources/conversationalAi/client/Client.d.ts +3 -0
- package/dist/api/resources/conversationalAi/client/Client.js +17 -12
- package/dist/api/resources/conversationalAi/resources/agents/client/Client.d.ts +14 -0
- package/dist/api/resources/conversationalAi/resources/agents/client/Client.js +74 -0
- package/dist/api/resources/conversationalAi/resources/agents/client/requests/BodyDuplicateAgentV1ConvaiAgentsAgentIdDuplicatePost.d.ts +11 -0
- package/dist/api/resources/conversationalAi/resources/agents/client/requests/BodyDuplicateAgentV1ConvaiAgentsAgentIdDuplicatePost.js +5 -0
- package/dist/api/resources/conversationalAi/resources/agents/client/requests/index.d.ts +1 -0
- package/dist/api/resources/conversationalAi/resources/index.d.ts +2 -0
- package/dist/api/resources/conversationalAi/resources/index.js +3 -1
- package/dist/api/resources/conversationalAi/resources/tools/client/Client.d.ts +126 -0
- package/dist/api/resources/conversationalAi/resources/tools/client/Client.js +506 -0
- package/dist/api/resources/conversationalAi/resources/tools/client/index.d.ts +2 -0
- package/dist/api/resources/conversationalAi/resources/tools/client/index.js +17 -0
- package/dist/api/resources/conversationalAi/resources/tools/client/requests/ToolsGetDependentAgentsRequest.d.ts +17 -0
- package/dist/api/resources/conversationalAi/resources/tools/client/requests/ToolsGetDependentAgentsRequest.js +5 -0
- package/dist/api/resources/conversationalAi/resources/tools/client/requests/index.d.ts +1 -0
- package/dist/api/resources/conversationalAi/resources/tools/client/requests/index.js +2 -0
- package/dist/api/resources/conversationalAi/resources/tools/index.d.ts +1 -0
- package/dist/api/resources/conversationalAi/resources/tools/index.js +17 -0
- package/dist/api/resources/dubbing/client/Client.js +3 -0
- package/dist/api/resources/dubbing/client/requests/BodyDubAVideoOrAnAudioFileV1DubbingPost.d.ts +2 -0
- package/dist/api/resources/textToVoice/client/Client.d.ts +32 -0
- package/dist/api/resources/textToVoice/client/Client.js +162 -0
- package/dist/api/resources/textToVoice/client/requests/BodyCreateANewVoiceFromVoicePreviewV1TextToVoicePost.d.ts +23 -0
- package/dist/api/resources/textToVoice/client/requests/BodyCreateANewVoiceFromVoicePreviewV1TextToVoicePost.js +5 -0
- package/dist/api/resources/textToVoice/client/requests/VoiceDesignRequestModel.d.ts +36 -0
- package/dist/api/resources/textToVoice/client/requests/VoiceDesignRequestModel.js +5 -0
- package/dist/api/resources/textToVoice/client/requests/index.d.ts +2 -0
- package/dist/api/resources/textToVoice/types/TextToVoiceDesignRequestOutputFormat.d.ts +28 -0
- package/dist/api/resources/textToVoice/types/TextToVoiceDesignRequestOutputFormat.js +27 -0
- package/dist/api/resources/textToVoice/types/VoiceDesignRequestModelModelId.d.ts +11 -0
- package/dist/api/resources/textToVoice/types/VoiceDesignRequestModelModelId.js +10 -0
- package/dist/api/resources/textToVoice/types/index.d.ts +2 -0
- package/dist/api/resources/textToVoice/types/index.js +2 -0
- package/dist/api/resources/workspace/client/Client.d.ts +39 -0
- package/dist/api/resources/workspace/client/Client.js +205 -0
- package/dist/api/resources/workspace/client/requests/BodyUpdateDefaultSharingPreferencesV1WorkspaceDefaultSharingPreferencesPost.d.ts +13 -0
- package/dist/api/resources/workspace/client/requests/BodyUpdateDefaultSharingPreferencesV1WorkspaceDefaultSharingPreferencesPost.js +5 -0
- package/dist/api/resources/workspace/client/requests/index.d.ts +1 -0
- package/dist/api/types/AgentConfigOverride.d.ts +1 -1
- package/dist/api/types/AgentConfigOverrideConfig.d.ts +1 -1
- package/dist/api/types/AsrProvider.d.ts +5 -1
- package/dist/api/types/AsrProvider.js +5 -0
- package/dist/api/types/{BuiltInTools.d.ts → BuiltInToolsInput.d.ts} +1 -1
- package/dist/api/types/BuiltInToolsInput.js +5 -0
- package/dist/api/types/BuiltInToolsOutput.d.ts +16 -0
- package/dist/api/types/BuiltInToolsOutput.js +5 -0
- package/dist/api/types/ClientToolConfigInput.d.ts +0 -1
- package/dist/api/types/ClientToolConfigOutput.d.ts +0 -1
- package/dist/api/types/ConvAiStoredSecretDependencies.d.ts +1 -1
- package/dist/api/types/ConvAiStoredSecretDependenciesAgentsItem.d.ts +13 -0
- package/dist/api/types/ConvAiStoredSecretDependenciesAgentsItem.js +5 -0
- package/dist/api/types/ConversationChargingCommonModel.d.ts +2 -0
- package/dist/api/types/DefaultSharingPreferencesResponseModel.d.ts +8 -0
- package/dist/api/types/DefaultSharingPreferencesResponseModel.js +5 -0
- package/dist/api/types/GetToolDependentAgentsResponseModel.d.ts +9 -0
- package/dist/api/types/GetToolDependentAgentsResponseModel.js +5 -0
- package/dist/api/types/GetToolDependentAgentsResponseModelAgentsItem.d.ts +13 -0
- package/dist/api/types/GetToolDependentAgentsResponseModelAgentsItem.js +5 -0
- package/dist/api/types/McpToolConfigInput.d.ts +0 -1
- package/dist/api/types/McpToolConfigOutput.d.ts +0 -1
- package/dist/api/types/PromptAgent.d.ts +1 -27
- package/dist/api/types/PromptAgentApiModelInput.d.ts +32 -0
- package/dist/api/types/PromptAgentApiModelInput.js +5 -0
- package/{api/types/PromptAgentDbModelToolsItem.d.ts → dist/api/types/PromptAgentApiModelInputToolsItem.d.ts} +2 -2
- package/dist/api/types/PromptAgentApiModelInputToolsItem.js +5 -0
- package/dist/api/types/PromptAgentApiModelOutput.d.ts +32 -0
- package/dist/api/types/PromptAgentApiModelOutput.js +5 -0
- package/dist/api/types/PromptAgentApiModelOutputToolsItem.d.ts +22 -0
- package/dist/api/types/PromptAgentApiModelOutputToolsItem.js +5 -0
- package/dist/api/types/{PromptAgentOverride.d.ts → PromptAgentApiModelOverride.d.ts} +1 -1
- package/dist/api/types/PromptAgentApiModelOverride.js +5 -0
- package/dist/api/types/{PromptAgentOverrideConfig.d.ts → PromptAgentApiModelOverrideConfig.d.ts} +1 -1
- package/dist/api/types/PromptAgentApiModelOverrideConfig.js +5 -0
- package/dist/api/types/PromptAgentDbModel.d.ts +3 -3
- package/dist/api/types/SystemToolConfigInput.d.ts +0 -1
- package/dist/api/types/SystemToolConfigOutput.d.ts +0 -1
- package/dist/api/types/ToolRequestModel.d.ts +8 -0
- package/dist/api/types/ToolRequestModel.js +5 -0
- package/{api/types/PromptAgentInputToolsItem.d.ts → dist/api/types/ToolRequestModelToolConfig.d.ts} +3 -3
- package/dist/api/types/ToolRequestModelToolConfig.js +5 -0
- package/dist/api/types/ToolResponseModel.d.ts +10 -0
- package/dist/api/types/ToolResponseModel.js +5 -0
- package/dist/api/types/{PromptAgentOutputToolsItem.d.ts → ToolResponseModelToolConfig.d.ts} +2 -2
- package/dist/api/types/ToolResponseModelToolConfig.js +5 -0
- package/dist/api/types/ToolsResponseModel.d.ts +7 -0
- package/dist/api/types/ToolsResponseModel.js +5 -0
- package/dist/api/types/WebhookToolConfigInput.d.ts +0 -1
- package/dist/api/types/WebhookToolConfigOutput.d.ts +0 -1
- package/dist/api/types/WorkspaceGroupPermission.d.ts +22 -0
- package/dist/api/types/WorkspaceGroupPermission.js +24 -0
- package/dist/api/types/WorkspaceGroupResponseModel.d.ts +10 -0
- package/dist/api/types/WorkspaceGroupResponseModel.js +5 -0
- package/dist/api/types/index.d.ts +20 -11
- package/dist/api/types/index.js +20 -11
- package/dist/serialization/resources/conversationalAi/resources/agents/client/requests/BodyDuplicateAgentV1ConvaiAgentsAgentIdDuplicatePost.d.ts +12 -0
- package/dist/serialization/resources/conversationalAi/resources/agents/client/requests/BodyDuplicateAgentV1ConvaiAgentsAgentIdDuplicatePost.js +43 -0
- package/dist/serialization/resources/conversationalAi/resources/agents/client/requests/index.d.ts +1 -0
- package/dist/serialization/resources/conversationalAi/resources/agents/client/requests/index.js +3 -1
- package/dist/serialization/resources/textToVoice/client/requests/BodyCreateANewVoiceFromVoicePreviewV1TextToVoicePost.d.ts +16 -0
- package/dist/serialization/resources/textToVoice/client/requests/BodyCreateANewVoiceFromVoicePreviewV1TextToVoicePost.js +47 -0
- package/dist/serialization/resources/textToVoice/client/requests/VoiceDesignRequestModel.d.ts +22 -0
- package/dist/serialization/{types/DependentAvailableAgentToolIdentifier.js → resources/textToVoice/client/requests/VoiceDesignRequestModel.js} +14 -9
- package/dist/serialization/resources/textToVoice/client/requests/index.d.ts +2 -0
- package/dist/serialization/resources/textToVoice/client/requests/index.js +5 -1
- package/dist/serialization/resources/textToVoice/types/TextToVoiceDesignRequestOutputFormat.d.ts +10 -0
- package/dist/serialization/resources/textToVoice/types/TextToVoiceDesignRequestOutputFormat.js +61 -0
- package/dist/serialization/resources/textToVoice/types/VoiceDesignRequestModelModelId.d.ts +10 -0
- package/{serialization/types/DependentUnknownAgentToolIdentifier.js → dist/serialization/resources/textToVoice/types/VoiceDesignRequestModelModelId.js} +3 -3
- package/dist/serialization/resources/textToVoice/types/index.d.ts +2 -0
- package/dist/serialization/resources/textToVoice/types/index.js +2 -0
- package/dist/serialization/resources/workspace/client/getShareOptions.d.ts +11 -0
- package/dist/serialization/{types/DependentAvailableAgentToolIdentifierAccessLevel.js → resources/workspace/client/getShareOptions.js} +4 -3
- package/dist/serialization/resources/workspace/client/index.d.ts +1 -0
- package/dist/serialization/resources/workspace/client/index.js +24 -0
- package/dist/serialization/resources/workspace/client/requests/BodyUpdateDefaultSharingPreferencesV1WorkspaceDefaultSharingPreferencesPost.d.ts +12 -0
- package/dist/serialization/resources/workspace/client/requests/BodyUpdateDefaultSharingPreferencesV1WorkspaceDefaultSharingPreferencesPost.js +43 -0
- package/dist/serialization/resources/workspace/client/requests/index.d.ts +1 -0
- package/dist/serialization/resources/workspace/client/requests/index.js +3 -1
- package/dist/serialization/types/AgentConfigOverride.d.ts +2 -2
- package/dist/serialization/types/AgentConfigOverride.js +2 -2
- package/dist/serialization/types/AgentConfigOverrideConfig.d.ts +2 -2
- package/dist/serialization/types/AgentConfigOverrideConfig.js +2 -2
- package/dist/serialization/types/AsrProvider.d.ts +1 -1
- package/dist/serialization/types/AsrProvider.js +1 -1
- package/dist/serialization/types/{BuiltInTools.d.ts → BuiltInToolsInput.d.ts} +2 -2
- package/dist/serialization/types/{BuiltInTools.js → BuiltInToolsInput.js} +2 -2
- package/dist/serialization/types/BuiltInToolsOutput.d.ts +17 -0
- package/dist/serialization/types/BuiltInToolsOutput.js +48 -0
- package/dist/serialization/types/ClientToolConfigInput.d.ts +0 -1
- package/dist/serialization/types/ClientToolConfigInput.js +0 -1
- package/dist/serialization/types/ClientToolConfigOutput.d.ts +0 -1
- package/dist/serialization/types/ClientToolConfigOutput.js +0 -1
- package/dist/serialization/types/ConvAiStoredSecretDependencies.d.ts +2 -2
- package/dist/serialization/types/ConvAiStoredSecretDependencies.js +2 -2
- package/dist/serialization/types/ConvAiStoredSecretDependenciesAgentsItem.d.ts +18 -0
- package/dist/serialization/types/{ConvAiStoredSecretDependenciesAgentToolsItem.js → ConvAiStoredSecretDependenciesAgentsItem.js} +6 -6
- package/dist/serialization/types/ConversationChargingCommonModel.d.ts +2 -0
- package/dist/serialization/types/ConversationChargingCommonModel.js +2 -0
- package/dist/serialization/types/DefaultSharingPreferencesResponseModel.d.ts +13 -0
- package/dist/serialization/types/DefaultSharingPreferencesResponseModel.js +44 -0
- package/dist/serialization/types/GetToolDependentAgentsResponseModel.d.ts +15 -0
- package/dist/serialization/types/GetToolDependentAgentsResponseModel.js +46 -0
- package/dist/serialization/types/GetToolDependentAgentsResponseModelAgentsItem.d.ts +18 -0
- package/{serialization/types/ConvAiStoredSecretDependenciesAgentToolsItem.js → dist/serialization/types/GetToolDependentAgentsResponseModelAgentsItem.js} +6 -6
- package/dist/serialization/types/McpToolConfigInput.d.ts +0 -1
- package/dist/serialization/types/McpToolConfigInput.js +0 -1
- package/dist/serialization/types/McpToolConfigOutput.d.ts +0 -1
- package/dist/serialization/types/McpToolConfigOutput.js +0 -1
- package/dist/serialization/types/PromptAgent.d.ts +2 -20
- package/dist/serialization/types/PromptAgent.js +1 -19
- package/dist/serialization/types/PromptAgentApiModelInput.d.ts +30 -0
- package/dist/serialization/types/PromptAgentApiModelInput.js +61 -0
- package/{serialization/types/PromptAgentDbModelToolsItem.d.ts → dist/serialization/types/PromptAgentApiModelInputToolsItem.d.ts} +3 -3
- package/{serialization/types/PromptAgentDbModelToolsItem.js → dist/serialization/types/PromptAgentApiModelInputToolsItem.js} +2 -2
- package/dist/serialization/types/PromptAgentApiModelOutput.d.ts +30 -0
- package/dist/serialization/types/PromptAgentApiModelOutput.js +61 -0
- package/dist/serialization/types/PromptAgentApiModelOutputToolsItem.d.ts +26 -0
- package/dist/serialization/types/PromptAgentApiModelOutputToolsItem.js +55 -0
- package/{serialization/types/PromptAgentOverride.d.ts → dist/serialization/types/PromptAgentApiModelOverride.d.ts} +2 -2
- package/dist/serialization/types/{PromptAgentOverride.js → PromptAgentApiModelOverride.js} +2 -2
- package/dist/serialization/types/{PromptAgentOverrideConfig.d.ts → PromptAgentApiModelOverrideConfig.d.ts} +2 -2
- package/dist/serialization/types/{PromptAgentOverrideConfig.js → PromptAgentApiModelOverrideConfig.js} +2 -2
- package/dist/serialization/types/PromptAgentDbModel.d.ts +3 -4
- package/dist/serialization/types/PromptAgentDbModel.js +3 -4
- package/dist/serialization/types/SystemToolConfigInput.d.ts +0 -1
- package/dist/serialization/types/SystemToolConfigInput.js +0 -1
- package/dist/serialization/types/SystemToolConfigOutput.d.ts +0 -1
- package/dist/serialization/types/SystemToolConfigOutput.js +0 -1
- package/dist/serialization/types/ToolRequestModel.d.ts +13 -0
- package/dist/serialization/types/ToolRequestModel.js +44 -0
- package/dist/serialization/types/{PromptAgentInputToolsItem.d.ts → ToolRequestModelToolConfig.d.ts} +3 -3
- package/{serialization/types/PromptAgentInputToolsItem.js → dist/serialization/types/ToolRequestModelToolConfig.js} +2 -2
- package/dist/serialization/types/ToolResponseModel.d.ts +16 -0
- package/dist/serialization/types/ToolResponseModel.js +47 -0
- package/{serialization/types/PromptAgentOutputToolsItem.d.ts → dist/serialization/types/ToolResponseModelToolConfig.d.ts} +3 -3
- package/{serialization/types/PromptAgentOutputToolsItem.js → dist/serialization/types/ToolResponseModelToolConfig.js} +2 -2
- package/dist/serialization/types/ToolsResponseModel.d.ts +13 -0
- package/dist/serialization/types/ToolsResponseModel.js +44 -0
- package/dist/serialization/types/WebhookToolConfigInput.d.ts +0 -1
- package/dist/serialization/types/WebhookToolConfigInput.js +0 -1
- package/dist/serialization/types/WebhookToolConfigOutput.d.ts +0 -1
- package/dist/serialization/types/WebhookToolConfigOutput.js +0 -1
- package/dist/serialization/types/WorkspaceGroupPermission.d.ts +10 -0
- package/dist/serialization/types/WorkspaceGroupPermission.js +58 -0
- package/dist/serialization/types/WorkspaceGroupResponseModel.d.ts +16 -0
- package/dist/serialization/types/WorkspaceGroupResponseModel.js +47 -0
- package/dist/serialization/types/index.d.ts +20 -11
- package/dist/serialization/types/index.js +20 -11
- package/dist/version.d.ts +1 -1
- package/dist/version.js +1 -1
- package/package.json +1 -1
- package/reference.md +1019 -239
- package/serialization/resources/conversationalAi/resources/agents/client/requests/BodyDuplicateAgentV1ConvaiAgentsAgentIdDuplicatePost.d.ts +12 -0
- package/serialization/resources/conversationalAi/resources/agents/client/requests/BodyDuplicateAgentV1ConvaiAgentsAgentIdDuplicatePost.js +43 -0
- package/serialization/resources/conversationalAi/resources/agents/client/requests/index.d.ts +1 -0
- package/serialization/resources/conversationalAi/resources/agents/client/requests/index.js +3 -1
- package/serialization/resources/textToVoice/client/requests/BodyCreateANewVoiceFromVoicePreviewV1TextToVoicePost.d.ts +16 -0
- package/serialization/resources/textToVoice/client/requests/BodyCreateANewVoiceFromVoicePreviewV1TextToVoicePost.js +47 -0
- package/serialization/resources/textToVoice/client/requests/VoiceDesignRequestModel.d.ts +22 -0
- package/serialization/resources/textToVoice/client/requests/VoiceDesignRequestModel.js +53 -0
- package/serialization/resources/textToVoice/client/requests/index.d.ts +2 -0
- package/serialization/resources/textToVoice/client/requests/index.js +5 -1
- package/serialization/resources/textToVoice/types/TextToVoiceDesignRequestOutputFormat.d.ts +10 -0
- package/serialization/resources/textToVoice/types/TextToVoiceDesignRequestOutputFormat.js +61 -0
- package/serialization/resources/textToVoice/types/VoiceDesignRequestModelModelId.d.ts +10 -0
- package/{dist/serialization/types/DependentUnknownAgentToolIdentifier.js → serialization/resources/textToVoice/types/VoiceDesignRequestModelModelId.js} +3 -3
- package/serialization/resources/textToVoice/types/index.d.ts +2 -0
- package/serialization/resources/textToVoice/types/index.js +2 -0
- package/serialization/resources/workspace/client/getShareOptions.d.ts +11 -0
- package/serialization/resources/workspace/client/getShareOptions.js +42 -0
- package/serialization/resources/workspace/client/index.d.ts +1 -0
- package/serialization/resources/workspace/client/index.js +24 -0
- package/serialization/resources/workspace/client/requests/BodyUpdateDefaultSharingPreferencesV1WorkspaceDefaultSharingPreferencesPost.d.ts +12 -0
- package/serialization/resources/workspace/client/requests/BodyUpdateDefaultSharingPreferencesV1WorkspaceDefaultSharingPreferencesPost.js +43 -0
- package/serialization/resources/workspace/client/requests/index.d.ts +1 -0
- package/serialization/resources/workspace/client/requests/index.js +3 -1
- package/serialization/types/AgentConfigOverride.d.ts +2 -2
- package/serialization/types/AgentConfigOverride.js +2 -2
- package/serialization/types/AgentConfigOverrideConfig.d.ts +2 -2
- package/serialization/types/AgentConfigOverrideConfig.js +2 -2
- package/serialization/types/AsrProvider.d.ts +1 -1
- package/serialization/types/AsrProvider.js +1 -1
- package/serialization/types/{BuiltInTools.d.ts → BuiltInToolsInput.d.ts} +2 -2
- package/serialization/types/{BuiltInTools.js → BuiltInToolsInput.js} +2 -2
- package/serialization/types/BuiltInToolsOutput.d.ts +17 -0
- package/serialization/types/BuiltInToolsOutput.js +48 -0
- package/serialization/types/ClientToolConfigInput.d.ts +0 -1
- package/serialization/types/ClientToolConfigInput.js +0 -1
- package/serialization/types/ClientToolConfigOutput.d.ts +0 -1
- package/serialization/types/ClientToolConfigOutput.js +0 -1
- package/serialization/types/ConvAiStoredSecretDependencies.d.ts +2 -2
- package/serialization/types/ConvAiStoredSecretDependencies.js +2 -2
- package/serialization/types/ConvAiStoredSecretDependenciesAgentsItem.d.ts +18 -0
- package/serialization/types/ConvAiStoredSecretDependenciesAgentsItem.js +51 -0
- package/serialization/types/ConversationChargingCommonModel.d.ts +2 -0
- package/serialization/types/ConversationChargingCommonModel.js +2 -0
- package/serialization/types/DefaultSharingPreferencesResponseModel.d.ts +13 -0
- package/serialization/types/DefaultSharingPreferencesResponseModel.js +44 -0
- package/serialization/types/GetToolDependentAgentsResponseModel.d.ts +15 -0
- package/serialization/types/GetToolDependentAgentsResponseModel.js +46 -0
- package/serialization/types/GetToolDependentAgentsResponseModelAgentsItem.d.ts +18 -0
- package/serialization/types/GetToolDependentAgentsResponseModelAgentsItem.js +51 -0
- package/serialization/types/McpToolConfigInput.d.ts +0 -1
- package/serialization/types/McpToolConfigInput.js +0 -1
- package/serialization/types/McpToolConfigOutput.d.ts +0 -1
- package/serialization/types/McpToolConfigOutput.js +0 -1
- package/serialization/types/PromptAgent.d.ts +2 -20
- package/serialization/types/PromptAgent.js +1 -19
- package/serialization/types/PromptAgentApiModelInput.d.ts +30 -0
- package/serialization/types/PromptAgentApiModelInput.js +61 -0
- package/{dist/serialization/types/PromptAgentDbModelToolsItem.d.ts → serialization/types/PromptAgentApiModelInputToolsItem.d.ts} +3 -3
- package/{dist/serialization/types/PromptAgentDbModelToolsItem.js → serialization/types/PromptAgentApiModelInputToolsItem.js} +2 -2
- package/serialization/types/PromptAgentApiModelOutput.d.ts +30 -0
- package/serialization/types/PromptAgentApiModelOutput.js +61 -0
- package/serialization/types/PromptAgentApiModelOutputToolsItem.d.ts +26 -0
- package/serialization/types/PromptAgentApiModelOutputToolsItem.js +55 -0
- package/{dist/serialization/types/PromptAgentOverride.d.ts → serialization/types/PromptAgentApiModelOverride.d.ts} +2 -2
- package/serialization/types/{PromptAgentOverride.js → PromptAgentApiModelOverride.js} +2 -2
- package/serialization/types/{PromptAgentOverrideConfig.d.ts → PromptAgentApiModelOverrideConfig.d.ts} +2 -2
- package/serialization/types/{PromptAgentOverrideConfig.js → PromptAgentApiModelOverrideConfig.js} +2 -2
- package/serialization/types/PromptAgentDbModel.d.ts +3 -4
- package/serialization/types/PromptAgentDbModel.js +3 -4
- package/serialization/types/SystemToolConfigInput.d.ts +0 -1
- package/serialization/types/SystemToolConfigInput.js +0 -1
- package/serialization/types/SystemToolConfigOutput.d.ts +0 -1
- package/serialization/types/SystemToolConfigOutput.js +0 -1
- package/serialization/types/ToolRequestModel.d.ts +13 -0
- package/serialization/types/ToolRequestModel.js +44 -0
- package/serialization/types/{PromptAgentInputToolsItem.d.ts → ToolRequestModelToolConfig.d.ts} +3 -3
- package/{dist/serialization/types/PromptAgentInputToolsItem.js → serialization/types/ToolRequestModelToolConfig.js} +2 -2
- package/serialization/types/ToolResponseModel.d.ts +16 -0
- package/serialization/types/ToolResponseModel.js +47 -0
- package/{dist/serialization/types/PromptAgentOutputToolsItem.d.ts → serialization/types/ToolResponseModelToolConfig.d.ts} +3 -3
- package/{dist/serialization/types/PromptAgentOutputToolsItem.js → serialization/types/ToolResponseModelToolConfig.js} +2 -2
- package/serialization/types/ToolsResponseModel.d.ts +13 -0
- package/serialization/types/ToolsResponseModel.js +44 -0
- package/serialization/types/WebhookToolConfigInput.d.ts +0 -1
- package/serialization/types/WebhookToolConfigInput.js +0 -1
- package/serialization/types/WebhookToolConfigOutput.d.ts +0 -1
- package/serialization/types/WebhookToolConfigOutput.js +0 -1
- package/serialization/types/WorkspaceGroupPermission.d.ts +10 -0
- package/serialization/types/WorkspaceGroupPermission.js +58 -0
- package/serialization/types/WorkspaceGroupResponseModel.d.ts +16 -0
- package/serialization/types/WorkspaceGroupResponseModel.js +47 -0
- package/serialization/types/index.d.ts +20 -11
- package/serialization/types/index.js +20 -11
- package/version.d.ts +1 -1
- package/version.js +1 -1
- package/api/types/ConvAiStoredSecretDependenciesAgentToolsItem.d.ts +0 -13
- package/api/types/DependentAvailableAgentToolIdentifier.d.ts +0 -11
- package/api/types/DependentAvailableAgentToolIdentifierAccessLevel.d.ts +0 -9
- package/api/types/DependentAvailableAgentToolIdentifierAccessLevel.js +0 -11
- package/api/types/DependentUnknownAgentToolIdentifier.d.ts +0 -9
- package/dist/api/types/ConvAiStoredSecretDependenciesAgentToolsItem.d.ts +0 -13
- package/dist/api/types/DependentAvailableAgentToolIdentifier.d.ts +0 -11
- package/dist/api/types/DependentAvailableAgentToolIdentifierAccessLevel.d.ts +0 -9
- package/dist/api/types/DependentAvailableAgentToolIdentifierAccessLevel.js +0 -11
- package/dist/api/types/DependentUnknownAgentToolIdentifier.d.ts +0 -9
- package/dist/serialization/types/ConvAiStoredSecretDependenciesAgentToolsItem.d.ts +0 -18
- package/dist/serialization/types/DependentAvailableAgentToolIdentifier.d.ts +0 -17
- package/dist/serialization/types/DependentAvailableAgentToolIdentifierAccessLevel.d.ts +0 -10
- package/dist/serialization/types/DependentUnknownAgentToolIdentifier.d.ts +0 -11
- package/serialization/types/ConvAiStoredSecretDependenciesAgentToolsItem.d.ts +0 -18
- package/serialization/types/DependentAvailableAgentToolIdentifier.d.ts +0 -17
- package/serialization/types/DependentAvailableAgentToolIdentifier.js +0 -48
- package/serialization/types/DependentAvailableAgentToolIdentifierAccessLevel.d.ts +0 -10
- package/serialization/types/DependentAvailableAgentToolIdentifierAccessLevel.js +0 -41
- package/serialization/types/DependentUnknownAgentToolIdentifier.d.ts +0 -11
- /package/api/{types/BuiltInTools.js → resources/conversationalAi/resources/agents/client/requests/BodyDuplicateAgentV1ConvaiAgentsAgentIdDuplicatePost.js} +0 -0
- /package/api/{types/ConvAiStoredSecretDependenciesAgentToolsItem.js → resources/conversationalAi/resources/tools/client/requests/ToolsGetDependentAgentsRequest.js} +0 -0
- /package/api/{types/DependentAvailableAgentToolIdentifier.js → resources/textToVoice/client/requests/BodyCreateANewVoiceFromVoicePreviewV1TextToVoicePost.js} +0 -0
- /package/api/{types/DependentUnknownAgentToolIdentifier.js → resources/textToVoice/client/requests/VoiceDesignRequestModel.js} +0 -0
- /package/api/{types/PromptAgentDbModelToolsItem.js → resources/workspace/client/requests/BodyUpdateDefaultSharingPreferencesV1WorkspaceDefaultSharingPreferencesPost.js} +0 -0
- /package/api/types/{PromptAgentInputToolsItem.js → BuiltInToolsInput.js} +0 -0
- /package/api/types/{PromptAgentOutputToolsItem.js → BuiltInToolsOutput.js} +0 -0
- /package/api/types/{PromptAgentOverride.js → ConvAiStoredSecretDependenciesAgentsItem.js} +0 -0
- /package/api/types/{PromptAgentOverrideConfig.js → DefaultSharingPreferencesResponseModel.js} +0 -0
- /package/{dist/api/types/BuiltInTools.js → api/types/GetToolDependentAgentsResponseModel.js} +0 -0
- /package/{dist/api/types/ConvAiStoredSecretDependenciesAgentToolsItem.js → api/types/GetToolDependentAgentsResponseModelAgentsItem.js} +0 -0
- /package/{dist/api/types/DependentAvailableAgentToolIdentifier.js → api/types/PromptAgentApiModelInput.js} +0 -0
- /package/{dist/api/types/DependentUnknownAgentToolIdentifier.js → api/types/PromptAgentApiModelInputToolsItem.js} +0 -0
- /package/{dist/api/types/PromptAgentDbModelToolsItem.js → api/types/PromptAgentApiModelOutput.js} +0 -0
- /package/{dist/api/types/PromptAgentInputToolsItem.js → api/types/PromptAgentApiModelOutputToolsItem.js} +0 -0
- /package/{dist/api/types/PromptAgentOutputToolsItem.js → api/types/PromptAgentApiModelOverride.js} +0 -0
- /package/{dist/api/types/PromptAgentOverride.js → api/types/PromptAgentApiModelOverrideConfig.js} +0 -0
- /package/{dist/api/types/PromptAgentOverrideConfig.js → api/types/ToolRequestModel.js} +0 -0
package/reference.md
CHANGED
|
@@ -1072,6 +1072,138 @@ await client.textToVoice.createVoiceFromPreview({
|
|
|
1072
1072
|
</dl>
|
|
1073
1073
|
</details>
|
|
1074
1074
|
|
|
1075
|
+
<details><summary><code>client.textToVoice.<a href="/src/api/resources/textToVoice/client/Client.ts">create</a>({ ...params }) -> ElevenLabs.Voice</code></summary>
|
|
1076
|
+
<dl>
|
|
1077
|
+
<dd>
|
|
1078
|
+
|
|
1079
|
+
#### 📝 Description
|
|
1080
|
+
|
|
1081
|
+
<dl>
|
|
1082
|
+
<dd>
|
|
1083
|
+
|
|
1084
|
+
<dl>
|
|
1085
|
+
<dd>
|
|
1086
|
+
|
|
1087
|
+
Create a voice from previously generated voice preview. This endpoint should be called after you fetched a generated_voice_id using POST /v1/text-to-voice/design or POST /v1/text-to-voice/:voice_id/remix.
|
|
1088
|
+
|
|
1089
|
+
</dd>
|
|
1090
|
+
</dl>
|
|
1091
|
+
</dd>
|
|
1092
|
+
</dl>
|
|
1093
|
+
|
|
1094
|
+
#### 🔌 Usage
|
|
1095
|
+
|
|
1096
|
+
<dl>
|
|
1097
|
+
<dd>
|
|
1098
|
+
|
|
1099
|
+
<dl>
|
|
1100
|
+
<dd>
|
|
1101
|
+
|
|
1102
|
+
```typescript
|
|
1103
|
+
await client.textToVoice.create({
|
|
1104
|
+
voiceName: "Sassy squeaky mouse",
|
|
1105
|
+
voiceDescription: "A sassy squeaky mouse",
|
|
1106
|
+
generatedVoiceId: "37HceQefKmEi3bGovXjL",
|
|
1107
|
+
});
|
|
1108
|
+
```
|
|
1109
|
+
|
|
1110
|
+
</dd>
|
|
1111
|
+
</dl>
|
|
1112
|
+
</dd>
|
|
1113
|
+
</dl>
|
|
1114
|
+
|
|
1115
|
+
#### ⚙️ Parameters
|
|
1116
|
+
|
|
1117
|
+
<dl>
|
|
1118
|
+
<dd>
|
|
1119
|
+
|
|
1120
|
+
<dl>
|
|
1121
|
+
<dd>
|
|
1122
|
+
|
|
1123
|
+
**request:** `ElevenLabs.BodyCreateANewVoiceFromVoicePreviewV1TextToVoicePost`
|
|
1124
|
+
|
|
1125
|
+
</dd>
|
|
1126
|
+
</dl>
|
|
1127
|
+
|
|
1128
|
+
<dl>
|
|
1129
|
+
<dd>
|
|
1130
|
+
|
|
1131
|
+
**requestOptions:** `TextToVoice.RequestOptions`
|
|
1132
|
+
|
|
1133
|
+
</dd>
|
|
1134
|
+
</dl>
|
|
1135
|
+
</dd>
|
|
1136
|
+
</dl>
|
|
1137
|
+
|
|
1138
|
+
</dd>
|
|
1139
|
+
</dl>
|
|
1140
|
+
</details>
|
|
1141
|
+
|
|
1142
|
+
<details><summary><code>client.textToVoice.<a href="/src/api/resources/textToVoice/client/Client.ts">design</a>({ ...params }) -> ElevenLabs.VoiceDesignPreviewResponse</code></summary>
|
|
1143
|
+
<dl>
|
|
1144
|
+
<dd>
|
|
1145
|
+
|
|
1146
|
+
#### 📝 Description
|
|
1147
|
+
|
|
1148
|
+
<dl>
|
|
1149
|
+
<dd>
|
|
1150
|
+
|
|
1151
|
+
<dl>
|
|
1152
|
+
<dd>
|
|
1153
|
+
|
|
1154
|
+
Design a voice via a prompt. This method returns a list of voice previews. Each preview has a generated_voice_id and a sample of the voice as base64 encoded mp3 audio. To create a voice use the generated_voice_id of the preferred preview with the /v1/text-to-voice endpoint.
|
|
1155
|
+
|
|
1156
|
+
</dd>
|
|
1157
|
+
</dl>
|
|
1158
|
+
</dd>
|
|
1159
|
+
</dl>
|
|
1160
|
+
|
|
1161
|
+
#### 🔌 Usage
|
|
1162
|
+
|
|
1163
|
+
<dl>
|
|
1164
|
+
<dd>
|
|
1165
|
+
|
|
1166
|
+
<dl>
|
|
1167
|
+
<dd>
|
|
1168
|
+
|
|
1169
|
+
```typescript
|
|
1170
|
+
await client.textToVoice.design({
|
|
1171
|
+
voiceDescription: "A sassy squeaky mouse",
|
|
1172
|
+
});
|
|
1173
|
+
```
|
|
1174
|
+
|
|
1175
|
+
</dd>
|
|
1176
|
+
</dl>
|
|
1177
|
+
</dd>
|
|
1178
|
+
</dl>
|
|
1179
|
+
|
|
1180
|
+
#### ⚙️ Parameters
|
|
1181
|
+
|
|
1182
|
+
<dl>
|
|
1183
|
+
<dd>
|
|
1184
|
+
|
|
1185
|
+
<dl>
|
|
1186
|
+
<dd>
|
|
1187
|
+
|
|
1188
|
+
**request:** `ElevenLabs.VoiceDesignRequestModel`
|
|
1189
|
+
|
|
1190
|
+
</dd>
|
|
1191
|
+
</dl>
|
|
1192
|
+
|
|
1193
|
+
<dl>
|
|
1194
|
+
<dd>
|
|
1195
|
+
|
|
1196
|
+
**requestOptions:** `TextToVoice.RequestOptions`
|
|
1197
|
+
|
|
1198
|
+
</dd>
|
|
1199
|
+
</dl>
|
|
1200
|
+
</dd>
|
|
1201
|
+
</dl>
|
|
1202
|
+
|
|
1203
|
+
</dd>
|
|
1204
|
+
</dl>
|
|
1205
|
+
</details>
|
|
1206
|
+
|
|
1075
1207
|
## User
|
|
1076
1208
|
|
|
1077
1209
|
<details><summary><code>client.user.<a href="/src/api/resources/user/client/Client.ts">get</a>() -> ElevenLabs.User</code></summary>
|
|
@@ -2602,9 +2734,7 @@ await client.workspace.updateUserAutoProvisioning({
|
|
|
2602
2734
|
</dl>
|
|
2603
2735
|
</details>
|
|
2604
2736
|
|
|
2605
|
-
|
|
2606
|
-
|
|
2607
|
-
<details><summary><code>client.webhooks.<a href="/src/api/resources/webhooks/client/Client.ts">list</a>({ ...params }) -> ElevenLabs.WorkspaceWebhookListResponseModel</code></summary>
|
|
2737
|
+
<details><summary><code>client.workspace.<a href="/src/api/resources/workspace/client/Client.ts">getDefaultSharingPreferences</a>() -> ElevenLabs.DefaultSharingPreferencesResponseModel</code></summary>
|
|
2608
2738
|
<dl>
|
|
2609
2739
|
<dd>
|
|
2610
2740
|
|
|
@@ -2616,7 +2746,7 @@ await client.workspace.updateUserAutoProvisioning({
|
|
|
2616
2746
|
<dl>
|
|
2617
2747
|
<dd>
|
|
2618
2748
|
|
|
2619
|
-
|
|
2749
|
+
Get the user's default sharing preferences.
|
|
2620
2750
|
|
|
2621
2751
|
</dd>
|
|
2622
2752
|
</dl>
|
|
@@ -2632,9 +2762,7 @@ List all webhooks for a workspace
|
|
|
2632
2762
|
<dd>
|
|
2633
2763
|
|
|
2634
2764
|
```typescript
|
|
2635
|
-
await client.
|
|
2636
|
-
includeUsages: false,
|
|
2637
|
-
});
|
|
2765
|
+
await client.workspace.getDefaultSharingPreferences();
|
|
2638
2766
|
```
|
|
2639
2767
|
|
|
2640
2768
|
</dd>
|
|
@@ -2650,15 +2778,7 @@ await client.webhooks.list({
|
|
|
2650
2778
|
<dl>
|
|
2651
2779
|
<dd>
|
|
2652
2780
|
|
|
2653
|
-
**
|
|
2654
|
-
|
|
2655
|
-
</dd>
|
|
2656
|
-
</dl>
|
|
2657
|
-
|
|
2658
|
-
<dl>
|
|
2659
|
-
<dd>
|
|
2660
|
-
|
|
2661
|
-
**requestOptions:** `Webhooks.RequestOptions`
|
|
2781
|
+
**requestOptions:** `Workspace.RequestOptions`
|
|
2662
2782
|
|
|
2663
2783
|
</dd>
|
|
2664
2784
|
</dl>
|
|
@@ -2669,9 +2789,7 @@ await client.webhooks.list({
|
|
|
2669
2789
|
</dl>
|
|
2670
2790
|
</details>
|
|
2671
2791
|
|
|
2672
|
-
|
|
2673
|
-
|
|
2674
|
-
<details><summary><code>client.speechToText.<a href="/src/api/resources/speechToText/client/Client.ts">convert</a>({ ...params }) -> ElevenLabs.SpeechToTextChunkResponseModel</code></summary>
|
|
2792
|
+
<details><summary><code>client.workspace.<a href="/src/api/resources/workspace/client/Client.ts">updateDefaultSharingPreferences</a>({ ...params }) -> unknown</code></summary>
|
|
2675
2793
|
<dl>
|
|
2676
2794
|
<dd>
|
|
2677
2795
|
|
|
@@ -2683,7 +2801,7 @@ await client.webhooks.list({
|
|
|
2683
2801
|
<dl>
|
|
2684
2802
|
<dd>
|
|
2685
2803
|
|
|
2686
|
-
|
|
2804
|
+
Update the user's default sharing preferences.
|
|
2687
2805
|
|
|
2688
2806
|
</dd>
|
|
2689
2807
|
</dl>
|
|
@@ -2699,8 +2817,8 @@ Transcribe an audio or video file. If webhook is set to true, the request will b
|
|
|
2699
2817
|
<dd>
|
|
2700
2818
|
|
|
2701
2819
|
```typescript
|
|
2702
|
-
await client.
|
|
2703
|
-
|
|
2820
|
+
await client.workspace.updateDefaultSharingPreferences({
|
|
2821
|
+
defaultSharingGroups: ["default_sharing_groups"],
|
|
2704
2822
|
});
|
|
2705
2823
|
```
|
|
2706
2824
|
|
|
@@ -2717,7 +2835,7 @@ await client.speechToText.convert({
|
|
|
2717
2835
|
<dl>
|
|
2718
2836
|
<dd>
|
|
2719
2837
|
|
|
2720
|
-
**request:** `ElevenLabs.
|
|
2838
|
+
**request:** `ElevenLabs.BodyUpdateDefaultSharingPreferencesV1WorkspaceDefaultSharingPreferencesPost`
|
|
2721
2839
|
|
|
2722
2840
|
</dd>
|
|
2723
2841
|
</dl>
|
|
@@ -2725,7 +2843,7 @@ await client.speechToText.convert({
|
|
|
2725
2843
|
<dl>
|
|
2726
2844
|
<dd>
|
|
2727
2845
|
|
|
2728
|
-
**requestOptions:** `
|
|
2846
|
+
**requestOptions:** `Workspace.RequestOptions`
|
|
2729
2847
|
|
|
2730
2848
|
</dd>
|
|
2731
2849
|
</dl>
|
|
@@ -2736,9 +2854,7 @@ await client.speechToText.convert({
|
|
|
2736
2854
|
</dl>
|
|
2737
2855
|
</details>
|
|
2738
2856
|
|
|
2739
|
-
|
|
2740
|
-
|
|
2741
|
-
<details><summary><code>client.forcedAlignment.<a href="/src/api/resources/forcedAlignment/client/Client.ts">create</a>({ ...params }) -> ElevenLabs.ForcedAlignmentResponseModel</code></summary>
|
|
2857
|
+
<details><summary><code>client.workspace.<a href="/src/api/resources/workspace/client/Client.ts">getShareOptions</a>() -> ElevenLabs.ShareOptionResponseModel[]</code></summary>
|
|
2742
2858
|
<dl>
|
|
2743
2859
|
<dd>
|
|
2744
2860
|
|
|
@@ -2750,7 +2866,7 @@ await client.speechToText.convert({
|
|
|
2750
2866
|
<dl>
|
|
2751
2867
|
<dd>
|
|
2752
2868
|
|
|
2753
|
-
|
|
2869
|
+
Get the share options for a workspace.
|
|
2754
2870
|
|
|
2755
2871
|
</dd>
|
|
2756
2872
|
</dl>
|
|
@@ -2766,10 +2882,7 @@ Force align an audio file to text. Use this endpoint to get the timing informati
|
|
|
2766
2882
|
<dd>
|
|
2767
2883
|
|
|
2768
2884
|
```typescript
|
|
2769
|
-
await client.
|
|
2770
|
-
file: fs.createReadStream("/path/to/your/file"),
|
|
2771
|
-
text: "text",
|
|
2772
|
-
});
|
|
2885
|
+
await client.workspace.getShareOptions();
|
|
2773
2886
|
```
|
|
2774
2887
|
|
|
2775
2888
|
</dd>
|
|
@@ -2785,15 +2898,7 @@ await client.forcedAlignment.create({
|
|
|
2785
2898
|
<dl>
|
|
2786
2899
|
<dd>
|
|
2787
2900
|
|
|
2788
|
-
**
|
|
2789
|
-
|
|
2790
|
-
</dd>
|
|
2791
|
-
</dl>
|
|
2792
|
-
|
|
2793
|
-
<dl>
|
|
2794
|
-
<dd>
|
|
2795
|
-
|
|
2796
|
-
**requestOptions:** `ForcedAlignment.RequestOptions`
|
|
2901
|
+
**requestOptions:** `Workspace.RequestOptions`
|
|
2797
2902
|
|
|
2798
2903
|
</dd>
|
|
2799
2904
|
</dl>
|
|
@@ -2804,9 +2909,9 @@ await client.forcedAlignment.create({
|
|
|
2804
2909
|
</dl>
|
|
2805
2910
|
</details>
|
|
2806
2911
|
|
|
2807
|
-
##
|
|
2912
|
+
## Webhooks
|
|
2808
2913
|
|
|
2809
|
-
<details><summary><code>client.
|
|
2914
|
+
<details><summary><code>client.webhooks.<a href="/src/api/resources/webhooks/client/Client.ts">list</a>({ ...params }) -> ElevenLabs.WorkspaceWebhookListResponseModel</code></summary>
|
|
2810
2915
|
<dl>
|
|
2811
2916
|
<dd>
|
|
2812
2917
|
|
|
@@ -2818,7 +2923,7 @@ await client.forcedAlignment.create({
|
|
|
2818
2923
|
<dl>
|
|
2819
2924
|
<dd>
|
|
2820
2925
|
|
|
2821
|
-
|
|
2926
|
+
List all webhooks for a workspace
|
|
2822
2927
|
|
|
2823
2928
|
</dd>
|
|
2824
2929
|
</dl>
|
|
@@ -2834,7 +2939,9 @@ Upload a file or webpage URL to create a knowledge base document. <br> <Note> Af
|
|
|
2834
2939
|
<dd>
|
|
2835
2940
|
|
|
2836
2941
|
```typescript
|
|
2837
|
-
await client.
|
|
2942
|
+
await client.webhooks.list({
|
|
2943
|
+
includeUsages: false,
|
|
2944
|
+
});
|
|
2838
2945
|
```
|
|
2839
2946
|
|
|
2840
2947
|
</dd>
|
|
@@ -2850,7 +2957,7 @@ await client.conversationalAi.addToKnowledgeBase({});
|
|
|
2850
2957
|
<dl>
|
|
2851
2958
|
<dd>
|
|
2852
2959
|
|
|
2853
|
-
**request:** `ElevenLabs.
|
|
2960
|
+
**request:** `ElevenLabs.WebhooksListRequest`
|
|
2854
2961
|
|
|
2855
2962
|
</dd>
|
|
2856
2963
|
</dl>
|
|
@@ -2858,7 +2965,7 @@ await client.conversationalAi.addToKnowledgeBase({});
|
|
|
2858
2965
|
<dl>
|
|
2859
2966
|
<dd>
|
|
2860
2967
|
|
|
2861
|
-
**requestOptions:** `
|
|
2968
|
+
**requestOptions:** `Webhooks.RequestOptions`
|
|
2862
2969
|
|
|
2863
2970
|
</dd>
|
|
2864
2971
|
</dl>
|
|
@@ -2869,7 +2976,9 @@ await client.conversationalAi.addToKnowledgeBase({});
|
|
|
2869
2976
|
</dl>
|
|
2870
2977
|
</details>
|
|
2871
2978
|
|
|
2872
|
-
|
|
2979
|
+
## SpeechToText
|
|
2980
|
+
|
|
2981
|
+
<details><summary><code>client.speechToText.<a href="/src/api/resources/speechToText/client/Client.ts">convert</a>({ ...params }) -> ElevenLabs.SpeechToTextChunkResponseModel</code></summary>
|
|
2873
2982
|
<dl>
|
|
2874
2983
|
<dd>
|
|
2875
2984
|
|
|
@@ -2881,7 +2990,7 @@ await client.conversationalAi.addToKnowledgeBase({});
|
|
|
2881
2990
|
<dl>
|
|
2882
2991
|
<dd>
|
|
2883
2992
|
|
|
2884
|
-
|
|
2993
|
+
Transcribe an audio or video file. If webhook is set to true, the request will be processed asynchronously and results sent to configured webhooks.
|
|
2885
2994
|
|
|
2886
2995
|
</dd>
|
|
2887
2996
|
</dl>
|
|
@@ -2897,7 +3006,9 @@ Provides information about all RAG indexes of the specified knowledgebase docume
|
|
|
2897
3006
|
<dd>
|
|
2898
3007
|
|
|
2899
3008
|
```typescript
|
|
2900
|
-
await client.
|
|
3009
|
+
await client.speechToText.convert({
|
|
3010
|
+
modelId: "model_id",
|
|
3011
|
+
});
|
|
2901
3012
|
```
|
|
2902
3013
|
|
|
2903
3014
|
</dd>
|
|
@@ -2913,7 +3024,7 @@ await client.conversationalAi.getDocumentRagIndexes("21m00Tcm4TlvDq8ikWAM");
|
|
|
2913
3024
|
<dl>
|
|
2914
3025
|
<dd>
|
|
2915
3026
|
|
|
2916
|
-
**
|
|
3027
|
+
**request:** `ElevenLabs.BodySpeechToTextV1SpeechToTextPost`
|
|
2917
3028
|
|
|
2918
3029
|
</dd>
|
|
2919
3030
|
</dl>
|
|
@@ -2921,7 +3032,7 @@ await client.conversationalAi.getDocumentRagIndexes("21m00Tcm4TlvDq8ikWAM");
|
|
|
2921
3032
|
<dl>
|
|
2922
3033
|
<dd>
|
|
2923
3034
|
|
|
2924
|
-
**requestOptions:** `
|
|
3035
|
+
**requestOptions:** `SpeechToText.RequestOptions`
|
|
2925
3036
|
|
|
2926
3037
|
</dd>
|
|
2927
3038
|
</dl>
|
|
@@ -2932,7 +3043,9 @@ await client.conversationalAi.getDocumentRagIndexes("21m00Tcm4TlvDq8ikWAM");
|
|
|
2932
3043
|
</dl>
|
|
2933
3044
|
</details>
|
|
2934
3045
|
|
|
2935
|
-
|
|
3046
|
+
## ForcedAlignment
|
|
3047
|
+
|
|
3048
|
+
<details><summary><code>client.forcedAlignment.<a href="/src/api/resources/forcedAlignment/client/Client.ts">create</a>({ ...params }) -> ElevenLabs.ForcedAlignmentResponseModel</code></summary>
|
|
2936
3049
|
<dl>
|
|
2937
3050
|
<dd>
|
|
2938
3051
|
|
|
@@ -2944,7 +3057,7 @@ await client.conversationalAi.getDocumentRagIndexes("21m00Tcm4TlvDq8ikWAM");
|
|
|
2944
3057
|
<dl>
|
|
2945
3058
|
<dd>
|
|
2946
3059
|
|
|
2947
|
-
|
|
3060
|
+
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.
|
|
2948
3061
|
|
|
2949
3062
|
</dd>
|
|
2950
3063
|
</dl>
|
|
@@ -2960,7 +3073,10 @@ Delete RAG index for the knowledgebase document.
|
|
|
2960
3073
|
<dd>
|
|
2961
3074
|
|
|
2962
3075
|
```typescript
|
|
2963
|
-
await client.
|
|
3076
|
+
await client.forcedAlignment.create({
|
|
3077
|
+
file: fs.createReadStream("/path/to/your/file"),
|
|
3078
|
+
text: "text",
|
|
3079
|
+
});
|
|
2964
3080
|
```
|
|
2965
3081
|
|
|
2966
3082
|
</dd>
|
|
@@ -2976,15 +3092,7 @@ await client.conversationalAi.deleteDocumentRagIndex("21m00Tcm4TlvDq8ikWAM", "21
|
|
|
2976
3092
|
<dl>
|
|
2977
3093
|
<dd>
|
|
2978
3094
|
|
|
2979
|
-
**
|
|
2980
|
-
|
|
2981
|
-
</dd>
|
|
2982
|
-
</dl>
|
|
2983
|
-
|
|
2984
|
-
<dl>
|
|
2985
|
-
<dd>
|
|
2986
|
-
|
|
2987
|
-
**ragIndexId:** `string` — The id of RAG index of document from the knowledge base.
|
|
3095
|
+
**request:** `ElevenLabs.BodyCreateForcedAlignmentV1ForcedAlignmentPost`
|
|
2988
3096
|
|
|
2989
3097
|
</dd>
|
|
2990
3098
|
</dl>
|
|
@@ -2992,7 +3100,7 @@ await client.conversationalAi.deleteDocumentRagIndex("21m00Tcm4TlvDq8ikWAM", "21
|
|
|
2992
3100
|
<dl>
|
|
2993
3101
|
<dd>
|
|
2994
3102
|
|
|
2995
|
-
**requestOptions:** `
|
|
3103
|
+
**requestOptions:** `ForcedAlignment.RequestOptions`
|
|
2996
3104
|
|
|
2997
3105
|
</dd>
|
|
2998
3106
|
</dl>
|
|
@@ -3003,7 +3111,9 @@ await client.conversationalAi.deleteDocumentRagIndex("21m00Tcm4TlvDq8ikWAM", "21
|
|
|
3003
3111
|
</dl>
|
|
3004
3112
|
</details>
|
|
3005
3113
|
|
|
3006
|
-
|
|
3114
|
+
## ConversationalAi
|
|
3115
|
+
|
|
3116
|
+
<details><summary><code>client.conversationalAi.<a href="/src/api/resources/conversationalAi/client/Client.ts">addToKnowledgeBase</a>({ ...params }) -> ElevenLabs.AddKnowledgeBaseResponseModel</code></summary>
|
|
3007
3117
|
<dl>
|
|
3008
3118
|
<dd>
|
|
3009
3119
|
|
|
@@ -3015,7 +3125,7 @@ await client.conversationalAi.deleteDocumentRagIndex("21m00Tcm4TlvDq8ikWAM", "21
|
|
|
3015
3125
|
<dl>
|
|
3016
3126
|
<dd>
|
|
3017
3127
|
|
|
3018
|
-
|
|
3128
|
+
Upload a file or webpage URL to create a knowledge base document. <br> <Note> After creating the document, update the agent's knowledge base by calling [Update agent](/docs/conversational-ai/api-reference/agents/update-agent). </Note>
|
|
3019
3129
|
|
|
3020
3130
|
</dd>
|
|
3021
3131
|
</dl>
|
|
@@ -3031,7 +3141,7 @@ Provides total size and other information of RAG indexes used by knowledgebase d
|
|
|
3031
3141
|
<dd>
|
|
3032
3142
|
|
|
3033
3143
|
```typescript
|
|
3034
|
-
await client.conversationalAi.
|
|
3144
|
+
await client.conversationalAi.addToKnowledgeBase({});
|
|
3035
3145
|
```
|
|
3036
3146
|
|
|
3037
3147
|
</dd>
|
|
@@ -3047,6 +3157,14 @@ await client.conversationalAi.ragIndexOverview();
|
|
|
3047
3157
|
<dl>
|
|
3048
3158
|
<dd>
|
|
3049
3159
|
|
|
3160
|
+
**request:** `ElevenLabs.BodyAddToKnowledgeBaseV1ConvaiKnowledgeBasePost`
|
|
3161
|
+
|
|
3162
|
+
</dd>
|
|
3163
|
+
</dl>
|
|
3164
|
+
|
|
3165
|
+
<dl>
|
|
3166
|
+
<dd>
|
|
3167
|
+
|
|
3050
3168
|
**requestOptions:** `ConversationalAi.RequestOptions`
|
|
3051
3169
|
|
|
3052
3170
|
</dd>
|
|
@@ -3058,7 +3176,7 @@ await client.conversationalAi.ragIndexOverview();
|
|
|
3058
3176
|
</dl>
|
|
3059
3177
|
</details>
|
|
3060
3178
|
|
|
3061
|
-
<details><summary><code>client.conversationalAi.<a href="/src/api/resources/conversationalAi/client/Client.ts">
|
|
3179
|
+
<details><summary><code>client.conversationalAi.<a href="/src/api/resources/conversationalAi/client/Client.ts">getDocumentRagIndexes</a>(documentationId) -> ElevenLabs.RagDocumentIndexesResponseModel</code></summary>
|
|
3062
3180
|
<dl>
|
|
3063
3181
|
<dd>
|
|
3064
3182
|
|
|
@@ -3070,7 +3188,7 @@ await client.conversationalAi.ragIndexOverview();
|
|
|
3070
3188
|
<dl>
|
|
3071
3189
|
<dd>
|
|
3072
3190
|
|
|
3073
|
-
|
|
3191
|
+
Provides information about all RAG indexes of the specified knowledgebase document.
|
|
3074
3192
|
|
|
3075
3193
|
</dd>
|
|
3076
3194
|
</dl>
|
|
@@ -3086,10 +3204,7 @@ Update an existing secret for the workspace
|
|
|
3086
3204
|
<dd>
|
|
3087
3205
|
|
|
3088
3206
|
```typescript
|
|
3089
|
-
await client.conversationalAi.
|
|
3090
|
-
name: "name",
|
|
3091
|
-
value: "value",
|
|
3092
|
-
});
|
|
3207
|
+
await client.conversationalAi.getDocumentRagIndexes("21m00Tcm4TlvDq8ikWAM");
|
|
3093
3208
|
```
|
|
3094
3209
|
|
|
3095
3210
|
</dd>
|
|
@@ -3105,15 +3220,7 @@ await client.conversationalAi.updateSecret("secret_id", {
|
|
|
3105
3220
|
<dl>
|
|
3106
3221
|
<dd>
|
|
3107
3222
|
|
|
3108
|
-
**
|
|
3109
|
-
|
|
3110
|
-
</dd>
|
|
3111
|
-
</dl>
|
|
3112
|
-
|
|
3113
|
-
<dl>
|
|
3114
|
-
<dd>
|
|
3115
|
-
|
|
3116
|
-
**request:** `ElevenLabs.PatchWorkspaceSecretRequest`
|
|
3223
|
+
**documentationId:** `string` — The id of a document from the knowledge base. This is returned on document addition.
|
|
3117
3224
|
|
|
3118
3225
|
</dd>
|
|
3119
3226
|
</dl>
|
|
@@ -3132,9 +3239,7 @@ await client.conversationalAi.updateSecret("secret_id", {
|
|
|
3132
3239
|
</dl>
|
|
3133
3240
|
</details>
|
|
3134
3241
|
|
|
3135
|
-
|
|
3136
|
-
|
|
3137
|
-
<details><summary><code>client.conversationalAi.conversations.<a href="/src/api/resources/conversationalAi/resources/conversations/client/Client.ts">getSignedUrl</a>({ ...params }) -> ElevenLabs.ConversationSignedUrlResponseModel</code></summary>
|
|
3242
|
+
<details><summary><code>client.conversationalAi.<a href="/src/api/resources/conversationalAi/client/Client.ts">deleteDocumentRagIndex</a>(documentationId, ragIndexId) -> ElevenLabs.RagDocumentIndexResponseModel</code></summary>
|
|
3138
3243
|
<dl>
|
|
3139
3244
|
<dd>
|
|
3140
3245
|
|
|
@@ -3146,7 +3251,7 @@ await client.conversationalAi.updateSecret("secret_id", {
|
|
|
3146
3251
|
<dl>
|
|
3147
3252
|
<dd>
|
|
3148
3253
|
|
|
3149
|
-
|
|
3254
|
+
Delete RAG index for the knowledgebase document.
|
|
3150
3255
|
|
|
3151
3256
|
</dd>
|
|
3152
3257
|
</dl>
|
|
@@ -3162,9 +3267,7 @@ Get a signed url to start a conversation with an agent with an agent that requir
|
|
|
3162
3267
|
<dd>
|
|
3163
3268
|
|
|
3164
3269
|
```typescript
|
|
3165
|
-
await client.conversationalAi.
|
|
3166
|
-
agentId: "21m00Tcm4TlvDq8ikWAM",
|
|
3167
|
-
});
|
|
3270
|
+
await client.conversationalAi.deleteDocumentRagIndex("21m00Tcm4TlvDq8ikWAM", "21m00Tcm4TlvDq8ikWAM");
|
|
3168
3271
|
```
|
|
3169
3272
|
|
|
3170
3273
|
</dd>
|
|
@@ -3180,7 +3283,7 @@ await client.conversationalAi.conversations.getSignedUrl({
|
|
|
3180
3283
|
<dl>
|
|
3181
3284
|
<dd>
|
|
3182
3285
|
|
|
3183
|
-
**
|
|
3286
|
+
**documentationId:** `string` — The id of a document from the knowledge base. This is returned on document addition.
|
|
3184
3287
|
|
|
3185
3288
|
</dd>
|
|
3186
3289
|
</dl>
|
|
@@ -3188,7 +3291,15 @@ await client.conversationalAi.conversations.getSignedUrl({
|
|
|
3188
3291
|
<dl>
|
|
3189
3292
|
<dd>
|
|
3190
3293
|
|
|
3191
|
-
**
|
|
3294
|
+
**ragIndexId:** `string` — The id of RAG index of document from the knowledge base.
|
|
3295
|
+
|
|
3296
|
+
</dd>
|
|
3297
|
+
</dl>
|
|
3298
|
+
|
|
3299
|
+
<dl>
|
|
3300
|
+
<dd>
|
|
3301
|
+
|
|
3302
|
+
**requestOptions:** `ConversationalAi.RequestOptions`
|
|
3192
3303
|
|
|
3193
3304
|
</dd>
|
|
3194
3305
|
</dl>
|
|
@@ -3199,7 +3310,7 @@ await client.conversationalAi.conversations.getSignedUrl({
|
|
|
3199
3310
|
</dl>
|
|
3200
3311
|
</details>
|
|
3201
3312
|
|
|
3202
|
-
<details><summary><code>client.conversationalAi
|
|
3313
|
+
<details><summary><code>client.conversationalAi.<a href="/src/api/resources/conversationalAi/client/Client.ts">ragIndexOverview</a>() -> ElevenLabs.RagIndexOverviewResponseModel</code></summary>
|
|
3203
3314
|
<dl>
|
|
3204
3315
|
<dd>
|
|
3205
3316
|
|
|
@@ -3211,7 +3322,7 @@ await client.conversationalAi.conversations.getSignedUrl({
|
|
|
3211
3322
|
<dl>
|
|
3212
3323
|
<dd>
|
|
3213
3324
|
|
|
3214
|
-
|
|
3325
|
+
Provides total size and other information of RAG indexes used by knowledgebase documents
|
|
3215
3326
|
|
|
3216
3327
|
</dd>
|
|
3217
3328
|
</dl>
|
|
@@ -3227,7 +3338,7 @@ Get all conversations of agents that user owns. With option to restrict to a spe
|
|
|
3227
3338
|
<dd>
|
|
3228
3339
|
|
|
3229
3340
|
```typescript
|
|
3230
|
-
await client.conversationalAi.
|
|
3341
|
+
await client.conversationalAi.ragIndexOverview();
|
|
3231
3342
|
```
|
|
3232
3343
|
|
|
3233
3344
|
</dd>
|
|
@@ -3243,15 +3354,7 @@ await client.conversationalAi.conversations.list();
|
|
|
3243
3354
|
<dl>
|
|
3244
3355
|
<dd>
|
|
3245
3356
|
|
|
3246
|
-
**
|
|
3247
|
-
|
|
3248
|
-
</dd>
|
|
3249
|
-
</dl>
|
|
3250
|
-
|
|
3251
|
-
<dl>
|
|
3252
|
-
<dd>
|
|
3253
|
-
|
|
3254
|
-
**requestOptions:** `Conversations.RequestOptions`
|
|
3357
|
+
**requestOptions:** `ConversationalAi.RequestOptions`
|
|
3255
3358
|
|
|
3256
3359
|
</dd>
|
|
3257
3360
|
</dl>
|
|
@@ -3262,7 +3365,7 @@ await client.conversationalAi.conversations.list();
|
|
|
3262
3365
|
</dl>
|
|
3263
3366
|
</details>
|
|
3264
3367
|
|
|
3265
|
-
<details><summary><code>client.conversationalAi
|
|
3368
|
+
<details><summary><code>client.conversationalAi.<a href="/src/api/resources/conversationalAi/client/Client.ts">updateSecret</a>(secretId, { ...params }) -> ElevenLabs.PostWorkspaceSecretResponseModel</code></summary>
|
|
3266
3369
|
<dl>
|
|
3267
3370
|
<dd>
|
|
3268
3371
|
|
|
@@ -3274,7 +3377,7 @@ await client.conversationalAi.conversations.list();
|
|
|
3274
3377
|
<dl>
|
|
3275
3378
|
<dd>
|
|
3276
3379
|
|
|
3277
|
-
|
|
3380
|
+
Update an existing secret for the workspace
|
|
3278
3381
|
|
|
3279
3382
|
</dd>
|
|
3280
3383
|
</dl>
|
|
@@ -3290,7 +3393,10 @@ Get the details of a particular conversation
|
|
|
3290
3393
|
<dd>
|
|
3291
3394
|
|
|
3292
3395
|
```typescript
|
|
3293
|
-
await client.conversationalAi.
|
|
3396
|
+
await client.conversationalAi.updateSecret("secret_id", {
|
|
3397
|
+
name: "name",
|
|
3398
|
+
value: "value",
|
|
3399
|
+
});
|
|
3294
3400
|
```
|
|
3295
3401
|
|
|
3296
3402
|
</dd>
|
|
@@ -3306,7 +3412,7 @@ await client.conversationalAi.conversations.get("123");
|
|
|
3306
3412
|
<dl>
|
|
3307
3413
|
<dd>
|
|
3308
3414
|
|
|
3309
|
-
**
|
|
3415
|
+
**secretId:** `string`
|
|
3310
3416
|
|
|
3311
3417
|
</dd>
|
|
3312
3418
|
</dl>
|
|
@@ -3314,7 +3420,15 @@ await client.conversationalAi.conversations.get("123");
|
|
|
3314
3420
|
<dl>
|
|
3315
3421
|
<dd>
|
|
3316
3422
|
|
|
3317
|
-
**
|
|
3423
|
+
**request:** `ElevenLabs.PatchWorkspaceSecretRequest`
|
|
3424
|
+
|
|
3425
|
+
</dd>
|
|
3426
|
+
</dl>
|
|
3427
|
+
|
|
3428
|
+
<dl>
|
|
3429
|
+
<dd>
|
|
3430
|
+
|
|
3431
|
+
**requestOptions:** `ConversationalAi.RequestOptions`
|
|
3318
3432
|
|
|
3319
3433
|
</dd>
|
|
3320
3434
|
</dl>
|
|
@@ -3325,7 +3439,9 @@ await client.conversationalAi.conversations.get("123");
|
|
|
3325
3439
|
</dl>
|
|
3326
3440
|
</details>
|
|
3327
3441
|
|
|
3328
|
-
|
|
3442
|
+
## ConversationalAi Conversations
|
|
3443
|
+
|
|
3444
|
+
<details><summary><code>client.conversationalAi.conversations.<a href="/src/api/resources/conversationalAi/resources/conversations/client/Client.ts">getSignedUrl</a>({ ...params }) -> ElevenLabs.ConversationSignedUrlResponseModel</code></summary>
|
|
3329
3445
|
<dl>
|
|
3330
3446
|
<dd>
|
|
3331
3447
|
|
|
@@ -3337,7 +3453,7 @@ await client.conversationalAi.conversations.get("123");
|
|
|
3337
3453
|
<dl>
|
|
3338
3454
|
<dd>
|
|
3339
3455
|
|
|
3340
|
-
|
|
3456
|
+
Get a signed url to start a conversation with an agent with an agent that requires authorization
|
|
3341
3457
|
|
|
3342
3458
|
</dd>
|
|
3343
3459
|
</dl>
|
|
@@ -3353,7 +3469,9 @@ Delete a particular conversation
|
|
|
3353
3469
|
<dd>
|
|
3354
3470
|
|
|
3355
3471
|
```typescript
|
|
3356
|
-
await client.conversationalAi.conversations.
|
|
3472
|
+
await client.conversationalAi.conversations.getSignedUrl({
|
|
3473
|
+
agentId: "21m00Tcm4TlvDq8ikWAM",
|
|
3474
|
+
});
|
|
3357
3475
|
```
|
|
3358
3476
|
|
|
3359
3477
|
</dd>
|
|
@@ -3369,7 +3487,7 @@ await client.conversationalAi.conversations.delete("21m00Tcm4TlvDq8ikWAM");
|
|
|
3369
3487
|
<dl>
|
|
3370
3488
|
<dd>
|
|
3371
3489
|
|
|
3372
|
-
**
|
|
3490
|
+
**request:** `ElevenLabs.conversationalAi.ConversationsGetSignedUrlRequest`
|
|
3373
3491
|
|
|
3374
3492
|
</dd>
|
|
3375
3493
|
</dl>
|
|
@@ -3388,9 +3506,7 @@ await client.conversationalAi.conversations.delete("21m00Tcm4TlvDq8ikWAM");
|
|
|
3388
3506
|
</dl>
|
|
3389
3507
|
</details>
|
|
3390
3508
|
|
|
3391
|
-
|
|
3392
|
-
|
|
3393
|
-
<details><summary><code>client.conversationalAi.twilio.<a href="/src/api/resources/conversationalAi/resources/twilio/client/Client.ts">outboundCall</a>({ ...params }) -> ElevenLabs.TwilioOutboundCallResponse</code></summary>
|
|
3509
|
+
<details><summary><code>client.conversationalAi.conversations.<a href="/src/api/resources/conversationalAi/resources/conversations/client/Client.ts">list</a>({ ...params }) -> ElevenLabs.GetConversationsPageResponseModel</code></summary>
|
|
3394
3510
|
<dl>
|
|
3395
3511
|
<dd>
|
|
3396
3512
|
|
|
@@ -3402,7 +3518,7 @@ await client.conversationalAi.conversations.delete("21m00Tcm4TlvDq8ikWAM");
|
|
|
3402
3518
|
<dl>
|
|
3403
3519
|
<dd>
|
|
3404
3520
|
|
|
3405
|
-
|
|
3521
|
+
Get all conversations of agents that user owns. With option to restrict to a specific agent.
|
|
3406
3522
|
|
|
3407
3523
|
</dd>
|
|
3408
3524
|
</dl>
|
|
@@ -3418,11 +3534,7 @@ Handle an outbound call via Twilio
|
|
|
3418
3534
|
<dd>
|
|
3419
3535
|
|
|
3420
3536
|
```typescript
|
|
3421
|
-
await client.conversationalAi.
|
|
3422
|
-
agentId: "agent_id",
|
|
3423
|
-
agentPhoneNumberId: "agent_phone_number_id",
|
|
3424
|
-
toNumber: "to_number",
|
|
3425
|
-
});
|
|
3537
|
+
await client.conversationalAi.conversations.list();
|
|
3426
3538
|
```
|
|
3427
3539
|
|
|
3428
3540
|
</dd>
|
|
@@ -3438,7 +3550,7 @@ await client.conversationalAi.twilio.outboundCall({
|
|
|
3438
3550
|
<dl>
|
|
3439
3551
|
<dd>
|
|
3440
3552
|
|
|
3441
|
-
**request:** `ElevenLabs.conversationalAi.
|
|
3553
|
+
**request:** `ElevenLabs.conversationalAi.ConversationsListRequest`
|
|
3442
3554
|
|
|
3443
3555
|
</dd>
|
|
3444
3556
|
</dl>
|
|
@@ -3446,7 +3558,7 @@ await client.conversationalAi.twilio.outboundCall({
|
|
|
3446
3558
|
<dl>
|
|
3447
3559
|
<dd>
|
|
3448
3560
|
|
|
3449
|
-
**requestOptions:** `
|
|
3561
|
+
**requestOptions:** `Conversations.RequestOptions`
|
|
3450
3562
|
|
|
3451
3563
|
</dd>
|
|
3452
3564
|
</dl>
|
|
@@ -3457,9 +3569,7 @@ await client.conversationalAi.twilio.outboundCall({
|
|
|
3457
3569
|
</dl>
|
|
3458
3570
|
</details>
|
|
3459
3571
|
|
|
3460
|
-
|
|
3461
|
-
|
|
3462
|
-
<details><summary><code>client.conversationalAi.agents.<a href="/src/api/resources/conversationalAi/resources/agents/client/Client.ts">create</a>({ ...params }) -> ElevenLabs.CreateAgentResponseModel</code></summary>
|
|
3572
|
+
<details><summary><code>client.conversationalAi.conversations.<a href="/src/api/resources/conversationalAi/resources/conversations/client/Client.ts">get</a>(conversationId) -> ElevenLabs.GetConversationResponseModel</code></summary>
|
|
3463
3573
|
<dl>
|
|
3464
3574
|
<dd>
|
|
3465
3575
|
|
|
@@ -3471,7 +3581,7 @@ await client.conversationalAi.twilio.outboundCall({
|
|
|
3471
3581
|
<dl>
|
|
3472
3582
|
<dd>
|
|
3473
3583
|
|
|
3474
|
-
|
|
3584
|
+
Get the details of a particular conversation
|
|
3475
3585
|
|
|
3476
3586
|
</dd>
|
|
3477
3587
|
</dl>
|
|
@@ -3487,9 +3597,7 @@ Create an agent from a config object
|
|
|
3487
3597
|
<dd>
|
|
3488
3598
|
|
|
3489
3599
|
```typescript
|
|
3490
|
-
await client.conversationalAi.
|
|
3491
|
-
conversationConfig: {},
|
|
3492
|
-
});
|
|
3600
|
+
await client.conversationalAi.conversations.get("123");
|
|
3493
3601
|
```
|
|
3494
3602
|
|
|
3495
3603
|
</dd>
|
|
@@ -3505,7 +3613,7 @@ await client.conversationalAi.agents.create({
|
|
|
3505
3613
|
<dl>
|
|
3506
3614
|
<dd>
|
|
3507
3615
|
|
|
3508
|
-
**
|
|
3616
|
+
**conversationId:** `string` — The id of the conversation you're taking the action on.
|
|
3509
3617
|
|
|
3510
3618
|
</dd>
|
|
3511
3619
|
</dl>
|
|
@@ -3513,7 +3621,7 @@ await client.conversationalAi.agents.create({
|
|
|
3513
3621
|
<dl>
|
|
3514
3622
|
<dd>
|
|
3515
3623
|
|
|
3516
|
-
**requestOptions:** `
|
|
3624
|
+
**requestOptions:** `Conversations.RequestOptions`
|
|
3517
3625
|
|
|
3518
3626
|
</dd>
|
|
3519
3627
|
</dl>
|
|
@@ -3524,7 +3632,7 @@ await client.conversationalAi.agents.create({
|
|
|
3524
3632
|
</dl>
|
|
3525
3633
|
</details>
|
|
3526
3634
|
|
|
3527
|
-
<details><summary><code>client.conversationalAi.
|
|
3635
|
+
<details><summary><code>client.conversationalAi.conversations.<a href="/src/api/resources/conversationalAi/resources/conversations/client/Client.ts">delete</a>(conversationId) -> unknown</code></summary>
|
|
3528
3636
|
<dl>
|
|
3529
3637
|
<dd>
|
|
3530
3638
|
|
|
@@ -3536,7 +3644,7 @@ await client.conversationalAi.agents.create({
|
|
|
3536
3644
|
<dl>
|
|
3537
3645
|
<dd>
|
|
3538
3646
|
|
|
3539
|
-
|
|
3647
|
+
Delete a particular conversation
|
|
3540
3648
|
|
|
3541
3649
|
</dd>
|
|
3542
3650
|
</dl>
|
|
@@ -3552,7 +3660,7 @@ Retrieve config for an agent
|
|
|
3552
3660
|
<dd>
|
|
3553
3661
|
|
|
3554
3662
|
```typescript
|
|
3555
|
-
await client.conversationalAi.
|
|
3663
|
+
await client.conversationalAi.conversations.delete("21m00Tcm4TlvDq8ikWAM");
|
|
3556
3664
|
```
|
|
3557
3665
|
|
|
3558
3666
|
</dd>
|
|
@@ -3568,7 +3676,7 @@ await client.conversationalAi.agents.get("21m00Tcm4TlvDq8ikWAM");
|
|
|
3568
3676
|
<dl>
|
|
3569
3677
|
<dd>
|
|
3570
3678
|
|
|
3571
|
-
**
|
|
3679
|
+
**conversationId:** `string` — The id of the conversation you're taking the action on.
|
|
3572
3680
|
|
|
3573
3681
|
</dd>
|
|
3574
3682
|
</dl>
|
|
@@ -3576,7 +3684,7 @@ await client.conversationalAi.agents.get("21m00Tcm4TlvDq8ikWAM");
|
|
|
3576
3684
|
<dl>
|
|
3577
3685
|
<dd>
|
|
3578
3686
|
|
|
3579
|
-
**requestOptions:** `
|
|
3687
|
+
**requestOptions:** `Conversations.RequestOptions`
|
|
3580
3688
|
|
|
3581
3689
|
</dd>
|
|
3582
3690
|
</dl>
|
|
@@ -3587,7 +3695,9 @@ await client.conversationalAi.agents.get("21m00Tcm4TlvDq8ikWAM");
|
|
|
3587
3695
|
</dl>
|
|
3588
3696
|
</details>
|
|
3589
3697
|
|
|
3590
|
-
|
|
3698
|
+
## ConversationalAi Twilio
|
|
3699
|
+
|
|
3700
|
+
<details><summary><code>client.conversationalAi.twilio.<a href="/src/api/resources/conversationalAi/resources/twilio/client/Client.ts">outboundCall</a>({ ...params }) -> ElevenLabs.TwilioOutboundCallResponse</code></summary>
|
|
3591
3701
|
<dl>
|
|
3592
3702
|
<dd>
|
|
3593
3703
|
|
|
@@ -3599,7 +3709,7 @@ await client.conversationalAi.agents.get("21m00Tcm4TlvDq8ikWAM");
|
|
|
3599
3709
|
<dl>
|
|
3600
3710
|
<dd>
|
|
3601
3711
|
|
|
3602
|
-
|
|
3712
|
+
Handle an outbound call via Twilio
|
|
3603
3713
|
|
|
3604
3714
|
</dd>
|
|
3605
3715
|
</dl>
|
|
@@ -3615,7 +3725,11 @@ Delete an agent
|
|
|
3615
3725
|
<dd>
|
|
3616
3726
|
|
|
3617
3727
|
```typescript
|
|
3618
|
-
await client.conversationalAi.
|
|
3728
|
+
await client.conversationalAi.twilio.outboundCall({
|
|
3729
|
+
agentId: "agent_id",
|
|
3730
|
+
agentPhoneNumberId: "agent_phone_number_id",
|
|
3731
|
+
toNumber: "to_number",
|
|
3732
|
+
});
|
|
3619
3733
|
```
|
|
3620
3734
|
|
|
3621
3735
|
</dd>
|
|
@@ -3631,7 +3745,7 @@ await client.conversationalAi.agents.delete("21m00Tcm4TlvDq8ikWAM");
|
|
|
3631
3745
|
<dl>
|
|
3632
3746
|
<dd>
|
|
3633
3747
|
|
|
3634
|
-
**
|
|
3748
|
+
**request:** `ElevenLabs.conversationalAi.BodyHandleAnOutboundCallViaTwilioV1ConvaiTwilioOutboundCallPost`
|
|
3635
3749
|
|
|
3636
3750
|
</dd>
|
|
3637
3751
|
</dl>
|
|
@@ -3639,7 +3753,7 @@ await client.conversationalAi.agents.delete("21m00Tcm4TlvDq8ikWAM");
|
|
|
3639
3753
|
<dl>
|
|
3640
3754
|
<dd>
|
|
3641
3755
|
|
|
3642
|
-
**requestOptions:** `
|
|
3756
|
+
**requestOptions:** `Twilio.RequestOptions`
|
|
3643
3757
|
|
|
3644
3758
|
</dd>
|
|
3645
3759
|
</dl>
|
|
@@ -3650,7 +3764,9 @@ await client.conversationalAi.agents.delete("21m00Tcm4TlvDq8ikWAM");
|
|
|
3650
3764
|
</dl>
|
|
3651
3765
|
</details>
|
|
3652
3766
|
|
|
3653
|
-
|
|
3767
|
+
## ConversationalAi Agents
|
|
3768
|
+
|
|
3769
|
+
<details><summary><code>client.conversationalAi.agents.<a href="/src/api/resources/conversationalAi/resources/agents/client/Client.ts">create</a>({ ...params }) -> ElevenLabs.CreateAgentResponseModel</code></summary>
|
|
3654
3770
|
<dl>
|
|
3655
3771
|
<dd>
|
|
3656
3772
|
|
|
@@ -3662,7 +3778,7 @@ await client.conversationalAi.agents.delete("21m00Tcm4TlvDq8ikWAM");
|
|
|
3662
3778
|
<dl>
|
|
3663
3779
|
<dd>
|
|
3664
3780
|
|
|
3665
|
-
|
|
3781
|
+
Create an agent from a config object
|
|
3666
3782
|
|
|
3667
3783
|
</dd>
|
|
3668
3784
|
</dl>
|
|
@@ -3678,7 +3794,9 @@ Patches an Agent settings
|
|
|
3678
3794
|
<dd>
|
|
3679
3795
|
|
|
3680
3796
|
```typescript
|
|
3681
|
-
await client.conversationalAi.agents.
|
|
3797
|
+
await client.conversationalAi.agents.create({
|
|
3798
|
+
conversationConfig: {},
|
|
3799
|
+
});
|
|
3682
3800
|
```
|
|
3683
3801
|
|
|
3684
3802
|
</dd>
|
|
@@ -3694,15 +3812,7 @@ await client.conversationalAi.agents.update("21m00Tcm4TlvDq8ikWAM");
|
|
|
3694
3812
|
<dl>
|
|
3695
3813
|
<dd>
|
|
3696
3814
|
|
|
3697
|
-
**
|
|
3698
|
-
|
|
3699
|
-
</dd>
|
|
3700
|
-
</dl>
|
|
3701
|
-
|
|
3702
|
-
<dl>
|
|
3703
|
-
<dd>
|
|
3704
|
-
|
|
3705
|
-
**request:** `ElevenLabs.conversationalAi.UpdateAgentRequest`
|
|
3815
|
+
**request:** `ElevenLabs.conversationalAi.BodyCreateAgentV1ConvaiAgentsCreatePost`
|
|
3706
3816
|
|
|
3707
3817
|
</dd>
|
|
3708
3818
|
</dl>
|
|
@@ -3721,7 +3831,7 @@ await client.conversationalAi.agents.update("21m00Tcm4TlvDq8ikWAM");
|
|
|
3721
3831
|
</dl>
|
|
3722
3832
|
</details>
|
|
3723
3833
|
|
|
3724
|
-
<details><summary><code>client.conversationalAi.agents.<a href="/src/api/resources/conversationalAi/resources/agents/client/Client.ts">
|
|
3834
|
+
<details><summary><code>client.conversationalAi.agents.<a href="/src/api/resources/conversationalAi/resources/agents/client/Client.ts">get</a>(agentId) -> ElevenLabs.GetAgentResponseModel</code></summary>
|
|
3725
3835
|
<dl>
|
|
3726
3836
|
<dd>
|
|
3727
3837
|
|
|
@@ -3733,7 +3843,7 @@ await client.conversationalAi.agents.update("21m00Tcm4TlvDq8ikWAM");
|
|
|
3733
3843
|
<dl>
|
|
3734
3844
|
<dd>
|
|
3735
3845
|
|
|
3736
|
-
|
|
3846
|
+
Retrieve config for an agent
|
|
3737
3847
|
|
|
3738
3848
|
</dd>
|
|
3739
3849
|
</dl>
|
|
@@ -3749,7 +3859,7 @@ Returns a list of your agents and their metadata.
|
|
|
3749
3859
|
<dd>
|
|
3750
3860
|
|
|
3751
3861
|
```typescript
|
|
3752
|
-
await client.conversationalAi.agents.
|
|
3862
|
+
await client.conversationalAi.agents.get("21m00Tcm4TlvDq8ikWAM");
|
|
3753
3863
|
```
|
|
3754
3864
|
|
|
3755
3865
|
</dd>
|
|
@@ -3765,7 +3875,7 @@ await client.conversationalAi.agents.list();
|
|
|
3765
3875
|
<dl>
|
|
3766
3876
|
<dd>
|
|
3767
3877
|
|
|
3768
|
-
**
|
|
3878
|
+
**agentId:** `string` — The id of an agent. This is returned on agent creation.
|
|
3769
3879
|
|
|
3770
3880
|
</dd>
|
|
3771
3881
|
</dl>
|
|
@@ -3784,7 +3894,7 @@ await client.conversationalAi.agents.list();
|
|
|
3784
3894
|
</dl>
|
|
3785
3895
|
</details>
|
|
3786
3896
|
|
|
3787
|
-
<details><summary><code>client.conversationalAi.agents.<a href="/src/api/resources/conversationalAi/resources/agents/client/Client.ts">
|
|
3897
|
+
<details><summary><code>client.conversationalAi.agents.<a href="/src/api/resources/conversationalAi/resources/agents/client/Client.ts">delete</a>(agentId) -> void</code></summary>
|
|
3788
3898
|
<dl>
|
|
3789
3899
|
<dd>
|
|
3790
3900
|
|
|
@@ -3796,7 +3906,7 @@ await client.conversationalAi.agents.list();
|
|
|
3796
3906
|
<dl>
|
|
3797
3907
|
<dd>
|
|
3798
3908
|
|
|
3799
|
-
|
|
3909
|
+
Delete an agent
|
|
3800
3910
|
|
|
3801
3911
|
</dd>
|
|
3802
3912
|
</dl>
|
|
@@ -3812,14 +3922,7 @@ Run a conversation between the agent and a simulated user.
|
|
|
3812
3922
|
<dd>
|
|
3813
3923
|
|
|
3814
3924
|
```typescript
|
|
3815
|
-
await client.conversationalAi.agents.
|
|
3816
|
-
simulationSpecification: {
|
|
3817
|
-
simulatedUserConfig: {
|
|
3818
|
-
firstMessage: "Hello, how can I help you today?",
|
|
3819
|
-
language: "en",
|
|
3820
|
-
},
|
|
3821
|
-
},
|
|
3822
|
-
});
|
|
3925
|
+
await client.conversationalAi.agents.delete("21m00Tcm4TlvDq8ikWAM");
|
|
3823
3926
|
```
|
|
3824
3927
|
|
|
3825
3928
|
</dd>
|
|
@@ -3843,14 +3946,6 @@ await client.conversationalAi.agents.simulateConversation("21m00Tcm4TlvDq8ikWAM"
|
|
|
3843
3946
|
<dl>
|
|
3844
3947
|
<dd>
|
|
3845
3948
|
|
|
3846
|
-
**request:** `ElevenLabs.conversationalAi.BodySimulatesAConversationV1ConvaiAgentsAgentIdSimulateConversationPost`
|
|
3847
|
-
|
|
3848
|
-
</dd>
|
|
3849
|
-
</dl>
|
|
3850
|
-
|
|
3851
|
-
<dl>
|
|
3852
|
-
<dd>
|
|
3853
|
-
|
|
3854
3949
|
**requestOptions:** `Agents.RequestOptions`
|
|
3855
3950
|
|
|
3856
3951
|
</dd>
|
|
@@ -3862,7 +3957,7 @@ await client.conversationalAi.agents.simulateConversation("21m00Tcm4TlvDq8ikWAM"
|
|
|
3862
3957
|
</dl>
|
|
3863
3958
|
</details>
|
|
3864
3959
|
|
|
3865
|
-
<details><summary><code>client.conversationalAi.agents.<a href="/src/api/resources/conversationalAi/resources/agents/client/Client.ts">
|
|
3960
|
+
<details><summary><code>client.conversationalAi.agents.<a href="/src/api/resources/conversationalAi/resources/agents/client/Client.ts">update</a>(agentId, { ...params }) -> ElevenLabs.GetAgentResponseModel</code></summary>
|
|
3866
3961
|
<dl>
|
|
3867
3962
|
<dd>
|
|
3868
3963
|
|
|
@@ -3874,7 +3969,7 @@ await client.conversationalAi.agents.simulateConversation("21m00Tcm4TlvDq8ikWAM"
|
|
|
3874
3969
|
<dl>
|
|
3875
3970
|
<dd>
|
|
3876
3971
|
|
|
3877
|
-
|
|
3972
|
+
Patches an Agent settings
|
|
3878
3973
|
|
|
3879
3974
|
</dd>
|
|
3880
3975
|
</dl>
|
|
@@ -3890,14 +3985,7 @@ Run a conversation between the agent and a simulated user and stream back the re
|
|
|
3890
3985
|
<dd>
|
|
3891
3986
|
|
|
3892
3987
|
```typescript
|
|
3893
|
-
await client.conversationalAi.agents.
|
|
3894
|
-
simulationSpecification: {
|
|
3895
|
-
simulatedUserConfig: {
|
|
3896
|
-
firstMessage: "Hello, how can I help you today?",
|
|
3897
|
-
language: "en",
|
|
3898
|
-
},
|
|
3899
|
-
},
|
|
3900
|
-
});
|
|
3988
|
+
await client.conversationalAi.agents.update("21m00Tcm4TlvDq8ikWAM");
|
|
3901
3989
|
```
|
|
3902
3990
|
|
|
3903
3991
|
</dd>
|
|
@@ -3921,7 +4009,7 @@ await client.conversationalAi.agents.simulateConversationStream("21m00Tcm4TlvDq8
|
|
|
3921
4009
|
<dl>
|
|
3922
4010
|
<dd>
|
|
3923
4011
|
|
|
3924
|
-
**request:** `ElevenLabs.conversationalAi.
|
|
4012
|
+
**request:** `ElevenLabs.conversationalAi.UpdateAgentRequest`
|
|
3925
4013
|
|
|
3926
4014
|
</dd>
|
|
3927
4015
|
</dl>
|
|
@@ -3940,9 +4028,7 @@ await client.conversationalAi.agents.simulateConversationStream("21m00Tcm4TlvDq8
|
|
|
3940
4028
|
</dl>
|
|
3941
4029
|
</details>
|
|
3942
4030
|
|
|
3943
|
-
|
|
3944
|
-
|
|
3945
|
-
<details><summary><code>client.conversationalAi.phoneNumbers.<a href="/src/api/resources/conversationalAi/resources/phoneNumbers/client/Client.ts">create</a>({ ...params }) -> ElevenLabs.CreatePhoneNumberResponseModel</code></summary>
|
|
4031
|
+
<details><summary><code>client.conversationalAi.agents.<a href="/src/api/resources/conversationalAi/resources/agents/client/Client.ts">list</a>({ ...params }) -> ElevenLabs.GetAgentsPageResponseModel</code></summary>
|
|
3946
4032
|
<dl>
|
|
3947
4033
|
<dd>
|
|
3948
4034
|
|
|
@@ -3954,7 +4040,7 @@ await client.conversationalAi.agents.simulateConversationStream("21m00Tcm4TlvDq8
|
|
|
3954
4040
|
<dl>
|
|
3955
4041
|
<dd>
|
|
3956
4042
|
|
|
3957
|
-
|
|
4043
|
+
Returns a list of your agents and their metadata.
|
|
3958
4044
|
|
|
3959
4045
|
</dd>
|
|
3960
4046
|
</dl>
|
|
@@ -3970,13 +4056,7 @@ Import Phone Number from provider configuration (Twilio or SIP trunk)
|
|
|
3970
4056
|
<dd>
|
|
3971
4057
|
|
|
3972
4058
|
```typescript
|
|
3973
|
-
await client.conversationalAi.
|
|
3974
|
-
provider: "twilio",
|
|
3975
|
-
phoneNumber: "phone_number",
|
|
3976
|
-
label: "label",
|
|
3977
|
-
sid: "sid",
|
|
3978
|
-
token: "token",
|
|
3979
|
-
});
|
|
4059
|
+
await client.conversationalAi.agents.list();
|
|
3980
4060
|
```
|
|
3981
4061
|
|
|
3982
4062
|
</dd>
|
|
@@ -3992,7 +4072,7 @@ await client.conversationalAi.phoneNumbers.create({
|
|
|
3992
4072
|
<dl>
|
|
3993
4073
|
<dd>
|
|
3994
4074
|
|
|
3995
|
-
**request:** `ElevenLabs.
|
|
4075
|
+
**request:** `ElevenLabs.conversationalAi.AgentsListRequest`
|
|
3996
4076
|
|
|
3997
4077
|
</dd>
|
|
3998
4078
|
</dl>
|
|
@@ -4000,7 +4080,7 @@ await client.conversationalAi.phoneNumbers.create({
|
|
|
4000
4080
|
<dl>
|
|
4001
4081
|
<dd>
|
|
4002
4082
|
|
|
4003
|
-
**requestOptions:** `
|
|
4083
|
+
**requestOptions:** `Agents.RequestOptions`
|
|
4004
4084
|
|
|
4005
4085
|
</dd>
|
|
4006
4086
|
</dl>
|
|
@@ -4011,7 +4091,7 @@ await client.conversationalAi.phoneNumbers.create({
|
|
|
4011
4091
|
</dl>
|
|
4012
4092
|
</details>
|
|
4013
4093
|
|
|
4014
|
-
<details><summary><code>client.conversationalAi.
|
|
4094
|
+
<details><summary><code>client.conversationalAi.agents.<a href="/src/api/resources/conversationalAi/resources/agents/client/Client.ts">duplicate</a>(agentId, { ...params }) -> ElevenLabs.CreateAgentResponseModel</code></summary>
|
|
4015
4095
|
<dl>
|
|
4016
4096
|
<dd>
|
|
4017
4097
|
|
|
@@ -4023,7 +4103,7 @@ await client.conversationalAi.phoneNumbers.create({
|
|
|
4023
4103
|
<dl>
|
|
4024
4104
|
<dd>
|
|
4025
4105
|
|
|
4026
|
-
|
|
4106
|
+
Create a new agent by duplicating an existing one
|
|
4027
4107
|
|
|
4028
4108
|
</dd>
|
|
4029
4109
|
</dl>
|
|
@@ -4039,7 +4119,7 @@ Retrieve Phone Number details by ID
|
|
|
4039
4119
|
<dd>
|
|
4040
4120
|
|
|
4041
4121
|
```typescript
|
|
4042
|
-
await client.conversationalAi.
|
|
4122
|
+
await client.conversationalAi.agents.duplicate("21m00Tcm4TlvDq8ikWAM");
|
|
4043
4123
|
```
|
|
4044
4124
|
|
|
4045
4125
|
</dd>
|
|
@@ -4055,7 +4135,7 @@ await client.conversationalAi.phoneNumbers.get("TeaqRRdTcIfIu2i7BYfT");
|
|
|
4055
4135
|
<dl>
|
|
4056
4136
|
<dd>
|
|
4057
4137
|
|
|
4058
|
-
**
|
|
4138
|
+
**agentId:** `string` — The id of an agent. This is returned on agent creation.
|
|
4059
4139
|
|
|
4060
4140
|
</dd>
|
|
4061
4141
|
</dl>
|
|
@@ -4063,7 +4143,15 @@ await client.conversationalAi.phoneNumbers.get("TeaqRRdTcIfIu2i7BYfT");
|
|
|
4063
4143
|
<dl>
|
|
4064
4144
|
<dd>
|
|
4065
4145
|
|
|
4066
|
-
**
|
|
4146
|
+
**request:** `ElevenLabs.conversationalAi.BodyDuplicateAgentV1ConvaiAgentsAgentIdDuplicatePost`
|
|
4147
|
+
|
|
4148
|
+
</dd>
|
|
4149
|
+
</dl>
|
|
4150
|
+
|
|
4151
|
+
<dl>
|
|
4152
|
+
<dd>
|
|
4153
|
+
|
|
4154
|
+
**requestOptions:** `Agents.RequestOptions`
|
|
4067
4155
|
|
|
4068
4156
|
</dd>
|
|
4069
4157
|
</dl>
|
|
@@ -4074,7 +4162,7 @@ await client.conversationalAi.phoneNumbers.get("TeaqRRdTcIfIu2i7BYfT");
|
|
|
4074
4162
|
</dl>
|
|
4075
4163
|
</details>
|
|
4076
4164
|
|
|
4077
|
-
<details><summary><code>client.conversationalAi.
|
|
4165
|
+
<details><summary><code>client.conversationalAi.agents.<a href="/src/api/resources/conversationalAi/resources/agents/client/Client.ts">simulateConversation</a>(agentId, { ...params }) -> ElevenLabs.AgentSimulatedChatTestResponseModel</code></summary>
|
|
4078
4166
|
<dl>
|
|
4079
4167
|
<dd>
|
|
4080
4168
|
|
|
@@ -4086,7 +4174,7 @@ await client.conversationalAi.phoneNumbers.get("TeaqRRdTcIfIu2i7BYfT");
|
|
|
4086
4174
|
<dl>
|
|
4087
4175
|
<dd>
|
|
4088
4176
|
|
|
4089
|
-
|
|
4177
|
+
Run a conversation between the agent and a simulated user.
|
|
4090
4178
|
|
|
4091
4179
|
</dd>
|
|
4092
4180
|
</dl>
|
|
@@ -4102,7 +4190,14 @@ Delete Phone Number by ID
|
|
|
4102
4190
|
<dd>
|
|
4103
4191
|
|
|
4104
4192
|
```typescript
|
|
4105
|
-
await client.conversationalAi.
|
|
4193
|
+
await client.conversationalAi.agents.simulateConversation("21m00Tcm4TlvDq8ikWAM", {
|
|
4194
|
+
simulationSpecification: {
|
|
4195
|
+
simulatedUserConfig: {
|
|
4196
|
+
firstMessage: "Hello, how can I help you today?",
|
|
4197
|
+
language: "en",
|
|
4198
|
+
},
|
|
4199
|
+
},
|
|
4200
|
+
});
|
|
4106
4201
|
```
|
|
4107
4202
|
|
|
4108
4203
|
</dd>
|
|
@@ -4118,7 +4213,7 @@ await client.conversationalAi.phoneNumbers.delete("TeaqRRdTcIfIu2i7BYfT");
|
|
|
4118
4213
|
<dl>
|
|
4119
4214
|
<dd>
|
|
4120
4215
|
|
|
4121
|
-
**
|
|
4216
|
+
**agentId:** `string` — The id of an agent. This is returned on agent creation.
|
|
4122
4217
|
|
|
4123
4218
|
</dd>
|
|
4124
4219
|
</dl>
|
|
@@ -4126,7 +4221,15 @@ await client.conversationalAi.phoneNumbers.delete("TeaqRRdTcIfIu2i7BYfT");
|
|
|
4126
4221
|
<dl>
|
|
4127
4222
|
<dd>
|
|
4128
4223
|
|
|
4129
|
-
**
|
|
4224
|
+
**request:** `ElevenLabs.conversationalAi.BodySimulatesAConversationV1ConvaiAgentsAgentIdSimulateConversationPost`
|
|
4225
|
+
|
|
4226
|
+
</dd>
|
|
4227
|
+
</dl>
|
|
4228
|
+
|
|
4229
|
+
<dl>
|
|
4230
|
+
<dd>
|
|
4231
|
+
|
|
4232
|
+
**requestOptions:** `Agents.RequestOptions`
|
|
4130
4233
|
|
|
4131
4234
|
</dd>
|
|
4132
4235
|
</dl>
|
|
@@ -4137,7 +4240,7 @@ await client.conversationalAi.phoneNumbers.delete("TeaqRRdTcIfIu2i7BYfT");
|
|
|
4137
4240
|
</dl>
|
|
4138
4241
|
</details>
|
|
4139
4242
|
|
|
4140
|
-
<details><summary><code>client.conversationalAi.
|
|
4243
|
+
<details><summary><code>client.conversationalAi.agents.<a href="/src/api/resources/conversationalAi/resources/agents/client/Client.ts">simulateConversationStream</a>(agentId, { ...params }) -> void</code></summary>
|
|
4141
4244
|
<dl>
|
|
4142
4245
|
<dd>
|
|
4143
4246
|
|
|
@@ -4149,7 +4252,7 @@ await client.conversationalAi.phoneNumbers.delete("TeaqRRdTcIfIu2i7BYfT");
|
|
|
4149
4252
|
<dl>
|
|
4150
4253
|
<dd>
|
|
4151
4254
|
|
|
4152
|
-
|
|
4255
|
+
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.
|
|
4153
4256
|
|
|
4154
4257
|
</dd>
|
|
4155
4258
|
</dl>
|
|
@@ -4165,12 +4268,19 @@ Update Phone Number details by ID
|
|
|
4165
4268
|
<dd>
|
|
4166
4269
|
|
|
4167
4270
|
```typescript
|
|
4168
|
-
await client.conversationalAi.
|
|
4169
|
-
|
|
4170
|
-
|
|
4171
|
-
|
|
4172
|
-
|
|
4173
|
-
|
|
4271
|
+
await client.conversationalAi.agents.simulateConversationStream("21m00Tcm4TlvDq8ikWAM", {
|
|
4272
|
+
simulationSpecification: {
|
|
4273
|
+
simulatedUserConfig: {
|
|
4274
|
+
firstMessage: "Hello, how can I help you today?",
|
|
4275
|
+
language: "en",
|
|
4276
|
+
},
|
|
4277
|
+
},
|
|
4278
|
+
});
|
|
4279
|
+
```
|
|
4280
|
+
|
|
4281
|
+
</dd>
|
|
4282
|
+
</dl>
|
|
4283
|
+
</dd>
|
|
4174
4284
|
</dl>
|
|
4175
4285
|
|
|
4176
4286
|
#### ⚙️ Parameters
|
|
@@ -4181,7 +4291,7 @@ await client.conversationalAi.phoneNumbers.update("TeaqRRdTcIfIu2i7BYfT");
|
|
|
4181
4291
|
<dl>
|
|
4182
4292
|
<dd>
|
|
4183
4293
|
|
|
4184
|
-
**
|
|
4294
|
+
**agentId:** `string` — The id of an agent. This is returned on agent creation.
|
|
4185
4295
|
|
|
4186
4296
|
</dd>
|
|
4187
4297
|
</dl>
|
|
@@ -4189,7 +4299,78 @@ await client.conversationalAi.phoneNumbers.update("TeaqRRdTcIfIu2i7BYfT");
|
|
|
4189
4299
|
<dl>
|
|
4190
4300
|
<dd>
|
|
4191
4301
|
|
|
4192
|
-
**request:** `ElevenLabs.conversationalAi.
|
|
4302
|
+
**request:** `ElevenLabs.conversationalAi.BodySimulatesAConversationStreamV1ConvaiAgentsAgentIdSimulateConversationStreamPost`
|
|
4303
|
+
|
|
4304
|
+
</dd>
|
|
4305
|
+
</dl>
|
|
4306
|
+
|
|
4307
|
+
<dl>
|
|
4308
|
+
<dd>
|
|
4309
|
+
|
|
4310
|
+
**requestOptions:** `Agents.RequestOptions`
|
|
4311
|
+
|
|
4312
|
+
</dd>
|
|
4313
|
+
</dl>
|
|
4314
|
+
</dd>
|
|
4315
|
+
</dl>
|
|
4316
|
+
|
|
4317
|
+
</dd>
|
|
4318
|
+
</dl>
|
|
4319
|
+
</details>
|
|
4320
|
+
|
|
4321
|
+
## ConversationalAi PhoneNumbers
|
|
4322
|
+
|
|
4323
|
+
<details><summary><code>client.conversationalAi.phoneNumbers.<a href="/src/api/resources/conversationalAi/resources/phoneNumbers/client/Client.ts">create</a>({ ...params }) -> ElevenLabs.CreatePhoneNumberResponseModel</code></summary>
|
|
4324
|
+
<dl>
|
|
4325
|
+
<dd>
|
|
4326
|
+
|
|
4327
|
+
#### 📝 Description
|
|
4328
|
+
|
|
4329
|
+
<dl>
|
|
4330
|
+
<dd>
|
|
4331
|
+
|
|
4332
|
+
<dl>
|
|
4333
|
+
<dd>
|
|
4334
|
+
|
|
4335
|
+
Import Phone Number from provider configuration (Twilio or SIP trunk)
|
|
4336
|
+
|
|
4337
|
+
</dd>
|
|
4338
|
+
</dl>
|
|
4339
|
+
</dd>
|
|
4340
|
+
</dl>
|
|
4341
|
+
|
|
4342
|
+
#### 🔌 Usage
|
|
4343
|
+
|
|
4344
|
+
<dl>
|
|
4345
|
+
<dd>
|
|
4346
|
+
|
|
4347
|
+
<dl>
|
|
4348
|
+
<dd>
|
|
4349
|
+
|
|
4350
|
+
```typescript
|
|
4351
|
+
await client.conversationalAi.phoneNumbers.create({
|
|
4352
|
+
provider: "twilio",
|
|
4353
|
+
phoneNumber: "phone_number",
|
|
4354
|
+
label: "label",
|
|
4355
|
+
sid: "sid",
|
|
4356
|
+
token: "token",
|
|
4357
|
+
});
|
|
4358
|
+
```
|
|
4359
|
+
|
|
4360
|
+
</dd>
|
|
4361
|
+
</dl>
|
|
4362
|
+
</dd>
|
|
4363
|
+
</dl>
|
|
4364
|
+
|
|
4365
|
+
#### ⚙️ Parameters
|
|
4366
|
+
|
|
4367
|
+
<dl>
|
|
4368
|
+
<dd>
|
|
4369
|
+
|
|
4370
|
+
<dl>
|
|
4371
|
+
<dd>
|
|
4372
|
+
|
|
4373
|
+
**request:** `ElevenLabs.PhoneNumbersCreateRequestBody`
|
|
4193
4374
|
|
|
4194
4375
|
</dd>
|
|
4195
4376
|
</dl>
|
|
@@ -4208,7 +4389,7 @@ await client.conversationalAi.phoneNumbers.update("TeaqRRdTcIfIu2i7BYfT");
|
|
|
4208
4389
|
</dl>
|
|
4209
4390
|
</details>
|
|
4210
4391
|
|
|
4211
|
-
<details><summary><code>client.conversationalAi.phoneNumbers.<a href="/src/api/resources/conversationalAi/resources/phoneNumbers/client/Client.ts">
|
|
4392
|
+
<details><summary><code>client.conversationalAi.phoneNumbers.<a href="/src/api/resources/conversationalAi/resources/phoneNumbers/client/Client.ts">get</a>(phoneNumberId) -> ElevenLabs.PhoneNumbersGetResponse</code></summary>
|
|
4212
4393
|
<dl>
|
|
4213
4394
|
<dd>
|
|
4214
4395
|
|
|
@@ -4220,7 +4401,7 @@ await client.conversationalAi.phoneNumbers.update("TeaqRRdTcIfIu2i7BYfT");
|
|
|
4220
4401
|
<dl>
|
|
4221
4402
|
<dd>
|
|
4222
4403
|
|
|
4223
|
-
Retrieve
|
|
4404
|
+
Retrieve Phone Number details by ID
|
|
4224
4405
|
|
|
4225
4406
|
</dd>
|
|
4226
4407
|
</dl>
|
|
@@ -4236,7 +4417,7 @@ Retrieve all Phone Numbers
|
|
|
4236
4417
|
<dd>
|
|
4237
4418
|
|
|
4238
4419
|
```typescript
|
|
4239
|
-
await client.conversationalAi.phoneNumbers.
|
|
4420
|
+
await client.conversationalAi.phoneNumbers.get("TeaqRRdTcIfIu2i7BYfT");
|
|
4240
4421
|
```
|
|
4241
4422
|
|
|
4242
4423
|
</dd>
|
|
@@ -4252,6 +4433,14 @@ await client.conversationalAi.phoneNumbers.list();
|
|
|
4252
4433
|
<dl>
|
|
4253
4434
|
<dd>
|
|
4254
4435
|
|
|
4436
|
+
**phoneNumberId:** `string` — The id of an agent. This is returned on agent creation.
|
|
4437
|
+
|
|
4438
|
+
</dd>
|
|
4439
|
+
</dl>
|
|
4440
|
+
|
|
4441
|
+
<dl>
|
|
4442
|
+
<dd>
|
|
4443
|
+
|
|
4255
4444
|
**requestOptions:** `PhoneNumbers.RequestOptions`
|
|
4256
4445
|
|
|
4257
4446
|
</dd>
|
|
@@ -4263,9 +4452,70 @@ await client.conversationalAi.phoneNumbers.list();
|
|
|
4263
4452
|
</dl>
|
|
4264
4453
|
</details>
|
|
4265
4454
|
|
|
4266
|
-
|
|
4455
|
+
<details><summary><code>client.conversationalAi.phoneNumbers.<a href="/src/api/resources/conversationalAi/resources/phoneNumbers/client/Client.ts">delete</a>(phoneNumberId) -> unknown</code></summary>
|
|
4456
|
+
<dl>
|
|
4457
|
+
<dd>
|
|
4267
4458
|
|
|
4268
|
-
|
|
4459
|
+
#### 📝 Description
|
|
4460
|
+
|
|
4461
|
+
<dl>
|
|
4462
|
+
<dd>
|
|
4463
|
+
|
|
4464
|
+
<dl>
|
|
4465
|
+
<dd>
|
|
4466
|
+
|
|
4467
|
+
Delete Phone Number by ID
|
|
4468
|
+
|
|
4469
|
+
</dd>
|
|
4470
|
+
</dl>
|
|
4471
|
+
</dd>
|
|
4472
|
+
</dl>
|
|
4473
|
+
|
|
4474
|
+
#### 🔌 Usage
|
|
4475
|
+
|
|
4476
|
+
<dl>
|
|
4477
|
+
<dd>
|
|
4478
|
+
|
|
4479
|
+
<dl>
|
|
4480
|
+
<dd>
|
|
4481
|
+
|
|
4482
|
+
```typescript
|
|
4483
|
+
await client.conversationalAi.phoneNumbers.delete("TeaqRRdTcIfIu2i7BYfT");
|
|
4484
|
+
```
|
|
4485
|
+
|
|
4486
|
+
</dd>
|
|
4487
|
+
</dl>
|
|
4488
|
+
</dd>
|
|
4489
|
+
</dl>
|
|
4490
|
+
|
|
4491
|
+
#### ⚙️ Parameters
|
|
4492
|
+
|
|
4493
|
+
<dl>
|
|
4494
|
+
<dd>
|
|
4495
|
+
|
|
4496
|
+
<dl>
|
|
4497
|
+
<dd>
|
|
4498
|
+
|
|
4499
|
+
**phoneNumberId:** `string` — The id of an agent. This is returned on agent creation.
|
|
4500
|
+
|
|
4501
|
+
</dd>
|
|
4502
|
+
</dl>
|
|
4503
|
+
|
|
4504
|
+
<dl>
|
|
4505
|
+
<dd>
|
|
4506
|
+
|
|
4507
|
+
**requestOptions:** `PhoneNumbers.RequestOptions`
|
|
4508
|
+
|
|
4509
|
+
</dd>
|
|
4510
|
+
</dl>
|
|
4511
|
+
</dd>
|
|
4512
|
+
</dl>
|
|
4513
|
+
|
|
4514
|
+
</dd>
|
|
4515
|
+
</dl>
|
|
4516
|
+
</details>
|
|
4517
|
+
|
|
4518
|
+
<details><summary><code>client.conversationalAi.phoneNumbers.<a href="/src/api/resources/conversationalAi/resources/phoneNumbers/client/Client.ts">update</a>(phoneNumberId, { ...params }) -> ElevenLabs.PhoneNumbersUpdateResponse</code></summary>
|
|
4269
4519
|
<dl>
|
|
4270
4520
|
<dd>
|
|
4271
4521
|
|
|
@@ -4277,7 +4527,7 @@ await client.conversationalAi.phoneNumbers.list();
|
|
|
4277
4527
|
<dl>
|
|
4278
4528
|
<dd>
|
|
4279
4529
|
|
|
4280
|
-
|
|
4530
|
+
Update Phone Number details by ID
|
|
4281
4531
|
|
|
4282
4532
|
</dd>
|
|
4283
4533
|
</dl>
|
|
@@ -4293,11 +4543,7 @@ Returns a list of LLM models and the expected cost for using them based on the p
|
|
|
4293
4543
|
<dd>
|
|
4294
4544
|
|
|
4295
4545
|
```typescript
|
|
4296
|
-
await client.conversationalAi.
|
|
4297
|
-
promptLength: 1,
|
|
4298
|
-
numberOfPages: 1,
|
|
4299
|
-
ragEnabled: true,
|
|
4300
|
-
});
|
|
4546
|
+
await client.conversationalAi.phoneNumbers.update("TeaqRRdTcIfIu2i7BYfT");
|
|
4301
4547
|
```
|
|
4302
4548
|
|
|
4303
4549
|
</dd>
|
|
@@ -4313,7 +4559,7 @@ await client.conversationalAi.llmUsage.calculate({
|
|
|
4313
4559
|
<dl>
|
|
4314
4560
|
<dd>
|
|
4315
4561
|
|
|
4316
|
-
**
|
|
4562
|
+
**phoneNumberId:** `string` — The id of an agent. This is returned on agent creation.
|
|
4317
4563
|
|
|
4318
4564
|
</dd>
|
|
4319
4565
|
</dl>
|
|
@@ -4321,7 +4567,15 @@ await client.conversationalAi.llmUsage.calculate({
|
|
|
4321
4567
|
<dl>
|
|
4322
4568
|
<dd>
|
|
4323
4569
|
|
|
4324
|
-
**
|
|
4570
|
+
**request:** `ElevenLabs.conversationalAi.UpdatePhoneNumberRequest`
|
|
4571
|
+
|
|
4572
|
+
</dd>
|
|
4573
|
+
</dl>
|
|
4574
|
+
|
|
4575
|
+
<dl>
|
|
4576
|
+
<dd>
|
|
4577
|
+
|
|
4578
|
+
**requestOptions:** `PhoneNumbers.RequestOptions`
|
|
4325
4579
|
|
|
4326
4580
|
</dd>
|
|
4327
4581
|
</dl>
|
|
@@ -4332,9 +4586,64 @@ await client.conversationalAi.llmUsage.calculate({
|
|
|
4332
4586
|
</dl>
|
|
4333
4587
|
</details>
|
|
4334
4588
|
|
|
4335
|
-
|
|
4589
|
+
<details><summary><code>client.conversationalAi.phoneNumbers.<a href="/src/api/resources/conversationalAi/resources/phoneNumbers/client/Client.ts">list</a>() -> ElevenLabs.PhoneNumbersListResponseItem[]</code></summary>
|
|
4590
|
+
<dl>
|
|
4591
|
+
<dd>
|
|
4336
4592
|
|
|
4337
|
-
|
|
4593
|
+
#### 📝 Description
|
|
4594
|
+
|
|
4595
|
+
<dl>
|
|
4596
|
+
<dd>
|
|
4597
|
+
|
|
4598
|
+
<dl>
|
|
4599
|
+
<dd>
|
|
4600
|
+
|
|
4601
|
+
Retrieve all Phone Numbers
|
|
4602
|
+
|
|
4603
|
+
</dd>
|
|
4604
|
+
</dl>
|
|
4605
|
+
</dd>
|
|
4606
|
+
</dl>
|
|
4607
|
+
|
|
4608
|
+
#### 🔌 Usage
|
|
4609
|
+
|
|
4610
|
+
<dl>
|
|
4611
|
+
<dd>
|
|
4612
|
+
|
|
4613
|
+
<dl>
|
|
4614
|
+
<dd>
|
|
4615
|
+
|
|
4616
|
+
```typescript
|
|
4617
|
+
await client.conversationalAi.phoneNumbers.list();
|
|
4618
|
+
```
|
|
4619
|
+
|
|
4620
|
+
</dd>
|
|
4621
|
+
</dl>
|
|
4622
|
+
</dd>
|
|
4623
|
+
</dl>
|
|
4624
|
+
|
|
4625
|
+
#### ⚙️ Parameters
|
|
4626
|
+
|
|
4627
|
+
<dl>
|
|
4628
|
+
<dd>
|
|
4629
|
+
|
|
4630
|
+
<dl>
|
|
4631
|
+
<dd>
|
|
4632
|
+
|
|
4633
|
+
**requestOptions:** `PhoneNumbers.RequestOptions`
|
|
4634
|
+
|
|
4635
|
+
</dd>
|
|
4636
|
+
</dl>
|
|
4637
|
+
</dd>
|
|
4638
|
+
</dl>
|
|
4639
|
+
|
|
4640
|
+
</dd>
|
|
4641
|
+
</dl>
|
|
4642
|
+
</details>
|
|
4643
|
+
|
|
4644
|
+
## ConversationalAi LlmUsage
|
|
4645
|
+
|
|
4646
|
+
<details><summary><code>client.conversationalAi.llmUsage.<a href="/src/api/resources/conversationalAi/resources/llmUsage/client/Client.ts">calculate</a>({ ...params }) -> ElevenLabs.LlmUsageCalculatorResponseModel</code></summary>
|
|
4338
4647
|
<dl>
|
|
4339
4648
|
<dd>
|
|
4340
4649
|
|
|
@@ -4346,7 +4655,7 @@ await client.conversationalAi.llmUsage.calculate({
|
|
|
4346
4655
|
<dl>
|
|
4347
4656
|
<dd>
|
|
4348
4657
|
|
|
4349
|
-
|
|
4658
|
+
Returns a list of LLM models and the expected cost for using them based on the provided values.
|
|
4350
4659
|
|
|
4351
4660
|
</dd>
|
|
4352
4661
|
</dl>
|
|
@@ -4362,7 +4671,11 @@ Get a list of available knowledge base documents
|
|
|
4362
4671
|
<dd>
|
|
4363
4672
|
|
|
4364
4673
|
```typescript
|
|
4365
|
-
await client.conversationalAi.
|
|
4674
|
+
await client.conversationalAi.llmUsage.calculate({
|
|
4675
|
+
promptLength: 1,
|
|
4676
|
+
numberOfPages: 1,
|
|
4677
|
+
ragEnabled: true,
|
|
4678
|
+
});
|
|
4366
4679
|
```
|
|
4367
4680
|
|
|
4368
4681
|
</dd>
|
|
@@ -4378,7 +4691,72 @@ await client.conversationalAi.knowledgeBase.list();
|
|
|
4378
4691
|
<dl>
|
|
4379
4692
|
<dd>
|
|
4380
4693
|
|
|
4381
|
-
**request:** `ElevenLabs.conversationalAi.
|
|
4694
|
+
**request:** `ElevenLabs.conversationalAi.LlmUsageCalculatorPublicRequestModel`
|
|
4695
|
+
|
|
4696
|
+
</dd>
|
|
4697
|
+
</dl>
|
|
4698
|
+
|
|
4699
|
+
<dl>
|
|
4700
|
+
<dd>
|
|
4701
|
+
|
|
4702
|
+
**requestOptions:** `LlmUsage.RequestOptions`
|
|
4703
|
+
|
|
4704
|
+
</dd>
|
|
4705
|
+
</dl>
|
|
4706
|
+
</dd>
|
|
4707
|
+
</dl>
|
|
4708
|
+
|
|
4709
|
+
</dd>
|
|
4710
|
+
</dl>
|
|
4711
|
+
</details>
|
|
4712
|
+
|
|
4713
|
+
## ConversationalAi KnowledgeBase
|
|
4714
|
+
|
|
4715
|
+
<details><summary><code>client.conversationalAi.knowledgeBase.<a href="/src/api/resources/conversationalAi/resources/knowledgeBase/client/Client.ts">list</a>({ ...params }) -> ElevenLabs.GetKnowledgeBaseListResponseModel</code></summary>
|
|
4716
|
+
<dl>
|
|
4717
|
+
<dd>
|
|
4718
|
+
|
|
4719
|
+
#### 📝 Description
|
|
4720
|
+
|
|
4721
|
+
<dl>
|
|
4722
|
+
<dd>
|
|
4723
|
+
|
|
4724
|
+
<dl>
|
|
4725
|
+
<dd>
|
|
4726
|
+
|
|
4727
|
+
Get a list of available knowledge base documents
|
|
4728
|
+
|
|
4729
|
+
</dd>
|
|
4730
|
+
</dl>
|
|
4731
|
+
</dd>
|
|
4732
|
+
</dl>
|
|
4733
|
+
|
|
4734
|
+
#### 🔌 Usage
|
|
4735
|
+
|
|
4736
|
+
<dl>
|
|
4737
|
+
<dd>
|
|
4738
|
+
|
|
4739
|
+
<dl>
|
|
4740
|
+
<dd>
|
|
4741
|
+
|
|
4742
|
+
```typescript
|
|
4743
|
+
await client.conversationalAi.knowledgeBase.list();
|
|
4744
|
+
```
|
|
4745
|
+
|
|
4746
|
+
</dd>
|
|
4747
|
+
</dl>
|
|
4748
|
+
</dd>
|
|
4749
|
+
</dl>
|
|
4750
|
+
|
|
4751
|
+
#### ⚙️ Parameters
|
|
4752
|
+
|
|
4753
|
+
<dl>
|
|
4754
|
+
<dd>
|
|
4755
|
+
|
|
4756
|
+
<dl>
|
|
4757
|
+
<dd>
|
|
4758
|
+
|
|
4759
|
+
**request:** `ElevenLabs.conversationalAi.KnowledgeBaseListRequest`
|
|
4382
4760
|
|
|
4383
4761
|
</dd>
|
|
4384
4762
|
</dl>
|
|
@@ -4397,6 +4775,408 @@ await client.conversationalAi.knowledgeBase.list();
|
|
|
4397
4775
|
</dl>
|
|
4398
4776
|
</details>
|
|
4399
4777
|
|
|
4778
|
+
## ConversationalAi Tools
|
|
4779
|
+
|
|
4780
|
+
<details><summary><code>client.conversationalAi.tools.<a href="/src/api/resources/conversationalAi/resources/tools/client/Client.ts">list</a>() -> ElevenLabs.ToolsResponseModel</code></summary>
|
|
4781
|
+
<dl>
|
|
4782
|
+
<dd>
|
|
4783
|
+
|
|
4784
|
+
#### 📝 Description
|
|
4785
|
+
|
|
4786
|
+
<dl>
|
|
4787
|
+
<dd>
|
|
4788
|
+
|
|
4789
|
+
<dl>
|
|
4790
|
+
<dd>
|
|
4791
|
+
|
|
4792
|
+
Get all available tools available in the workspace.
|
|
4793
|
+
|
|
4794
|
+
</dd>
|
|
4795
|
+
</dl>
|
|
4796
|
+
</dd>
|
|
4797
|
+
</dl>
|
|
4798
|
+
|
|
4799
|
+
#### 🔌 Usage
|
|
4800
|
+
|
|
4801
|
+
<dl>
|
|
4802
|
+
<dd>
|
|
4803
|
+
|
|
4804
|
+
<dl>
|
|
4805
|
+
<dd>
|
|
4806
|
+
|
|
4807
|
+
```typescript
|
|
4808
|
+
await client.conversationalAi.tools.list();
|
|
4809
|
+
```
|
|
4810
|
+
|
|
4811
|
+
</dd>
|
|
4812
|
+
</dl>
|
|
4813
|
+
</dd>
|
|
4814
|
+
</dl>
|
|
4815
|
+
|
|
4816
|
+
#### ⚙️ Parameters
|
|
4817
|
+
|
|
4818
|
+
<dl>
|
|
4819
|
+
<dd>
|
|
4820
|
+
|
|
4821
|
+
<dl>
|
|
4822
|
+
<dd>
|
|
4823
|
+
|
|
4824
|
+
**requestOptions:** `Tools.RequestOptions`
|
|
4825
|
+
|
|
4826
|
+
</dd>
|
|
4827
|
+
</dl>
|
|
4828
|
+
</dd>
|
|
4829
|
+
</dl>
|
|
4830
|
+
|
|
4831
|
+
</dd>
|
|
4832
|
+
</dl>
|
|
4833
|
+
</details>
|
|
4834
|
+
|
|
4835
|
+
<details><summary><code>client.conversationalAi.tools.<a href="/src/api/resources/conversationalAi/resources/tools/client/Client.ts">create</a>({ ...params }) -> ElevenLabs.ToolResponseModel</code></summary>
|
|
4836
|
+
<dl>
|
|
4837
|
+
<dd>
|
|
4838
|
+
|
|
4839
|
+
#### 📝 Description
|
|
4840
|
+
|
|
4841
|
+
<dl>
|
|
4842
|
+
<dd>
|
|
4843
|
+
|
|
4844
|
+
<dl>
|
|
4845
|
+
<dd>
|
|
4846
|
+
|
|
4847
|
+
Add a new tool to the available tools in the workspace.
|
|
4848
|
+
|
|
4849
|
+
</dd>
|
|
4850
|
+
</dl>
|
|
4851
|
+
</dd>
|
|
4852
|
+
</dl>
|
|
4853
|
+
|
|
4854
|
+
#### 🔌 Usage
|
|
4855
|
+
|
|
4856
|
+
<dl>
|
|
4857
|
+
<dd>
|
|
4858
|
+
|
|
4859
|
+
<dl>
|
|
4860
|
+
<dd>
|
|
4861
|
+
|
|
4862
|
+
```typescript
|
|
4863
|
+
await client.conversationalAi.tools.create({
|
|
4864
|
+
toolConfig: {
|
|
4865
|
+
type: "client",
|
|
4866
|
+
name: "name",
|
|
4867
|
+
description: "description",
|
|
4868
|
+
expectsResponse: false,
|
|
4869
|
+
},
|
|
4870
|
+
});
|
|
4871
|
+
```
|
|
4872
|
+
|
|
4873
|
+
</dd>
|
|
4874
|
+
</dl>
|
|
4875
|
+
</dd>
|
|
4876
|
+
</dl>
|
|
4877
|
+
|
|
4878
|
+
#### ⚙️ Parameters
|
|
4879
|
+
|
|
4880
|
+
<dl>
|
|
4881
|
+
<dd>
|
|
4882
|
+
|
|
4883
|
+
<dl>
|
|
4884
|
+
<dd>
|
|
4885
|
+
|
|
4886
|
+
**request:** `ElevenLabs.ToolRequestModel`
|
|
4887
|
+
|
|
4888
|
+
</dd>
|
|
4889
|
+
</dl>
|
|
4890
|
+
|
|
4891
|
+
<dl>
|
|
4892
|
+
<dd>
|
|
4893
|
+
|
|
4894
|
+
**requestOptions:** `Tools.RequestOptions`
|
|
4895
|
+
|
|
4896
|
+
</dd>
|
|
4897
|
+
</dl>
|
|
4898
|
+
</dd>
|
|
4899
|
+
</dl>
|
|
4900
|
+
|
|
4901
|
+
</dd>
|
|
4902
|
+
</dl>
|
|
4903
|
+
</details>
|
|
4904
|
+
|
|
4905
|
+
<details><summary><code>client.conversationalAi.tools.<a href="/src/api/resources/conversationalAi/resources/tools/client/Client.ts">get</a>(toolId) -> ElevenLabs.ToolResponseModel</code></summary>
|
|
4906
|
+
<dl>
|
|
4907
|
+
<dd>
|
|
4908
|
+
|
|
4909
|
+
#### 📝 Description
|
|
4910
|
+
|
|
4911
|
+
<dl>
|
|
4912
|
+
<dd>
|
|
4913
|
+
|
|
4914
|
+
<dl>
|
|
4915
|
+
<dd>
|
|
4916
|
+
|
|
4917
|
+
Get tool that is available in the workspace.
|
|
4918
|
+
|
|
4919
|
+
</dd>
|
|
4920
|
+
</dl>
|
|
4921
|
+
</dd>
|
|
4922
|
+
</dl>
|
|
4923
|
+
|
|
4924
|
+
#### 🔌 Usage
|
|
4925
|
+
|
|
4926
|
+
<dl>
|
|
4927
|
+
<dd>
|
|
4928
|
+
|
|
4929
|
+
<dl>
|
|
4930
|
+
<dd>
|
|
4931
|
+
|
|
4932
|
+
```typescript
|
|
4933
|
+
await client.conversationalAi.tools.get("tool_id");
|
|
4934
|
+
```
|
|
4935
|
+
|
|
4936
|
+
</dd>
|
|
4937
|
+
</dl>
|
|
4938
|
+
</dd>
|
|
4939
|
+
</dl>
|
|
4940
|
+
|
|
4941
|
+
#### ⚙️ Parameters
|
|
4942
|
+
|
|
4943
|
+
<dl>
|
|
4944
|
+
<dd>
|
|
4945
|
+
|
|
4946
|
+
<dl>
|
|
4947
|
+
<dd>
|
|
4948
|
+
|
|
4949
|
+
**toolId:** `string` — ID of the requested tool.
|
|
4950
|
+
|
|
4951
|
+
</dd>
|
|
4952
|
+
</dl>
|
|
4953
|
+
|
|
4954
|
+
<dl>
|
|
4955
|
+
<dd>
|
|
4956
|
+
|
|
4957
|
+
**requestOptions:** `Tools.RequestOptions`
|
|
4958
|
+
|
|
4959
|
+
</dd>
|
|
4960
|
+
</dl>
|
|
4961
|
+
</dd>
|
|
4962
|
+
</dl>
|
|
4963
|
+
|
|
4964
|
+
</dd>
|
|
4965
|
+
</dl>
|
|
4966
|
+
</details>
|
|
4967
|
+
|
|
4968
|
+
<details><summary><code>client.conversationalAi.tools.<a href="/src/api/resources/conversationalAi/resources/tools/client/Client.ts">delete</a>(toolId) -> unknown</code></summary>
|
|
4969
|
+
<dl>
|
|
4970
|
+
<dd>
|
|
4971
|
+
|
|
4972
|
+
#### 📝 Description
|
|
4973
|
+
|
|
4974
|
+
<dl>
|
|
4975
|
+
<dd>
|
|
4976
|
+
|
|
4977
|
+
<dl>
|
|
4978
|
+
<dd>
|
|
4979
|
+
|
|
4980
|
+
Delete tool from the workspace.
|
|
4981
|
+
|
|
4982
|
+
</dd>
|
|
4983
|
+
</dl>
|
|
4984
|
+
</dd>
|
|
4985
|
+
</dl>
|
|
4986
|
+
|
|
4987
|
+
#### 🔌 Usage
|
|
4988
|
+
|
|
4989
|
+
<dl>
|
|
4990
|
+
<dd>
|
|
4991
|
+
|
|
4992
|
+
<dl>
|
|
4993
|
+
<dd>
|
|
4994
|
+
|
|
4995
|
+
```typescript
|
|
4996
|
+
await client.conversationalAi.tools.delete("tool_id");
|
|
4997
|
+
```
|
|
4998
|
+
|
|
4999
|
+
</dd>
|
|
5000
|
+
</dl>
|
|
5001
|
+
</dd>
|
|
5002
|
+
</dl>
|
|
5003
|
+
|
|
5004
|
+
#### ⚙️ Parameters
|
|
5005
|
+
|
|
5006
|
+
<dl>
|
|
5007
|
+
<dd>
|
|
5008
|
+
|
|
5009
|
+
<dl>
|
|
5010
|
+
<dd>
|
|
5011
|
+
|
|
5012
|
+
**toolId:** `string` — ID of the requested tool.
|
|
5013
|
+
|
|
5014
|
+
</dd>
|
|
5015
|
+
</dl>
|
|
5016
|
+
|
|
5017
|
+
<dl>
|
|
5018
|
+
<dd>
|
|
5019
|
+
|
|
5020
|
+
**requestOptions:** `Tools.RequestOptions`
|
|
5021
|
+
|
|
5022
|
+
</dd>
|
|
5023
|
+
</dl>
|
|
5024
|
+
</dd>
|
|
5025
|
+
</dl>
|
|
5026
|
+
|
|
5027
|
+
</dd>
|
|
5028
|
+
</dl>
|
|
5029
|
+
</details>
|
|
5030
|
+
|
|
5031
|
+
<details><summary><code>client.conversationalAi.tools.<a href="/src/api/resources/conversationalAi/resources/tools/client/Client.ts">update</a>(toolId, { ...params }) -> ElevenLabs.ToolResponseModel</code></summary>
|
|
5032
|
+
<dl>
|
|
5033
|
+
<dd>
|
|
5034
|
+
|
|
5035
|
+
#### 📝 Description
|
|
5036
|
+
|
|
5037
|
+
<dl>
|
|
5038
|
+
<dd>
|
|
5039
|
+
|
|
5040
|
+
<dl>
|
|
5041
|
+
<dd>
|
|
5042
|
+
|
|
5043
|
+
Update tool that is available in the workspace.
|
|
5044
|
+
|
|
5045
|
+
</dd>
|
|
5046
|
+
</dl>
|
|
5047
|
+
</dd>
|
|
5048
|
+
</dl>
|
|
5049
|
+
|
|
5050
|
+
#### 🔌 Usage
|
|
5051
|
+
|
|
5052
|
+
<dl>
|
|
5053
|
+
<dd>
|
|
5054
|
+
|
|
5055
|
+
<dl>
|
|
5056
|
+
<dd>
|
|
5057
|
+
|
|
5058
|
+
```typescript
|
|
5059
|
+
await client.conversationalAi.tools.update("tool_id", {
|
|
5060
|
+
toolConfig: {
|
|
5061
|
+
type: "client",
|
|
5062
|
+
name: "name",
|
|
5063
|
+
description: "description",
|
|
5064
|
+
expectsResponse: false,
|
|
5065
|
+
},
|
|
5066
|
+
});
|
|
5067
|
+
```
|
|
5068
|
+
|
|
5069
|
+
</dd>
|
|
5070
|
+
</dl>
|
|
5071
|
+
</dd>
|
|
5072
|
+
</dl>
|
|
5073
|
+
|
|
5074
|
+
#### ⚙️ Parameters
|
|
5075
|
+
|
|
5076
|
+
<dl>
|
|
5077
|
+
<dd>
|
|
5078
|
+
|
|
5079
|
+
<dl>
|
|
5080
|
+
<dd>
|
|
5081
|
+
|
|
5082
|
+
**toolId:** `string` — ID of the requested tool.
|
|
5083
|
+
|
|
5084
|
+
</dd>
|
|
5085
|
+
</dl>
|
|
5086
|
+
|
|
5087
|
+
<dl>
|
|
5088
|
+
<dd>
|
|
5089
|
+
|
|
5090
|
+
**request:** `ElevenLabs.ToolRequestModel`
|
|
5091
|
+
|
|
5092
|
+
</dd>
|
|
5093
|
+
</dl>
|
|
5094
|
+
|
|
5095
|
+
<dl>
|
|
5096
|
+
<dd>
|
|
5097
|
+
|
|
5098
|
+
**requestOptions:** `Tools.RequestOptions`
|
|
5099
|
+
|
|
5100
|
+
</dd>
|
|
5101
|
+
</dl>
|
|
5102
|
+
</dd>
|
|
5103
|
+
</dl>
|
|
5104
|
+
|
|
5105
|
+
</dd>
|
|
5106
|
+
</dl>
|
|
5107
|
+
</details>
|
|
5108
|
+
|
|
5109
|
+
<details><summary><code>client.conversationalAi.tools.<a href="/src/api/resources/conversationalAi/resources/tools/client/Client.ts">getDependentAgents</a>(toolId, { ...params }) -> ElevenLabs.GetToolDependentAgentsResponseModel</code></summary>
|
|
5110
|
+
<dl>
|
|
5111
|
+
<dd>
|
|
5112
|
+
|
|
5113
|
+
#### 📝 Description
|
|
5114
|
+
|
|
5115
|
+
<dl>
|
|
5116
|
+
<dd>
|
|
5117
|
+
|
|
5118
|
+
<dl>
|
|
5119
|
+
<dd>
|
|
5120
|
+
|
|
5121
|
+
Get a list of agents depending on this tool
|
|
5122
|
+
|
|
5123
|
+
</dd>
|
|
5124
|
+
</dl>
|
|
5125
|
+
</dd>
|
|
5126
|
+
</dl>
|
|
5127
|
+
|
|
5128
|
+
#### 🔌 Usage
|
|
5129
|
+
|
|
5130
|
+
<dl>
|
|
5131
|
+
<dd>
|
|
5132
|
+
|
|
5133
|
+
<dl>
|
|
5134
|
+
<dd>
|
|
5135
|
+
|
|
5136
|
+
```typescript
|
|
5137
|
+
await client.conversationalAi.tools.getDependentAgents("tool_id");
|
|
5138
|
+
```
|
|
5139
|
+
|
|
5140
|
+
</dd>
|
|
5141
|
+
</dl>
|
|
5142
|
+
</dd>
|
|
5143
|
+
</dl>
|
|
5144
|
+
|
|
5145
|
+
#### ⚙️ Parameters
|
|
5146
|
+
|
|
5147
|
+
<dl>
|
|
5148
|
+
<dd>
|
|
5149
|
+
|
|
5150
|
+
<dl>
|
|
5151
|
+
<dd>
|
|
5152
|
+
|
|
5153
|
+
**toolId:** `string` — ID of the requested tool.
|
|
5154
|
+
|
|
5155
|
+
</dd>
|
|
5156
|
+
</dl>
|
|
5157
|
+
|
|
5158
|
+
<dl>
|
|
5159
|
+
<dd>
|
|
5160
|
+
|
|
5161
|
+
**request:** `ElevenLabs.conversationalAi.ToolsGetDependentAgentsRequest`
|
|
5162
|
+
|
|
5163
|
+
</dd>
|
|
5164
|
+
</dl>
|
|
5165
|
+
|
|
5166
|
+
<dl>
|
|
5167
|
+
<dd>
|
|
5168
|
+
|
|
5169
|
+
**requestOptions:** `Tools.RequestOptions`
|
|
5170
|
+
|
|
5171
|
+
</dd>
|
|
5172
|
+
</dl>
|
|
5173
|
+
</dd>
|
|
5174
|
+
</dl>
|
|
5175
|
+
|
|
5176
|
+
</dd>
|
|
5177
|
+
</dl>
|
|
5178
|
+
</details>
|
|
5179
|
+
|
|
4400
5180
|
## ConversationalAi Settings
|
|
4401
5181
|
|
|
4402
5182
|
<details><summary><code>client.conversationalAi.settings.<a href="/src/api/resources/conversationalAi/resources/settings/client/Client.ts">get</a>() -> ElevenLabs.GetConvAiSettingsResponseModel</code></summary>
|