@elevenlabs/elevenlabs-js 2.1.0 → 2.2.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/.mock/asyncapi.yml +5 -5
- package/.mock/definition/__package__.yml +600 -102
- package/.mock/definition/conversationalAi/agents/widget.yml +30 -0
- package/.mock/definition/conversationalAi/agents.yml +47 -27
- package/.mock/definition/conversationalAi/batchCalls.yml +83 -0
- package/.mock/definition/conversationalAi/knowledgeBase/document.yml +5 -1
- package/.mock/definition/conversationalAi/knowledgeBase/documents.yml +14 -5
- package/.mock/definition/conversationalAi/knowledgeBase.yml +2 -1
- package/.mock/definition/conversationalAi.yml +99 -1
- package/.mock/definition/history.yml +8 -0
- package/.mock/definition/pronunciationDictionaries.yml +2 -2
- package/.mock/definition/speechToText.yml +14 -2
- package/.mock/definition/textToDialogue.yml +213 -0
- package/.mock/definition/textToVoice.yml +1 -1
- package/.mock/definition/voices/settings.yml +3 -3
- package/.mock/definition/voices.yml +6 -3
- package/.mock/definition/workspace/groups/members.yml +0 -2
- package/.mock/definition/workspace/groups.yml +0 -1
- package/.mock/fern.config.json +1 -1
- package/.mock/openapi.json +2724 -293
- package/Client.d.ts +3 -0
- package/Client.js +33 -28
- package/api/resources/audioIsolation/client/Client.js +2 -2
- package/api/resources/audioNative/client/Client.js +3 -3
- package/api/resources/conversationalAi/client/Client.d.ts +39 -0
- package/api/resources/conversationalAi/client/Client.js +224 -2
- package/api/resources/conversationalAi/resources/agents/client/Client.js +7 -7
- package/api/resources/conversationalAi/resources/agents/client/requests/UpdateAgentRequest.d.ts +5 -2
- package/api/resources/conversationalAi/resources/agents/resources/knowledgeBase/client/Client.js +1 -1
- package/api/resources/conversationalAi/resources/agents/resources/link/client/Client.js +1 -1
- package/api/resources/conversationalAi/resources/agents/resources/llmUsage/client/Client.js +1 -1
- package/api/resources/conversationalAi/resources/agents/resources/widget/client/Client.js +1 -1
- package/api/resources/conversationalAi/resources/agents/resources/widget/resources/avatar/client/Client.js +1 -1
- package/api/resources/conversationalAi/resources/batchCalls/client/Client.d.ts +26 -0
- package/api/resources/conversationalAi/resources/batchCalls/client/Client.js +151 -3
- package/api/resources/conversationalAi/resources/conversations/client/Client.js +4 -4
- package/api/resources/conversationalAi/resources/conversations/resources/audio/client/Client.js +1 -1
- package/api/resources/conversationalAi/resources/conversations/resources/feedback/client/Client.js +1 -1
- package/api/resources/conversationalAi/resources/dashboard/resources/settings/client/Client.js +2 -2
- package/api/resources/conversationalAi/resources/knowledgeBase/client/Client.js +1 -1
- package/api/resources/conversationalAi/resources/knowledgeBase/resources/document/client/Client.d.ts +1 -1
- package/api/resources/conversationalAi/resources/knowledgeBase/resources/document/client/Client.js +2 -2
- package/api/resources/conversationalAi/resources/knowledgeBase/resources/documents/client/Client.d.ts +2 -1
- package/api/resources/conversationalAi/resources/knowledgeBase/resources/documents/client/Client.js +19 -12
- package/api/resources/conversationalAi/resources/knowledgeBase/resources/documents/client/requests/DocumentsDeleteRequest.d.ts +13 -0
- package/api/resources/conversationalAi/resources/knowledgeBase/resources/documents/client/requests/index.d.ts +1 -0
- package/api/resources/conversationalAi/resources/knowledgeBase/resources/documents/resources/chunk/client/Client.js +1 -1
- package/api/resources/conversationalAi/resources/llmUsage/client/Client.js +1 -1
- package/api/resources/conversationalAi/resources/phoneNumbers/client/Client.js +5 -5
- package/api/resources/conversationalAi/resources/secrets/client/Client.js +3 -3
- package/api/resources/conversationalAi/resources/settings/client/Client.js +2 -2
- package/api/resources/conversationalAi/resources/sipTrunk/client/Client.js +1 -1
- package/api/resources/conversationalAi/resources/twilio/client/Client.js +1 -1
- package/api/resources/dubbing/client/Client.js +3 -3
- package/api/resources/dubbing/resources/audio/client/Client.js +1 -1
- package/api/resources/dubbing/resources/resource/client/Client.js +5 -5
- package/api/resources/dubbing/resources/resource/resources/language/client/Client.js +1 -1
- package/api/resources/dubbing/resources/resource/resources/segment/client/Client.js +2 -2
- package/api/resources/dubbing/resources/resource/resources/speaker/client/Client.js +2 -2
- package/api/resources/dubbing/resources/resource/resources/speaker/resources/segment/client/Client.js +1 -1
- package/api/resources/dubbing/resources/transcript/client/Client.js +1 -1
- package/api/resources/forcedAlignment/client/Client.js +1 -1
- package/api/resources/history/client/Client.js +5 -5
- package/api/resources/index.d.ts +3 -0
- package/api/resources/index.js +4 -1
- package/api/resources/models/client/Client.js +1 -1
- package/api/resources/pronunciationDictionaries/client/Client.js +5 -5
- package/api/resources/pronunciationDictionaries/resources/rules/client/Client.js +2 -2
- package/api/resources/samples/client/Client.js +1 -1
- package/api/resources/speechToSpeech/client/Client.js +2 -2
- package/api/resources/speechToText/client/requests/BodySpeechToTextV1SpeechToTextPost.d.ts +2 -0
- package/api/resources/studio/client/Client.js +1 -1
- package/api/resources/studio/resources/projects/client/Client.js +6 -6
- package/api/resources/studio/resources/projects/resources/chapters/client/Client.js +6 -6
- package/api/resources/studio/resources/projects/resources/chapters/resources/snapshots/client/Client.js +3 -3
- package/api/resources/studio/resources/projects/resources/content/client/Client.js +1 -1
- package/api/resources/studio/resources/projects/resources/pronunciationDictionaries/client/Client.js +1 -1
- package/api/resources/studio/resources/projects/resources/snapshots/client/Client.js +4 -4
- package/api/resources/textToDialogue/client/Client.d.ts +44 -0
- package/api/resources/textToDialogue/client/Client.js +212 -0
- package/api/resources/textToDialogue/client/index.d.ts +1 -0
- package/api/resources/textToDialogue/client/index.js +17 -0
- package/api/resources/textToDialogue/client/requests/BodyTextToDialogueMultiVoiceStreamingV1TextToDialogueStreamPost.d.ts +32 -0
- package/api/resources/textToDialogue/client/requests/BodyTextToDialogueMultiVoiceV1TextToDialoguePost.d.ts +32 -0
- package/api/resources/textToDialogue/client/requests/index.d.ts +2 -0
- package/api/resources/textToDialogue/client/requests/index.js +2 -0
- package/api/resources/textToDialogue/index.d.ts +2 -0
- package/api/resources/textToDialogue/index.js +18 -0
- package/api/resources/textToDialogue/types/TextToDialogueConvertRequestOutputFormat.d.ts +28 -0
- package/api/resources/textToDialogue/types/TextToDialogueConvertRequestOutputFormat.js +27 -0
- package/api/resources/textToDialogue/types/TextToDialogueStreamRequestOutputFormat.d.ts +28 -0
- package/api/resources/textToDialogue/types/TextToDialogueStreamRequestOutputFormat.js +27 -0
- package/api/resources/textToDialogue/types/index.d.ts +2 -0
- package/api/resources/textToDialogue/types/index.js +18 -0
- package/api/resources/textToSoundEffects/client/Client.js +1 -1
- package/api/resources/textToSpeech/client/Client.js +4 -4
- package/api/resources/textToVoice/client/Client.js +2 -2
- package/api/resources/usage/client/Client.js +1 -1
- package/api/resources/user/client/Client.js +1 -1
- package/api/resources/user/resources/subscription/client/Client.js +1 -1
- package/api/resources/voices/client/Client.js +12 -9
- package/api/resources/voices/client/requests/VoicesGetSharedRequest.d.ts +4 -0
- package/api/resources/voices/resources/ivc/client/Client.js +1 -1
- package/api/resources/voices/resources/pvc/client/Client.js +3 -3
- package/api/resources/voices/resources/pvc/resources/samples/client/Client.js +3 -3
- package/api/resources/voices/resources/pvc/resources/samples/resources/audio/client/Client.js +1 -1
- package/api/resources/voices/resources/pvc/resources/samples/resources/speakers/client/Client.js +2 -2
- package/api/resources/voices/resources/pvc/resources/samples/resources/speakers/resources/audio/client/Client.js +1 -1
- package/api/resources/voices/resources/pvc/resources/samples/resources/waveform/client/Client.js +1 -1
- package/api/resources/voices/resources/pvc/resources/verification/client/Client.js +1 -1
- package/api/resources/voices/resources/pvc/resources/verification/resources/captcha/client/Client.js +2 -2
- package/api/resources/voices/resources/samples/resources/audio/client/Client.js +1 -1
- package/api/resources/voices/resources/settings/client/Client.d.ts +1 -1
- package/api/resources/voices/resources/settings/client/Client.js +4 -4
- package/api/resources/workspace/resources/groups/client/Client.js +1 -1
- package/api/resources/workspace/resources/groups/resources/members/client/Client.js +2 -2
- package/api/resources/workspace/resources/invites/client/Client.js +3 -3
- package/api/resources/workspace/resources/members/client/Client.js +2 -2
- package/api/resources/workspace/resources/resources/client/Client.js +3 -3
- package/api/types/AddKnowledgeBaseResponseModel.d.ts +0 -1
- package/api/types/AgentConfigOverride.d.ts +4 -4
- package/api/types/AgentConfigOverrideConfig.d.ts +4 -4
- package/api/types/AuthorizationMethod.d.ts +2 -1
- package/api/types/AuthorizationMethod.js +1 -0
- package/api/types/ClientEvent.d.ts +2 -1
- package/api/types/ClientEvent.js +1 -0
- package/api/types/ConversationConfigClientOverrideConfigInput.d.ts +4 -4
- package/api/types/ConversationConfigClientOverrideConfigOutput.d.ts +4 -4
- package/api/types/ConversationConfigClientOverrideInput.d.ts +4 -4
- package/api/types/ConversationConfigClientOverrideOutput.d.ts +4 -4
- package/api/types/ConversationConfigOverride.d.ts +1 -0
- package/api/types/ConversationConfigOverrideConfig.d.ts +1 -1
- package/api/types/ConversationHistoryMetadataCommonModel.d.ts +2 -0
- package/api/types/ConversationHistoryTranscriptCommonModelInput.d.ts +1 -1
- package/api/types/ConversationHistoryTranscriptCommonModelOutput.d.ts +1 -1
- package/api/types/ConversationalConfig.d.ts +1 -1
- package/api/types/CustomLlm.d.ts +2 -0
- package/api/types/CustomLlmRequestHeadersValue.d.ts +5 -0
- package/api/types/DialogueInput.d.ts +9 -0
- package/api/types/DialogueInputResponseModel.d.ts +11 -0
- package/api/types/EmbedVariant.d.ts +2 -1
- package/api/types/EmbedVariant.js +1 -0
- package/api/types/FeatureStatusCommonModel.d.ts +7 -0
- package/api/types/FeaturesUsageCommonModel.d.ts +12 -0
- package/api/types/GetAgentEmbedResponseModel.d.ts +1 -1
- package/api/types/GetKnowledgeBaseFileResponseModel.d.ts +1 -1
- package/api/types/GetKnowledgeBaseSummaryFileResponseModel.d.ts +1 -1
- package/api/types/GetKnowledgeBaseSummaryTextResponseModel.d.ts +1 -1
- package/api/types/GetKnowledgeBaseSummaryUrlResponseModel.d.ts +1 -1
- package/api/types/GetKnowledgeBaseTextResponseModel.d.ts +1 -1
- package/api/types/GetKnowledgeBaseUrlResponseModel.d.ts +1 -1
- package/api/types/GetSharedSoundGenerationsResponseModel.d.ts +9 -0
- package/api/types/GetSharedSoundGenerationsResponseModel.js +5 -0
- package/api/types/Llm.d.ts +28 -3
- package/api/types/Llm.js +27 -2
- package/api/types/McpApprovalRequiredModel.d.ts +12 -0
- package/api/types/McpApprovalRequiredModel.js +11 -0
- package/api/types/McpToolConfigInput.d.ts +2 -0
- package/api/types/McpToolConfigOutput.d.ts +2 -0
- package/api/types/ModelSettingsResponseModel.d.ts +9 -0
- package/api/types/ModelSettingsResponseModel.js +5 -0
- package/api/types/NativeMcpToolConfigInput.d.ts +2 -0
- package/api/types/NativeMcpToolConfigOutput.d.ts +2 -0
- package/api/types/PromptAgentOverride.d.ts +1 -1
- package/api/types/PromptAgentOverrideConfig.d.ts +1 -1
- package/api/types/PronunciationDictionaryLocator.d.ts +1 -1
- package/api/types/RagConfig.d.ts +2 -0
- package/{dist/api/types/RagIndexResponseModel.d.ts → api/types/RagDocumentIndexResponseModel.d.ts} +4 -1
- package/api/types/RagDocumentIndexResponseModel.js +5 -0
- package/api/types/RagDocumentIndexUsage.d.ts +6 -0
- package/api/types/RagDocumentIndexUsage.js +5 -0
- package/api/types/RagDocumentIndexesResponseModel.d.ts +7 -0
- package/api/types/RagDocumentIndexesResponseModel.js +5 -0
- package/api/types/RagIndexOverviewEmbeddingModelResponseModel.d.ts +8 -0
- package/api/types/RagIndexOverviewEmbeddingModelResponseModel.js +5 -0
- package/api/types/RagIndexOverviewResponseModel.d.ts +9 -0
- package/api/types/RagIndexOverviewResponseModel.js +5 -0
- package/api/types/RagIndexStatus.d.ts +3 -1
- package/api/types/RagIndexStatus.js +2 -0
- package/api/types/SharedSoundGenerationResponseModel.d.ts +17 -0
- package/api/types/SharedSoundGenerationResponseModel.js +5 -0
- package/api/types/SkipTurnToolConfig.d.ts +16 -0
- package/api/types/SkipTurnToolConfig.js +5 -0
- package/api/types/SpeechHistoryItemResponse.d.ts +5 -3
- package/api/types/Subscription.d.ts +1 -1
- package/api/types/SubscriptionResponse.d.ts +1 -1
- package/api/types/{SubscriptionStatus.d.ts → SubscriptionStatusType.d.ts} +3 -5
- package/{dist/api/types/ExtendedSubscriptionResponseModelStatus.js → api/types/SubscriptionStatusType.js} +3 -2
- package/api/types/SupportedVoice.d.ts +11 -0
- package/api/types/SupportedVoice.js +5 -0
- package/api/types/SystemToolConfigInputParams.d.ts +4 -1
- package/api/types/SystemToolConfigOutputParams.d.ts +4 -1
- package/{dist/api/types/TtsConversationalConfig.d.ts → api/types/TtsConversationalConfigInput.d.ts} +3 -1
- package/api/types/TtsConversationalConfigInput.js +5 -0
- package/api/types/TtsConversationalConfigOutput.d.ts +24 -0
- package/api/types/TtsConversationalConfigOutput.js +5 -0
- package/api/types/TtsConversationalConfigOverride.d.ts +1 -0
- package/api/types/TtsConversationalConfigOverrideConfig.d.ts +1 -1
- package/api/types/TtsModelFamily.d.ts +9 -0
- package/api/types/TtsModelFamily.js +11 -0
- package/api/types/VoiceSettings.d.ts +2 -2
- package/api/types/WidgetConfig.d.ts +13 -1
- package/{dist/api/types/WidgetConfigAvatar.d.ts → api/types/WidgetConfigInputAvatar.d.ts} +2 -2
- package/api/types/WidgetConfigInputAvatar.js +5 -0
- package/api/types/WidgetConfigOutputAvatar.d.ts +19 -0
- package/api/types/WidgetConfigOutputAvatar.js +5 -0
- package/api/types/{WidgetConfigResponseModel.d.ts → WidgetConfigResponse.d.ts} +16 -1
- package/api/types/WidgetConfigResponse.js +5 -0
- package/api/types/WidgetLanguagePreset.d.ts +8 -0
- package/api/types/WidgetLanguagePreset.js +5 -0
- package/api/types/WidgetLanguagePresetResponse.d.ts +9 -0
- package/api/types/WidgetLanguagePresetResponse.js +5 -0
- package/api/types/WidgetPlacement.d.ts +12 -0
- package/api/types/WidgetPlacement.js +14 -0
- package/api/types/WidgetTextContents.d.ts +47 -0
- package/api/types/WidgetTextContents.js +5 -0
- package/api/types/index.d.ts +27 -6
- package/api/types/index.js +27 -6
- package/dist/Client.d.ts +3 -0
- package/dist/Client.js +33 -28
- package/dist/api/resources/audioIsolation/client/Client.js +2 -2
- package/dist/api/resources/audioNative/client/Client.js +3 -3
- package/dist/api/resources/conversationalAi/client/Client.d.ts +39 -0
- package/dist/api/resources/conversationalAi/client/Client.js +224 -2
- package/dist/api/resources/conversationalAi/resources/agents/client/Client.js +7 -7
- package/dist/api/resources/conversationalAi/resources/agents/client/requests/UpdateAgentRequest.d.ts +5 -2
- package/dist/api/resources/conversationalAi/resources/agents/resources/knowledgeBase/client/Client.js +1 -1
- package/dist/api/resources/conversationalAi/resources/agents/resources/link/client/Client.js +1 -1
- package/dist/api/resources/conversationalAi/resources/agents/resources/llmUsage/client/Client.js +1 -1
- package/dist/api/resources/conversationalAi/resources/agents/resources/widget/client/Client.js +1 -1
- package/dist/api/resources/conversationalAi/resources/agents/resources/widget/resources/avatar/client/Client.js +1 -1
- package/dist/api/resources/conversationalAi/resources/batchCalls/client/Client.d.ts +26 -0
- package/dist/api/resources/conversationalAi/resources/batchCalls/client/Client.js +151 -3
- package/dist/api/resources/conversationalAi/resources/conversations/client/Client.js +4 -4
- package/dist/api/resources/conversationalAi/resources/conversations/resources/audio/client/Client.js +1 -1
- package/dist/api/resources/conversationalAi/resources/conversations/resources/feedback/client/Client.js +1 -1
- package/dist/api/resources/conversationalAi/resources/dashboard/resources/settings/client/Client.js +2 -2
- package/dist/api/resources/conversationalAi/resources/knowledgeBase/client/Client.js +1 -1
- package/dist/api/resources/conversationalAi/resources/knowledgeBase/resources/document/client/Client.d.ts +1 -1
- package/dist/api/resources/conversationalAi/resources/knowledgeBase/resources/document/client/Client.js +2 -2
- package/dist/api/resources/conversationalAi/resources/knowledgeBase/resources/documents/client/Client.d.ts +2 -1
- package/dist/api/resources/conversationalAi/resources/knowledgeBase/resources/documents/client/Client.js +19 -12
- package/dist/api/resources/conversationalAi/resources/knowledgeBase/resources/documents/client/requests/DocumentsDeleteRequest.d.ts +13 -0
- package/dist/api/resources/conversationalAi/resources/knowledgeBase/resources/documents/client/requests/DocumentsDeleteRequest.js +5 -0
- package/dist/api/resources/conversationalAi/resources/knowledgeBase/resources/documents/client/requests/index.d.ts +1 -0
- package/dist/api/resources/conversationalAi/resources/knowledgeBase/resources/documents/resources/chunk/client/Client.js +1 -1
- package/dist/api/resources/conversationalAi/resources/llmUsage/client/Client.js +1 -1
- package/dist/api/resources/conversationalAi/resources/phoneNumbers/client/Client.js +5 -5
- package/dist/api/resources/conversationalAi/resources/secrets/client/Client.js +3 -3
- package/dist/api/resources/conversationalAi/resources/settings/client/Client.js +2 -2
- package/dist/api/resources/conversationalAi/resources/sipTrunk/client/Client.js +1 -1
- package/dist/api/resources/conversationalAi/resources/twilio/client/Client.js +1 -1
- package/dist/api/resources/dubbing/client/Client.js +3 -3
- package/dist/api/resources/dubbing/resources/audio/client/Client.js +1 -1
- package/dist/api/resources/dubbing/resources/resource/client/Client.js +5 -5
- package/dist/api/resources/dubbing/resources/resource/resources/language/client/Client.js +1 -1
- package/dist/api/resources/dubbing/resources/resource/resources/segment/client/Client.js +2 -2
- package/dist/api/resources/dubbing/resources/resource/resources/speaker/client/Client.js +2 -2
- package/dist/api/resources/dubbing/resources/resource/resources/speaker/resources/segment/client/Client.js +1 -1
- package/dist/api/resources/dubbing/resources/transcript/client/Client.js +1 -1
- package/dist/api/resources/forcedAlignment/client/Client.js +1 -1
- package/dist/api/resources/history/client/Client.js +5 -5
- package/dist/api/resources/index.d.ts +3 -0
- package/dist/api/resources/index.js +4 -1
- package/dist/api/resources/models/client/Client.js +1 -1
- package/dist/api/resources/pronunciationDictionaries/client/Client.js +5 -5
- package/dist/api/resources/pronunciationDictionaries/resources/rules/client/Client.js +2 -2
- package/dist/api/resources/samples/client/Client.js +1 -1
- package/dist/api/resources/speechToSpeech/client/Client.js +2 -2
- package/dist/api/resources/speechToText/client/requests/BodySpeechToTextV1SpeechToTextPost.d.ts +2 -0
- package/dist/api/resources/studio/client/Client.js +1 -1
- package/dist/api/resources/studio/resources/projects/client/Client.js +6 -6
- package/dist/api/resources/studio/resources/projects/resources/chapters/client/Client.js +6 -6
- package/dist/api/resources/studio/resources/projects/resources/chapters/resources/snapshots/client/Client.js +3 -3
- package/dist/api/resources/studio/resources/projects/resources/content/client/Client.js +1 -1
- package/dist/api/resources/studio/resources/projects/resources/pronunciationDictionaries/client/Client.js +1 -1
- package/dist/api/resources/studio/resources/projects/resources/snapshots/client/Client.js +4 -4
- package/dist/api/resources/textToDialogue/client/Client.d.ts +44 -0
- package/dist/api/resources/textToDialogue/client/Client.js +212 -0
- package/dist/api/resources/textToDialogue/client/index.d.ts +1 -0
- package/dist/api/resources/textToDialogue/client/index.js +17 -0
- package/dist/api/resources/textToDialogue/client/requests/BodyTextToDialogueMultiVoiceStreamingV1TextToDialogueStreamPost.d.ts +32 -0
- package/dist/api/resources/textToDialogue/client/requests/BodyTextToDialogueMultiVoiceStreamingV1TextToDialogueStreamPost.js +5 -0
- package/dist/api/resources/textToDialogue/client/requests/BodyTextToDialogueMultiVoiceV1TextToDialoguePost.d.ts +32 -0
- package/dist/api/resources/textToDialogue/client/requests/BodyTextToDialogueMultiVoiceV1TextToDialoguePost.js +5 -0
- package/dist/api/resources/textToDialogue/client/requests/index.d.ts +2 -0
- package/dist/api/resources/textToDialogue/client/requests/index.js +2 -0
- package/dist/api/resources/textToDialogue/index.d.ts +2 -0
- package/dist/api/resources/textToDialogue/index.js +18 -0
- package/dist/api/resources/textToDialogue/types/TextToDialogueConvertRequestOutputFormat.d.ts +28 -0
- package/dist/api/resources/textToDialogue/types/TextToDialogueConvertRequestOutputFormat.js +27 -0
- package/dist/api/resources/textToDialogue/types/TextToDialogueStreamRequestOutputFormat.d.ts +28 -0
- package/dist/api/resources/textToDialogue/types/TextToDialogueStreamRequestOutputFormat.js +27 -0
- package/dist/api/resources/textToDialogue/types/index.d.ts +2 -0
- package/dist/api/resources/textToDialogue/types/index.js +18 -0
- package/dist/api/resources/textToSoundEffects/client/Client.js +1 -1
- package/dist/api/resources/textToSpeech/client/Client.js +4 -4
- package/dist/api/resources/textToVoice/client/Client.js +2 -2
- package/dist/api/resources/usage/client/Client.js +1 -1
- package/dist/api/resources/user/client/Client.js +1 -1
- package/dist/api/resources/user/resources/subscription/client/Client.js +1 -1
- package/dist/api/resources/voices/client/Client.js +12 -9
- package/dist/api/resources/voices/client/requests/VoicesGetSharedRequest.d.ts +4 -0
- package/dist/api/resources/voices/resources/ivc/client/Client.js +1 -1
- package/dist/api/resources/voices/resources/pvc/client/Client.js +3 -3
- package/dist/api/resources/voices/resources/pvc/resources/samples/client/Client.js +3 -3
- package/dist/api/resources/voices/resources/pvc/resources/samples/resources/audio/client/Client.js +1 -1
- package/dist/api/resources/voices/resources/pvc/resources/samples/resources/speakers/client/Client.js +2 -2
- package/dist/api/resources/voices/resources/pvc/resources/samples/resources/speakers/resources/audio/client/Client.js +1 -1
- package/dist/api/resources/voices/resources/pvc/resources/samples/resources/waveform/client/Client.js +1 -1
- package/dist/api/resources/voices/resources/pvc/resources/verification/client/Client.js +1 -1
- package/dist/api/resources/voices/resources/pvc/resources/verification/resources/captcha/client/Client.js +2 -2
- package/dist/api/resources/voices/resources/samples/resources/audio/client/Client.js +1 -1
- package/dist/api/resources/voices/resources/settings/client/Client.d.ts +1 -1
- package/dist/api/resources/voices/resources/settings/client/Client.js +4 -4
- package/dist/api/resources/workspace/resources/groups/client/Client.js +1 -1
- package/dist/api/resources/workspace/resources/groups/resources/members/client/Client.js +2 -2
- package/dist/api/resources/workspace/resources/invites/client/Client.js +3 -3
- package/dist/api/resources/workspace/resources/members/client/Client.js +2 -2
- package/dist/api/resources/workspace/resources/resources/client/Client.js +3 -3
- package/dist/api/types/AddKnowledgeBaseResponseModel.d.ts +0 -1
- package/dist/api/types/AgentConfigOverride.d.ts +4 -4
- package/dist/api/types/AgentConfigOverrideConfig.d.ts +4 -4
- package/dist/api/types/AuthorizationMethod.d.ts +2 -1
- package/dist/api/types/AuthorizationMethod.js +1 -0
- package/dist/api/types/ClientEvent.d.ts +2 -1
- package/dist/api/types/ClientEvent.js +1 -0
- package/dist/api/types/ConversationConfigClientOverrideConfigInput.d.ts +4 -4
- package/dist/api/types/ConversationConfigClientOverrideConfigOutput.d.ts +4 -4
- package/dist/api/types/ConversationConfigClientOverrideInput.d.ts +4 -4
- package/dist/api/types/ConversationConfigClientOverrideOutput.d.ts +4 -4
- package/dist/api/types/ConversationConfigOverride.d.ts +1 -0
- package/dist/api/types/ConversationConfigOverrideConfig.d.ts +1 -1
- package/dist/api/types/ConversationHistoryMetadataCommonModel.d.ts +2 -0
- package/dist/api/types/ConversationHistoryTranscriptCommonModelInput.d.ts +1 -1
- package/dist/api/types/ConversationHistoryTranscriptCommonModelOutput.d.ts +1 -1
- package/dist/api/types/ConversationalConfig.d.ts +1 -1
- package/dist/api/types/CustomLlm.d.ts +2 -0
- package/dist/api/types/CustomLlmRequestHeadersValue.d.ts +5 -0
- package/dist/api/types/CustomLlmRequestHeadersValue.js +5 -0
- package/dist/api/types/DialogueInput.d.ts +9 -0
- package/dist/api/types/DialogueInput.js +5 -0
- package/dist/api/types/DialogueInputResponseModel.d.ts +11 -0
- package/dist/api/types/DialogueInputResponseModel.js +5 -0
- package/dist/api/types/EmbedVariant.d.ts +2 -1
- package/dist/api/types/EmbedVariant.js +1 -0
- package/dist/api/types/FeatureStatusCommonModel.d.ts +7 -0
- package/dist/api/types/FeatureStatusCommonModel.js +5 -0
- package/dist/api/types/FeaturesUsageCommonModel.d.ts +12 -0
- package/dist/api/types/FeaturesUsageCommonModel.js +5 -0
- package/dist/api/types/GetAgentEmbedResponseModel.d.ts +1 -1
- package/dist/api/types/GetKnowledgeBaseFileResponseModel.d.ts +1 -1
- package/dist/api/types/GetKnowledgeBaseSummaryFileResponseModel.d.ts +1 -1
- package/dist/api/types/GetKnowledgeBaseSummaryTextResponseModel.d.ts +1 -1
- package/dist/api/types/GetKnowledgeBaseSummaryUrlResponseModel.d.ts +1 -1
- package/dist/api/types/GetKnowledgeBaseTextResponseModel.d.ts +1 -1
- package/dist/api/types/GetKnowledgeBaseUrlResponseModel.d.ts +1 -1
- package/dist/api/types/GetSharedSoundGenerationsResponseModel.d.ts +9 -0
- package/dist/api/types/GetSharedSoundGenerationsResponseModel.js +5 -0
- package/dist/api/types/Llm.d.ts +28 -3
- package/dist/api/types/Llm.js +27 -2
- package/dist/api/types/McpApprovalRequiredModel.d.ts +12 -0
- package/dist/api/types/McpApprovalRequiredModel.js +11 -0
- package/dist/api/types/McpToolConfigInput.d.ts +2 -0
- package/dist/api/types/McpToolConfigOutput.d.ts +2 -0
- package/dist/api/types/ModelSettingsResponseModel.d.ts +9 -0
- package/dist/api/types/ModelSettingsResponseModel.js +5 -0
- package/dist/api/types/NativeMcpToolConfigInput.d.ts +2 -0
- package/dist/api/types/NativeMcpToolConfigOutput.d.ts +2 -0
- package/dist/api/types/PromptAgentOverride.d.ts +1 -1
- package/dist/api/types/PromptAgentOverrideConfig.d.ts +1 -1
- package/dist/api/types/PronunciationDictionaryLocator.d.ts +1 -1
- package/dist/api/types/RagConfig.d.ts +2 -0
- package/{api/types/RagIndexResponseModel.d.ts → dist/api/types/RagDocumentIndexResponseModel.d.ts} +4 -1
- package/dist/api/types/RagDocumentIndexResponseModel.js +5 -0
- package/dist/api/types/RagDocumentIndexUsage.d.ts +6 -0
- package/dist/api/types/RagDocumentIndexUsage.js +5 -0
- package/dist/api/types/RagDocumentIndexesResponseModel.d.ts +7 -0
- package/dist/api/types/RagDocumentIndexesResponseModel.js +5 -0
- package/dist/api/types/RagIndexOverviewEmbeddingModelResponseModel.d.ts +8 -0
- package/dist/api/types/RagIndexOverviewEmbeddingModelResponseModel.js +5 -0
- package/dist/api/types/RagIndexOverviewResponseModel.d.ts +9 -0
- package/dist/api/types/RagIndexOverviewResponseModel.js +5 -0
- package/dist/api/types/RagIndexStatus.d.ts +3 -1
- package/dist/api/types/RagIndexStatus.js +2 -0
- package/dist/api/types/SharedSoundGenerationResponseModel.d.ts +17 -0
- package/dist/api/types/SharedSoundGenerationResponseModel.js +5 -0
- package/dist/api/types/SkipTurnToolConfig.d.ts +16 -0
- package/dist/api/types/SkipTurnToolConfig.js +5 -0
- package/dist/api/types/SpeechHistoryItemResponse.d.ts +5 -3
- package/dist/api/types/Subscription.d.ts +1 -1
- package/dist/api/types/SubscriptionResponse.d.ts +1 -1
- package/dist/api/types/{SubscriptionStatus.d.ts → SubscriptionStatusType.d.ts} +3 -5
- package/{api/types/ExtendedSubscriptionResponseModelStatus.js → dist/api/types/SubscriptionStatusType.js} +3 -2
- package/dist/api/types/SupportedVoice.d.ts +11 -0
- package/dist/api/types/SupportedVoice.js +5 -0
- package/dist/api/types/SystemToolConfigInputParams.d.ts +4 -1
- package/dist/api/types/SystemToolConfigOutputParams.d.ts +4 -1
- package/{api/types/TtsConversationalConfig.d.ts → dist/api/types/TtsConversationalConfigInput.d.ts} +3 -1
- package/dist/api/types/TtsConversationalConfigInput.js +5 -0
- package/dist/api/types/TtsConversationalConfigOutput.d.ts +24 -0
- package/dist/api/types/TtsConversationalConfigOutput.js +5 -0
- package/dist/api/types/TtsConversationalConfigOverride.d.ts +1 -0
- package/dist/api/types/TtsConversationalConfigOverrideConfig.d.ts +1 -1
- package/dist/api/types/TtsModelFamily.d.ts +9 -0
- package/dist/api/types/TtsModelFamily.js +11 -0
- package/dist/api/types/VoiceSettings.d.ts +2 -2
- package/dist/api/types/WidgetConfig.d.ts +13 -1
- package/{api/types/WidgetConfigAvatar.d.ts → dist/api/types/WidgetConfigInputAvatar.d.ts} +2 -2
- package/dist/api/types/WidgetConfigInputAvatar.js +5 -0
- package/dist/api/types/WidgetConfigOutputAvatar.d.ts +19 -0
- package/dist/api/types/WidgetConfigOutputAvatar.js +5 -0
- package/dist/api/types/{WidgetConfigResponseModel.d.ts → WidgetConfigResponse.d.ts} +16 -1
- package/dist/api/types/WidgetConfigResponse.js +5 -0
- package/dist/api/types/WidgetLanguagePreset.d.ts +8 -0
- package/dist/api/types/WidgetLanguagePreset.js +5 -0
- package/dist/api/types/WidgetLanguagePresetResponse.d.ts +9 -0
- package/dist/api/types/WidgetLanguagePresetResponse.js +5 -0
- package/dist/api/types/WidgetPlacement.d.ts +12 -0
- package/dist/api/types/WidgetPlacement.js +14 -0
- package/dist/api/types/WidgetTextContents.d.ts +47 -0
- package/dist/api/types/WidgetTextContents.js +5 -0
- package/dist/api/types/index.d.ts +27 -6
- package/dist/api/types/index.js +27 -6
- package/dist/serialization/resources/conversationalAi/resources/agents/client/requests/UpdateAgentRequest.d.ts +4 -2
- package/dist/serialization/resources/conversationalAi/resources/agents/client/requests/UpdateAgentRequest.js +4 -2
- package/dist/serialization/resources/index.d.ts +3 -0
- package/dist/serialization/resources/index.js +4 -1
- package/dist/serialization/resources/textToDialogue/client/index.d.ts +1 -0
- package/dist/serialization/resources/textToDialogue/client/index.js +17 -0
- package/dist/serialization/resources/textToDialogue/client/requests/BodyTextToDialogueMultiVoiceStreamingV1TextToDialogueStreamPost.d.ts +19 -0
- package/dist/serialization/resources/textToDialogue/client/requests/BodyTextToDialogueMultiVoiceStreamingV1TextToDialogueStreamPost.js +50 -0
- package/dist/serialization/resources/textToDialogue/client/requests/BodyTextToDialogueMultiVoiceV1TextToDialoguePost.d.ts +19 -0
- package/dist/serialization/resources/textToDialogue/client/requests/BodyTextToDialogueMultiVoiceV1TextToDialoguePost.js +50 -0
- package/dist/serialization/resources/textToDialogue/client/requests/index.d.ts +2 -0
- package/dist/serialization/resources/textToDialogue/client/requests/index.js +7 -0
- package/dist/serialization/resources/textToDialogue/index.d.ts +2 -0
- package/dist/serialization/resources/textToDialogue/index.js +18 -0
- package/dist/serialization/resources/textToDialogue/types/TextToDialogueConvertRequestOutputFormat.d.ts +10 -0
- package/dist/serialization/resources/textToDialogue/types/TextToDialogueConvertRequestOutputFormat.js +61 -0
- package/dist/serialization/resources/textToDialogue/types/TextToDialogueStreamRequestOutputFormat.d.ts +10 -0
- package/dist/serialization/resources/textToDialogue/types/TextToDialogueStreamRequestOutputFormat.js +61 -0
- package/dist/serialization/resources/textToDialogue/types/index.d.ts +2 -0
- package/dist/serialization/resources/textToDialogue/types/index.js +18 -0
- package/dist/serialization/types/AddKnowledgeBaseResponseModel.d.ts +0 -1
- package/dist/serialization/types/AddKnowledgeBaseResponseModel.js +0 -1
- package/dist/serialization/types/AgentConfigOverride.d.ts +1 -1
- package/dist/serialization/types/AgentConfigOverride.js +1 -1
- package/dist/serialization/types/AgentConfigOverrideConfig.d.ts +1 -1
- package/dist/serialization/types/AgentConfigOverrideConfig.js +1 -1
- package/dist/serialization/types/AuthorizationMethod.d.ts +1 -1
- package/dist/serialization/types/AuthorizationMethod.js +1 -0
- package/dist/serialization/types/ClientEvent.d.ts +1 -1
- package/dist/serialization/types/ClientEvent.js +1 -0
- package/dist/serialization/types/ConversationConfigClientOverrideConfigInput.d.ts +2 -2
- package/dist/serialization/types/ConversationConfigClientOverrideConfigInput.js +2 -2
- package/dist/serialization/types/ConversationConfigClientOverrideConfigOutput.d.ts +2 -2
- package/dist/serialization/types/ConversationConfigClientOverrideConfigOutput.js +2 -2
- package/dist/serialization/types/ConversationConfigClientOverrideInput.d.ts +2 -2
- package/dist/serialization/types/ConversationConfigClientOverrideInput.js +2 -2
- package/dist/serialization/types/ConversationConfigClientOverrideOutput.d.ts +2 -2
- package/dist/serialization/types/ConversationConfigClientOverrideOutput.js +2 -2
- package/dist/serialization/types/ConversationHistoryMetadataCommonModel.d.ts +3 -0
- package/dist/serialization/types/ConversationHistoryMetadataCommonModel.js +3 -0
- package/dist/serialization/types/ConversationHistoryTranscriptCommonModelInput.d.ts +2 -2
- package/dist/serialization/types/ConversationHistoryTranscriptCommonModelInput.js +2 -2
- package/dist/serialization/types/ConversationHistoryTranscriptCommonModelOutput.d.ts +2 -2
- package/dist/serialization/types/ConversationHistoryTranscriptCommonModelOutput.js +2 -2
- package/dist/serialization/types/ConversationalConfig.d.ts +2 -2
- package/dist/serialization/types/ConversationalConfig.js +2 -2
- package/dist/serialization/types/CustomLlm.d.ts +2 -0
- package/dist/serialization/types/CustomLlm.js +2 -0
- package/dist/serialization/types/CustomLlmRequestHeadersValue.d.ts +12 -0
- package/dist/serialization/types/CustomLlmRequestHeadersValue.js +43 -0
- package/dist/serialization/types/DialogueInput.d.ts +13 -0
- package/dist/serialization/types/DialogueInput.js +44 -0
- package/dist/serialization/types/DialogueInputResponseModel.d.ts +14 -0
- package/dist/serialization/types/DialogueInputResponseModel.js +45 -0
- package/dist/serialization/types/EmbedVariant.d.ts +1 -1
- package/dist/serialization/types/EmbedVariant.js +1 -1
- package/dist/serialization/types/FeatureStatusCommonModel.d.ts +13 -0
- package/dist/serialization/types/FeatureStatusCommonModel.js +44 -0
- package/dist/serialization/types/FeaturesUsageCommonModel.d.ts +18 -0
- package/dist/serialization/types/FeaturesUsageCommonModel.js +49 -0
- package/dist/serialization/types/GetAgentEmbedResponseModel.d.ts +2 -2
- package/dist/serialization/types/GetAgentEmbedResponseModel.js +2 -2
- package/dist/serialization/types/GetKnowledgeBaseFileResponseModel.d.ts +2 -1
- package/dist/serialization/types/GetKnowledgeBaseFileResponseModel.js +2 -1
- package/dist/serialization/types/GetKnowledgeBaseSummaryFileResponseModel.d.ts +2 -1
- package/dist/serialization/types/GetKnowledgeBaseSummaryFileResponseModel.js +2 -1
- package/dist/serialization/types/GetKnowledgeBaseSummaryTextResponseModel.d.ts +2 -1
- package/dist/serialization/types/GetKnowledgeBaseSummaryTextResponseModel.js +2 -1
- package/dist/serialization/types/GetKnowledgeBaseSummaryUrlResponseModel.d.ts +2 -1
- package/dist/serialization/types/GetKnowledgeBaseSummaryUrlResponseModel.js +2 -1
- package/dist/serialization/types/GetKnowledgeBaseTextResponseModel.d.ts +2 -1
- package/dist/serialization/types/GetKnowledgeBaseTextResponseModel.js +2 -1
- package/dist/serialization/types/GetKnowledgeBaseUrlResponseModel.d.ts +2 -1
- package/dist/serialization/types/GetKnowledgeBaseUrlResponseModel.js +2 -1
- package/dist/serialization/types/GetSharedSoundGenerationsResponseModel.d.ts +15 -0
- package/dist/serialization/types/GetSharedSoundGenerationsResponseModel.js +46 -0
- package/dist/serialization/types/Llm.d.ts +1 -1
- package/dist/serialization/types/Llm.js +27 -2
- package/dist/serialization/types/McpApprovalRequiredModel.d.ts +10 -0
- package/{serialization/types/ExtendedSubscriptionResponseModelStatus.js → dist/serialization/types/McpApprovalRequiredModel.js} +5 -10
- package/dist/serialization/types/McpToolConfigInput.d.ts +2 -0
- package/dist/serialization/types/McpToolConfigInput.js +2 -0
- package/dist/serialization/types/McpToolConfigOutput.d.ts +2 -0
- package/dist/serialization/types/McpToolConfigOutput.js +2 -0
- package/dist/serialization/types/ModelSettingsResponseModel.d.ts +13 -0
- package/dist/serialization/types/ModelSettingsResponseModel.js +44 -0
- package/dist/serialization/types/NativeMcpToolConfigInput.d.ts +2 -0
- package/dist/serialization/types/NativeMcpToolConfigInput.js +2 -0
- package/dist/serialization/types/NativeMcpToolConfigOutput.d.ts +2 -0
- package/dist/serialization/types/NativeMcpToolConfigOutput.js +2 -0
- package/dist/serialization/types/PronunciationDictionaryLocator.d.ts +1 -1
- package/dist/serialization/types/PronunciationDictionaryLocator.js +1 -1
- package/dist/serialization/types/RagConfig.d.ts +1 -0
- package/dist/serialization/types/RagConfig.js +1 -0
- package/dist/serialization/types/RagDocumentIndexResponseModel.d.ts +19 -0
- package/dist/serialization/types/RagDocumentIndexResponseModel.js +50 -0
- package/dist/serialization/types/RagDocumentIndexUsage.d.ts +12 -0
- package/dist/serialization/types/RagDocumentIndexUsage.js +43 -0
- package/dist/serialization/types/RagDocumentIndexesResponseModel.d.ts +13 -0
- package/{serialization/types/RagIndexResponseModel.js → dist/serialization/types/RagDocumentIndexesResponseModel.js} +4 -5
- package/dist/serialization/types/RagIndexOverviewEmbeddingModelResponseModel.d.ts +14 -0
- package/dist/serialization/types/RagIndexOverviewEmbeddingModelResponseModel.js +45 -0
- package/dist/serialization/types/RagIndexOverviewResponseModel.d.ts +15 -0
- package/dist/serialization/types/RagIndexOverviewResponseModel.js +46 -0
- package/dist/serialization/types/RagIndexStatus.d.ts +1 -1
- package/dist/serialization/types/RagIndexStatus.js +8 -1
- package/dist/serialization/types/SharedSoundGenerationResponseModel.d.ts +23 -0
- package/dist/serialization/types/SharedSoundGenerationResponseModel.js +54 -0
- package/dist/serialization/types/SkipTurnToolConfig.d.ts +11 -0
- package/dist/serialization/types/SkipTurnToolConfig.js +41 -0
- package/dist/serialization/types/SpeechHistoryItemResponse.d.ts +5 -3
- package/dist/serialization/types/SpeechHistoryItemResponse.js +5 -3
- package/dist/serialization/types/Subscription.d.ts +2 -2
- package/dist/serialization/types/Subscription.js +2 -2
- package/dist/serialization/types/SubscriptionResponse.d.ts +2 -2
- package/dist/serialization/types/SubscriptionResponse.js +2 -2
- package/dist/serialization/types/SubscriptionStatusType.d.ts +10 -0
- package/dist/serialization/types/{SubscriptionStatus.js → SubscriptionStatusType.js} +3 -2
- package/dist/serialization/types/SupportedVoice.d.ts +17 -0
- package/dist/serialization/types/SupportedVoice.js +48 -0
- package/dist/serialization/types/SystemToolConfigInputParams.d.ts +5 -1
- package/dist/serialization/types/SystemToolConfigInputParams.js +2 -0
- package/dist/serialization/types/SystemToolConfigOutputParams.d.ts +5 -1
- package/dist/serialization/types/SystemToolConfigOutputParams.js +2 -0
- package/dist/serialization/types/{TtsConversationalConfig.d.ts → TtsConversationalConfigInput.d.ts} +4 -2
- package/{serialization/types/TtsConversationalConfig.js → dist/serialization/types/TtsConversationalConfigInput.js} +4 -2
- package/dist/serialization/types/TtsConversationalConfigOutput.d.ts +25 -0
- package/dist/serialization/types/TtsConversationalConfigOutput.js +56 -0
- package/dist/serialization/types/TtsModelFamily.d.ts +10 -0
- package/dist/serialization/types/TtsModelFamily.js +41 -0
- package/dist/serialization/types/VoiceSettings.d.ts +1 -1
- package/dist/serialization/types/VoiceSettings.js +1 -1
- package/dist/serialization/types/WidgetConfig.d.ts +11 -2
- package/dist/serialization/types/WidgetConfig.js +11 -2
- package/dist/serialization/types/{WidgetConfigAvatar.d.ts → WidgetConfigInputAvatar.d.ts} +3 -3
- package/dist/serialization/types/{WidgetConfigAvatar.js → WidgetConfigInputAvatar.js} +2 -2
- package/dist/serialization/types/WidgetConfigOutputAvatar.d.ts +22 -0
- package/dist/serialization/types/WidgetConfigOutputAvatar.js +53 -0
- package/dist/serialization/types/{WidgetConfigResponseModel.d.ts → WidgetConfigResponse.d.ts} +13 -2
- package/dist/serialization/types/{WidgetConfigResponseModel.js → WidgetConfigResponse.js} +13 -2
- package/dist/serialization/types/WidgetLanguagePreset.d.ts +13 -0
- package/dist/serialization/types/WidgetLanguagePreset.js +44 -0
- package/dist/serialization/types/WidgetLanguagePresetResponse.d.ts +14 -0
- package/dist/serialization/types/WidgetLanguagePresetResponse.js +45 -0
- package/dist/serialization/types/WidgetPlacement.d.ts +10 -0
- package/dist/serialization/types/WidgetPlacement.js +41 -0
- package/dist/serialization/types/WidgetTextContents.d.ts +32 -0
- package/dist/serialization/types/WidgetTextContents.js +63 -0
- package/dist/serialization/types/index.d.ts +27 -6
- package/dist/serialization/types/index.js +27 -6
- package/dist/version.d.ts +1 -1
- package/dist/version.js +1 -1
- package/package.json +1 -1
- package/reference.md +477 -4
- package/serialization/resources/conversationalAi/resources/agents/client/requests/UpdateAgentRequest.d.ts +4 -2
- package/serialization/resources/conversationalAi/resources/agents/client/requests/UpdateAgentRequest.js +4 -2
- package/serialization/resources/index.d.ts +3 -0
- package/serialization/resources/index.js +4 -1
- package/serialization/resources/textToDialogue/client/index.d.ts +1 -0
- package/serialization/resources/textToDialogue/client/index.js +17 -0
- package/serialization/resources/textToDialogue/client/requests/BodyTextToDialogueMultiVoiceStreamingV1TextToDialogueStreamPost.d.ts +19 -0
- package/serialization/resources/textToDialogue/client/requests/BodyTextToDialogueMultiVoiceStreamingV1TextToDialogueStreamPost.js +50 -0
- package/serialization/resources/textToDialogue/client/requests/BodyTextToDialogueMultiVoiceV1TextToDialoguePost.d.ts +19 -0
- package/serialization/resources/textToDialogue/client/requests/BodyTextToDialogueMultiVoiceV1TextToDialoguePost.js +50 -0
- package/serialization/resources/textToDialogue/client/requests/index.d.ts +2 -0
- package/serialization/resources/textToDialogue/client/requests/index.js +7 -0
- package/serialization/resources/textToDialogue/index.d.ts +2 -0
- package/serialization/resources/textToDialogue/index.js +18 -0
- package/serialization/resources/textToDialogue/types/TextToDialogueConvertRequestOutputFormat.d.ts +10 -0
- package/serialization/resources/textToDialogue/types/TextToDialogueConvertRequestOutputFormat.js +61 -0
- package/serialization/resources/textToDialogue/types/TextToDialogueStreamRequestOutputFormat.d.ts +10 -0
- package/serialization/resources/textToDialogue/types/TextToDialogueStreamRequestOutputFormat.js +61 -0
- package/serialization/resources/textToDialogue/types/index.d.ts +2 -0
- package/serialization/resources/textToDialogue/types/index.js +18 -0
- package/serialization/types/AddKnowledgeBaseResponseModel.d.ts +0 -1
- package/serialization/types/AddKnowledgeBaseResponseModel.js +0 -1
- package/serialization/types/AgentConfigOverride.d.ts +1 -1
- package/serialization/types/AgentConfigOverride.js +1 -1
- package/serialization/types/AgentConfigOverrideConfig.d.ts +1 -1
- package/serialization/types/AgentConfigOverrideConfig.js +1 -1
- package/serialization/types/AuthorizationMethod.d.ts +1 -1
- package/serialization/types/AuthorizationMethod.js +1 -0
- package/serialization/types/ClientEvent.d.ts +1 -1
- package/serialization/types/ClientEvent.js +1 -0
- package/serialization/types/ConversationConfigClientOverrideConfigInput.d.ts +2 -2
- package/serialization/types/ConversationConfigClientOverrideConfigInput.js +2 -2
- package/serialization/types/ConversationConfigClientOverrideConfigOutput.d.ts +2 -2
- package/serialization/types/ConversationConfigClientOverrideConfigOutput.js +2 -2
- package/serialization/types/ConversationConfigClientOverrideInput.d.ts +2 -2
- package/serialization/types/ConversationConfigClientOverrideInput.js +2 -2
- package/serialization/types/ConversationConfigClientOverrideOutput.d.ts +2 -2
- package/serialization/types/ConversationConfigClientOverrideOutput.js +2 -2
- package/serialization/types/ConversationHistoryMetadataCommonModel.d.ts +3 -0
- package/serialization/types/ConversationHistoryMetadataCommonModel.js +3 -0
- package/serialization/types/ConversationHistoryTranscriptCommonModelInput.d.ts +2 -2
- package/serialization/types/ConversationHistoryTranscriptCommonModelInput.js +2 -2
- package/serialization/types/ConversationHistoryTranscriptCommonModelOutput.d.ts +2 -2
- package/serialization/types/ConversationHistoryTranscriptCommonModelOutput.js +2 -2
- package/serialization/types/ConversationalConfig.d.ts +2 -2
- package/serialization/types/ConversationalConfig.js +2 -2
- package/serialization/types/CustomLlm.d.ts +2 -0
- package/serialization/types/CustomLlm.js +2 -0
- package/serialization/types/CustomLlmRequestHeadersValue.d.ts +12 -0
- package/serialization/types/CustomLlmRequestHeadersValue.js +43 -0
- package/serialization/types/DialogueInput.d.ts +13 -0
- package/serialization/types/DialogueInput.js +44 -0
- package/serialization/types/DialogueInputResponseModel.d.ts +14 -0
- package/serialization/types/DialogueInputResponseModel.js +45 -0
- package/serialization/types/EmbedVariant.d.ts +1 -1
- package/serialization/types/EmbedVariant.js +1 -1
- package/serialization/types/FeatureStatusCommonModel.d.ts +13 -0
- package/serialization/types/FeatureStatusCommonModel.js +44 -0
- package/serialization/types/FeaturesUsageCommonModel.d.ts +18 -0
- package/serialization/types/FeaturesUsageCommonModel.js +49 -0
- package/serialization/types/GetAgentEmbedResponseModel.d.ts +2 -2
- package/serialization/types/GetAgentEmbedResponseModel.js +2 -2
- package/serialization/types/GetKnowledgeBaseFileResponseModel.d.ts +2 -1
- package/serialization/types/GetKnowledgeBaseFileResponseModel.js +2 -1
- package/serialization/types/GetKnowledgeBaseSummaryFileResponseModel.d.ts +2 -1
- package/serialization/types/GetKnowledgeBaseSummaryFileResponseModel.js +2 -1
- package/serialization/types/GetKnowledgeBaseSummaryTextResponseModel.d.ts +2 -1
- package/serialization/types/GetKnowledgeBaseSummaryTextResponseModel.js +2 -1
- package/serialization/types/GetKnowledgeBaseSummaryUrlResponseModel.d.ts +2 -1
- package/serialization/types/GetKnowledgeBaseSummaryUrlResponseModel.js +2 -1
- package/serialization/types/GetKnowledgeBaseTextResponseModel.d.ts +2 -1
- package/serialization/types/GetKnowledgeBaseTextResponseModel.js +2 -1
- package/serialization/types/GetKnowledgeBaseUrlResponseModel.d.ts +2 -1
- package/serialization/types/GetKnowledgeBaseUrlResponseModel.js +2 -1
- package/serialization/types/GetSharedSoundGenerationsResponseModel.d.ts +15 -0
- package/serialization/types/GetSharedSoundGenerationsResponseModel.js +46 -0
- package/serialization/types/Llm.d.ts +1 -1
- package/serialization/types/Llm.js +27 -2
- package/serialization/types/McpApprovalRequiredModel.d.ts +10 -0
- package/{dist/serialization/types/ExtendedSubscriptionResponseModelStatus.js → serialization/types/McpApprovalRequiredModel.js} +5 -10
- package/serialization/types/McpToolConfigInput.d.ts +2 -0
- package/serialization/types/McpToolConfigInput.js +2 -0
- package/serialization/types/McpToolConfigOutput.d.ts +2 -0
- package/serialization/types/McpToolConfigOutput.js +2 -0
- package/serialization/types/ModelSettingsResponseModel.d.ts +13 -0
- package/serialization/types/ModelSettingsResponseModel.js +44 -0
- package/serialization/types/NativeMcpToolConfigInput.d.ts +2 -0
- package/serialization/types/NativeMcpToolConfigInput.js +2 -0
- package/serialization/types/NativeMcpToolConfigOutput.d.ts +2 -0
- package/serialization/types/NativeMcpToolConfigOutput.js +2 -0
- package/serialization/types/PronunciationDictionaryLocator.d.ts +1 -1
- package/serialization/types/PronunciationDictionaryLocator.js +1 -1
- package/serialization/types/RagConfig.d.ts +1 -0
- package/serialization/types/RagConfig.js +1 -0
- package/serialization/types/RagDocumentIndexResponseModel.d.ts +19 -0
- package/serialization/types/RagDocumentIndexResponseModel.js +50 -0
- package/serialization/types/RagDocumentIndexUsage.d.ts +12 -0
- package/serialization/types/RagDocumentIndexUsage.js +43 -0
- package/serialization/types/RagDocumentIndexesResponseModel.d.ts +13 -0
- package/{dist/serialization/types/RagIndexResponseModel.js → serialization/types/RagDocumentIndexesResponseModel.js} +4 -5
- package/serialization/types/RagIndexOverviewEmbeddingModelResponseModel.d.ts +14 -0
- package/serialization/types/RagIndexOverviewEmbeddingModelResponseModel.js +45 -0
- package/serialization/types/RagIndexOverviewResponseModel.d.ts +15 -0
- package/serialization/types/RagIndexOverviewResponseModel.js +46 -0
- package/serialization/types/RagIndexStatus.d.ts +1 -1
- package/serialization/types/RagIndexStatus.js +8 -1
- package/serialization/types/SharedSoundGenerationResponseModel.d.ts +23 -0
- package/serialization/types/SharedSoundGenerationResponseModel.js +54 -0
- package/serialization/types/SkipTurnToolConfig.d.ts +11 -0
- package/serialization/types/SkipTurnToolConfig.js +41 -0
- package/serialization/types/SpeechHistoryItemResponse.d.ts +5 -3
- package/serialization/types/SpeechHistoryItemResponse.js +5 -3
- package/serialization/types/Subscription.d.ts +2 -2
- package/serialization/types/Subscription.js +2 -2
- package/serialization/types/SubscriptionResponse.d.ts +2 -2
- package/serialization/types/SubscriptionResponse.js +2 -2
- package/serialization/types/SubscriptionStatusType.d.ts +10 -0
- package/serialization/types/{SubscriptionStatus.js → SubscriptionStatusType.js} +3 -2
- package/serialization/types/SupportedVoice.d.ts +17 -0
- package/serialization/types/SupportedVoice.js +48 -0
- package/serialization/types/SystemToolConfigInputParams.d.ts +5 -1
- package/serialization/types/SystemToolConfigInputParams.js +2 -0
- package/serialization/types/SystemToolConfigOutputParams.d.ts +5 -1
- package/serialization/types/SystemToolConfigOutputParams.js +2 -0
- package/serialization/types/{TtsConversationalConfig.d.ts → TtsConversationalConfigInput.d.ts} +4 -2
- package/{dist/serialization/types/TtsConversationalConfig.js → serialization/types/TtsConversationalConfigInput.js} +4 -2
- package/serialization/types/TtsConversationalConfigOutput.d.ts +25 -0
- package/serialization/types/TtsConversationalConfigOutput.js +56 -0
- package/serialization/types/TtsModelFamily.d.ts +10 -0
- package/serialization/types/TtsModelFamily.js +41 -0
- package/serialization/types/VoiceSettings.d.ts +1 -1
- package/serialization/types/VoiceSettings.js +1 -1
- package/serialization/types/WidgetConfig.d.ts +11 -2
- package/serialization/types/WidgetConfig.js +11 -2
- package/serialization/types/{WidgetConfigAvatar.d.ts → WidgetConfigInputAvatar.d.ts} +3 -3
- package/serialization/types/{WidgetConfigAvatar.js → WidgetConfigInputAvatar.js} +2 -2
- package/serialization/types/WidgetConfigOutputAvatar.d.ts +22 -0
- package/serialization/types/WidgetConfigOutputAvatar.js +53 -0
- package/serialization/types/{WidgetConfigResponseModel.d.ts → WidgetConfigResponse.d.ts} +13 -2
- package/serialization/types/{WidgetConfigResponseModel.js → WidgetConfigResponse.js} +13 -2
- package/serialization/types/WidgetLanguagePreset.d.ts +13 -0
- package/serialization/types/WidgetLanguagePreset.js +44 -0
- package/serialization/types/WidgetLanguagePresetResponse.d.ts +14 -0
- package/serialization/types/WidgetLanguagePresetResponse.js +45 -0
- package/serialization/types/WidgetPlacement.d.ts +10 -0
- package/serialization/types/WidgetPlacement.js +41 -0
- package/serialization/types/WidgetTextContents.d.ts +32 -0
- package/serialization/types/WidgetTextContents.js +63 -0
- package/serialization/types/index.d.ts +27 -6
- package/serialization/types/index.js +27 -6
- package/version.d.ts +1 -1
- package/version.js +1 -1
- package/api/types/ExtendedSubscriptionResponseModelStatus.d.ts +0 -17
- package/api/types/SubscriptionStatus.js +0 -16
- package/dist/api/types/ExtendedSubscriptionResponseModelStatus.d.ts +0 -17
- package/dist/api/types/SubscriptionStatus.js +0 -16
- package/dist/serialization/types/ExtendedSubscriptionResponseModelStatus.d.ts +0 -10
- package/dist/serialization/types/RagIndexResponseModel.d.ts +0 -14
- package/dist/serialization/types/SubscriptionStatus.d.ts +0 -10
- package/serialization/types/ExtendedSubscriptionResponseModelStatus.d.ts +0 -10
- package/serialization/types/RagIndexResponseModel.d.ts +0 -14
- package/serialization/types/SubscriptionStatus.d.ts +0 -10
- /package/api/{types/RagIndexResponseModel.js → resources/conversationalAi/resources/knowledgeBase/resources/documents/client/requests/DocumentsDeleteRequest.js} +0 -0
- /package/api/{types/TtsConversationalConfig.js → resources/textToDialogue/client/requests/BodyTextToDialogueMultiVoiceStreamingV1TextToDialogueStreamPost.js} +0 -0
- /package/api/{types/WidgetConfigAvatar.js → resources/textToDialogue/client/requests/BodyTextToDialogueMultiVoiceV1TextToDialoguePost.js} +0 -0
- /package/api/types/{WidgetConfigResponseModel.js → CustomLlmRequestHeadersValue.js} +0 -0
- /package/{dist/api/types/RagIndexResponseModel.js → api/types/DialogueInput.js} +0 -0
- /package/{dist/api/types/TtsConversationalConfig.js → api/types/DialogueInputResponseModel.js} +0 -0
- /package/{dist/api/types/WidgetConfigAvatar.js → api/types/FeatureStatusCommonModel.js} +0 -0
- /package/{dist/api/types/WidgetConfigResponseModel.js → api/types/FeaturesUsageCommonModel.js} +0 -0
package/.mock/openapi.json
CHANGED
|
@@ -661,6 +661,267 @@
|
|
|
661
661
|
"x-fern-streaming": true
|
|
662
662
|
}
|
|
663
663
|
},
|
|
664
|
+
"/v1/shared-sound-generations": {
|
|
665
|
+
"get": {
|
|
666
|
+
"operationId": "Get_shared_sound_effects_v1_shared_sound_generations_get",
|
|
667
|
+
"summary": "Get Shared Sound Effects",
|
|
668
|
+
"description": "Returns a list of shared sound effects.",
|
|
669
|
+
"parameters": [
|
|
670
|
+
{
|
|
671
|
+
"name": "page_size",
|
|
672
|
+
"in": "query",
|
|
673
|
+
"description": "How many sound effects to return at maximum. Can not exceed 100, defaults to 30.",
|
|
674
|
+
"required": false,
|
|
675
|
+
"schema": {
|
|
676
|
+
"description": "How many sound effects to return at maximum. Can not exceed 100, defaults to 30.",
|
|
677
|
+
"type": "integer",
|
|
678
|
+
"default": 30,
|
|
679
|
+
"title": "Page Size"
|
|
680
|
+
}
|
|
681
|
+
},
|
|
682
|
+
{
|
|
683
|
+
"name": "category",
|
|
684
|
+
"in": "query",
|
|
685
|
+
"description": "Sound effect category used for filtering.",
|
|
686
|
+
"required": false,
|
|
687
|
+
"schema": {
|
|
688
|
+
"description": "Sound effect category used for filtering.",
|
|
689
|
+
"anyOf": [
|
|
690
|
+
{
|
|
691
|
+
"enum": [
|
|
692
|
+
"restaurant",
|
|
693
|
+
"park",
|
|
694
|
+
"industrial",
|
|
695
|
+
"school",
|
|
696
|
+
"office",
|
|
697
|
+
"urban",
|
|
698
|
+
"ocean",
|
|
699
|
+
"nature",
|
|
700
|
+
"weather",
|
|
701
|
+
"foley",
|
|
702
|
+
"fantasy",
|
|
703
|
+
"human",
|
|
704
|
+
"device",
|
|
705
|
+
"sci-fi",
|
|
706
|
+
"horror",
|
|
707
|
+
"animal",
|
|
708
|
+
"boom",
|
|
709
|
+
"braam",
|
|
710
|
+
"riser",
|
|
711
|
+
"whoosh",
|
|
712
|
+
"drone",
|
|
713
|
+
"impact",
|
|
714
|
+
"weapon",
|
|
715
|
+
"transport",
|
|
716
|
+
"household",
|
|
717
|
+
"percussion",
|
|
718
|
+
"cymbal",
|
|
719
|
+
"synth",
|
|
720
|
+
"bass",
|
|
721
|
+
"guitar",
|
|
722
|
+
"key",
|
|
723
|
+
"string",
|
|
724
|
+
"brass",
|
|
725
|
+
"woodwind",
|
|
726
|
+
"ui element",
|
|
727
|
+
"sport",
|
|
728
|
+
"vehicle",
|
|
729
|
+
"misc"
|
|
730
|
+
],
|
|
731
|
+
"type": "string"
|
|
732
|
+
},
|
|
733
|
+
{
|
|
734
|
+
"type": "null"
|
|
735
|
+
}
|
|
736
|
+
],
|
|
737
|
+
"examples": [
|
|
738
|
+
"Nature"
|
|
739
|
+
],
|
|
740
|
+
"title": "Category"
|
|
741
|
+
}
|
|
742
|
+
},
|
|
743
|
+
{
|
|
744
|
+
"name": "search",
|
|
745
|
+
"in": "query",
|
|
746
|
+
"description": "Search term used for filtering",
|
|
747
|
+
"required": false,
|
|
748
|
+
"schema": {
|
|
749
|
+
"description": "Search term used for filtering",
|
|
750
|
+
"anyOf": [
|
|
751
|
+
{
|
|
752
|
+
"type": "string"
|
|
753
|
+
},
|
|
754
|
+
{
|
|
755
|
+
"type": "null"
|
|
756
|
+
}
|
|
757
|
+
],
|
|
758
|
+
"examples": [
|
|
759
|
+
"Cold water"
|
|
760
|
+
],
|
|
761
|
+
"title": "Search"
|
|
762
|
+
}
|
|
763
|
+
},
|
|
764
|
+
{
|
|
765
|
+
"name": "sort",
|
|
766
|
+
"in": "query",
|
|
767
|
+
"description": "Sort criteria. Can be one of: created_date, download_count, like_count, trending_score. Defaults to trending_score.",
|
|
768
|
+
"required": false,
|
|
769
|
+
"schema": {
|
|
770
|
+
"description": "Sort criteria. Can be one of: created_date, download_count, like_count, trending_score. Defaults to trending_score.",
|
|
771
|
+
"default": "trending_score",
|
|
772
|
+
"anyOf": [
|
|
773
|
+
{
|
|
774
|
+
"enum": [
|
|
775
|
+
"sharing_date_unix",
|
|
776
|
+
"purchased_count",
|
|
777
|
+
"like_count",
|
|
778
|
+
"trending_score"
|
|
779
|
+
],
|
|
780
|
+
"type": "string"
|
|
781
|
+
},
|
|
782
|
+
{
|
|
783
|
+
"type": "null"
|
|
784
|
+
}
|
|
785
|
+
],
|
|
786
|
+
"examples": [
|
|
787
|
+
"trending_score"
|
|
788
|
+
],
|
|
789
|
+
"title": "Sort"
|
|
790
|
+
}
|
|
791
|
+
},
|
|
792
|
+
{
|
|
793
|
+
"name": "featured",
|
|
794
|
+
"in": "query",
|
|
795
|
+
"description": "Filter featured sound effects.",
|
|
796
|
+
"required": false,
|
|
797
|
+
"schema": {
|
|
798
|
+
"description": "Filter featured sound effects.",
|
|
799
|
+
"type": "boolean",
|
|
800
|
+
"default": false,
|
|
801
|
+
"examples": [
|
|
802
|
+
true
|
|
803
|
+
],
|
|
804
|
+
"title": "Featured"
|
|
805
|
+
}
|
|
806
|
+
},
|
|
807
|
+
{
|
|
808
|
+
"name": "page",
|
|
809
|
+
"in": "query",
|
|
810
|
+
"required": false,
|
|
811
|
+
"schema": {
|
|
812
|
+
"type": "integer",
|
|
813
|
+
"default": 0,
|
|
814
|
+
"title": "Page"
|
|
815
|
+
}
|
|
816
|
+
},
|
|
817
|
+
{
|
|
818
|
+
"name": "xi-api-key",
|
|
819
|
+
"in": "header",
|
|
820
|
+
"description": "Your API key. This is required by most endpoints to access our API programatically. You can view your xi-api-key using the 'Profile' tab on the website.",
|
|
821
|
+
"required": false,
|
|
822
|
+
"schema": {
|
|
823
|
+
"description": "Your API key. This is required by most endpoints to access our API programatically. You can view your xi-api-key using the 'Profile' tab on the website.",
|
|
824
|
+
"anyOf": [
|
|
825
|
+
{
|
|
826
|
+
"type": "string"
|
|
827
|
+
},
|
|
828
|
+
{
|
|
829
|
+
"type": "null"
|
|
830
|
+
}
|
|
831
|
+
],
|
|
832
|
+
"title": "Xi-Api-Key"
|
|
833
|
+
}
|
|
834
|
+
}
|
|
835
|
+
],
|
|
836
|
+
"responses": {
|
|
837
|
+
"200": {
|
|
838
|
+
"description": "Successful Response",
|
|
839
|
+
"content": {
|
|
840
|
+
"application/json": {
|
|
841
|
+
"schema": {
|
|
842
|
+
"$ref": "#/components/schemas/GetSharedSoundGenerationsResponseModel"
|
|
843
|
+
}
|
|
844
|
+
}
|
|
845
|
+
}
|
|
846
|
+
},
|
|
847
|
+
"422": {
|
|
848
|
+
"description": "Validation Error",
|
|
849
|
+
"content": {
|
|
850
|
+
"application/json": {
|
|
851
|
+
"schema": {
|
|
852
|
+
"$ref": "#/components/schemas/HTTPValidationError"
|
|
853
|
+
}
|
|
854
|
+
}
|
|
855
|
+
}
|
|
856
|
+
}
|
|
857
|
+
},
|
|
858
|
+
"tags": [
|
|
859
|
+
"sound-effects-explore"
|
|
860
|
+
]
|
|
861
|
+
}
|
|
862
|
+
},
|
|
863
|
+
"/v1/shared-sound-generations/{sound_effect_generation_id}/purchase": {
|
|
864
|
+
"post": {
|
|
865
|
+
"operationId": "Purchases_shared_sound_effect_v1_shared_sound_generations__sound_effect_generation_id__purchase_post",
|
|
866
|
+
"summary": "Purchases Shared Sound Effect",
|
|
867
|
+
"description": "Purchases shared sound effect and charges user for the purchase.",
|
|
868
|
+
"parameters": [
|
|
869
|
+
{
|
|
870
|
+
"name": "sound_effect_generation_id",
|
|
871
|
+
"in": "path",
|
|
872
|
+
"description": "sound_effect_generation_id to be used, you can use GET https://api.elevenlabs.io/v1/sound-effects-history to receive a list of history items and their sound_effect_generation_ids.",
|
|
873
|
+
"required": true,
|
|
874
|
+
"schema": {
|
|
875
|
+
"description": "sound_effect_generation_id to be used, you can use GET https://api.elevenlabs.io/v1/sound-effects-history to receive a list of history items and their sound_effect_generation_ids.",
|
|
876
|
+
"type": "string",
|
|
877
|
+
"examples": [
|
|
878
|
+
"VW7YKqPnjY4h39yTbx2L"
|
|
879
|
+
],
|
|
880
|
+
"title": "Sound Effect Generation Id"
|
|
881
|
+
}
|
|
882
|
+
},
|
|
883
|
+
{
|
|
884
|
+
"name": "xi-api-key",
|
|
885
|
+
"in": "header",
|
|
886
|
+
"description": "Your API key. This is required by most endpoints to access our API programatically. You can view your xi-api-key using the 'Profile' tab on the website.",
|
|
887
|
+
"required": false,
|
|
888
|
+
"schema": {
|
|
889
|
+
"description": "Your API key. This is required by most endpoints to access our API programatically. You can view your xi-api-key using the 'Profile' tab on the website.",
|
|
890
|
+
"anyOf": [
|
|
891
|
+
{
|
|
892
|
+
"type": "string"
|
|
893
|
+
},
|
|
894
|
+
{
|
|
895
|
+
"type": "null"
|
|
896
|
+
}
|
|
897
|
+
],
|
|
898
|
+
"title": "Xi-Api-Key"
|
|
899
|
+
}
|
|
900
|
+
}
|
|
901
|
+
],
|
|
902
|
+
"responses": {
|
|
903
|
+
"200": {
|
|
904
|
+
"description": "Successful Response",
|
|
905
|
+
"content": {
|
|
906
|
+
"audio/mpeg": {}
|
|
907
|
+
}
|
|
908
|
+
},
|
|
909
|
+
"422": {
|
|
910
|
+
"description": "Validation Error",
|
|
911
|
+
"content": {
|
|
912
|
+
"application/json": {
|
|
913
|
+
"schema": {
|
|
914
|
+
"$ref": "#/components/schemas/HTTPValidationError"
|
|
915
|
+
}
|
|
916
|
+
}
|
|
917
|
+
}
|
|
918
|
+
}
|
|
919
|
+
},
|
|
920
|
+
"tags": [
|
|
921
|
+
"sound-effects-explore"
|
|
922
|
+
]
|
|
923
|
+
}
|
|
924
|
+
},
|
|
664
925
|
"/v1/voices/{voice_id}/samples/{sample_id}": {
|
|
665
926
|
"delete": {
|
|
666
927
|
"operationId": "Delete_sample_v1_voices__voice_id__samples__sample_id__delete",
|
|
@@ -1401,6 +1662,204 @@
|
|
|
1401
1662
|
"x-fern-streaming": true
|
|
1402
1663
|
}
|
|
1403
1664
|
},
|
|
1665
|
+
"/v1/text-to-dialogue": {
|
|
1666
|
+
"post": {
|
|
1667
|
+
"operationId": "Text_to_dialogue__multi_voice__v1_text_to_dialogue_post",
|
|
1668
|
+
"summary": "Text To Dialogue (Multi-Voice)",
|
|
1669
|
+
"description": "Converts a list of text and voice ID pairs into speech (dialogue) and returns audio.",
|
|
1670
|
+
"parameters": [
|
|
1671
|
+
{
|
|
1672
|
+
"name": "output_format",
|
|
1673
|
+
"in": "query",
|
|
1674
|
+
"description": "Output format of the generated audio. Formatted as codec_sample_rate_bitrate. So an mp3 with 22.05kHz sample rate at 32kbs is represented as mp3_22050_32. MP3 with 192kbps bitrate requires you to be subscribed to Creator tier or above. PCM with 44.1kHz sample rate requires you to be subscribed to Pro tier or above. Note that the μ-law format (sometimes written mu-law, often approximated as u-law) is commonly used for Twilio audio inputs.",
|
|
1675
|
+
"required": false,
|
|
1676
|
+
"schema": {
|
|
1677
|
+
"description": "Output format of the generated audio. Formatted as codec_sample_rate_bitrate. So an mp3 with 22.05kHz sample rate at 32kbs is represented as mp3_22050_32. MP3 with 192kbps bitrate requires you to be subscribed to Creator tier or above. PCM with 44.1kHz sample rate requires you to be subscribed to Pro tier or above. Note that the μ-law format (sometimes written mu-law, often approximated as u-law) is commonly used for Twilio audio inputs.",
|
|
1678
|
+
"type": "string",
|
|
1679
|
+
"default": "mp3_44100_128",
|
|
1680
|
+
"enum": [
|
|
1681
|
+
"mp3_22050_32",
|
|
1682
|
+
"mp3_44100_32",
|
|
1683
|
+
"mp3_44100_64",
|
|
1684
|
+
"mp3_44100_96",
|
|
1685
|
+
"mp3_44100_128",
|
|
1686
|
+
"mp3_44100_192",
|
|
1687
|
+
"pcm_8000",
|
|
1688
|
+
"pcm_16000",
|
|
1689
|
+
"pcm_22050",
|
|
1690
|
+
"pcm_24000",
|
|
1691
|
+
"pcm_44100",
|
|
1692
|
+
"pcm_48000",
|
|
1693
|
+
"ulaw_8000",
|
|
1694
|
+
"alaw_8000",
|
|
1695
|
+
"opus_48000_32",
|
|
1696
|
+
"opus_48000_64",
|
|
1697
|
+
"opus_48000_96",
|
|
1698
|
+
"opus_48000_128",
|
|
1699
|
+
"opus_48000_192"
|
|
1700
|
+
],
|
|
1701
|
+
"title": "Output format of the generated audio."
|
|
1702
|
+
}
|
|
1703
|
+
},
|
|
1704
|
+
{
|
|
1705
|
+
"name": "xi-api-key",
|
|
1706
|
+
"in": "header",
|
|
1707
|
+
"description": "Your API key. This is required by most endpoints to access our API programatically. You can view your xi-api-key using the 'Profile' tab on the website.",
|
|
1708
|
+
"required": false,
|
|
1709
|
+
"schema": {
|
|
1710
|
+
"description": "Your API key. This is required by most endpoints to access our API programatically. You can view your xi-api-key using the 'Profile' tab on the website.",
|
|
1711
|
+
"anyOf": [
|
|
1712
|
+
{
|
|
1713
|
+
"type": "string"
|
|
1714
|
+
},
|
|
1715
|
+
{
|
|
1716
|
+
"type": "null"
|
|
1717
|
+
}
|
|
1718
|
+
],
|
|
1719
|
+
"title": "Xi-Api-Key"
|
|
1720
|
+
}
|
|
1721
|
+
}
|
|
1722
|
+
],
|
|
1723
|
+
"requestBody": {
|
|
1724
|
+
"required": true,
|
|
1725
|
+
"content": {
|
|
1726
|
+
"application/json": {
|
|
1727
|
+
"schema": {
|
|
1728
|
+
"$ref": "#/components/schemas/Body_Text_to_dialogue__multi_voice__v1_text_to_dialogue_post"
|
|
1729
|
+
}
|
|
1730
|
+
}
|
|
1731
|
+
}
|
|
1732
|
+
},
|
|
1733
|
+
"responses": {
|
|
1734
|
+
"200": {
|
|
1735
|
+
"description": "The generated audio file",
|
|
1736
|
+
"content": {
|
|
1737
|
+
"audio/mpeg": {
|
|
1738
|
+
"schema": {
|
|
1739
|
+
"type": "string",
|
|
1740
|
+
"format": "binary"
|
|
1741
|
+
}
|
|
1742
|
+
}
|
|
1743
|
+
}
|
|
1744
|
+
},
|
|
1745
|
+
"422": {
|
|
1746
|
+
"description": "Validation Error",
|
|
1747
|
+
"content": {
|
|
1748
|
+
"application/json": {
|
|
1749
|
+
"schema": {
|
|
1750
|
+
"$ref": "#/components/schemas/HTTPValidationError"
|
|
1751
|
+
}
|
|
1752
|
+
}
|
|
1753
|
+
}
|
|
1754
|
+
}
|
|
1755
|
+
},
|
|
1756
|
+
"tags": [
|
|
1757
|
+
"text-to-dialogue"
|
|
1758
|
+
],
|
|
1759
|
+
"x-fern-sdk-group-name": "text_to_dialogue",
|
|
1760
|
+
"x-fern-sdk-method-name": "convert",
|
|
1761
|
+
"x-fern-streaming": true
|
|
1762
|
+
}
|
|
1763
|
+
},
|
|
1764
|
+
"/v1/text-to-dialogue/stream": {
|
|
1765
|
+
"post": {
|
|
1766
|
+
"operationId": "Text_to_dialogue__multi_voice__streaming_v1_text_to_dialogue_stream_post",
|
|
1767
|
+
"summary": "Text To Dialogue (Multi-Voice) Streaming",
|
|
1768
|
+
"description": "Converts a list of text and voice ID pairs into speech (dialogue) and returns an audio stream.",
|
|
1769
|
+
"parameters": [
|
|
1770
|
+
{
|
|
1771
|
+
"name": "output_format",
|
|
1772
|
+
"in": "query",
|
|
1773
|
+
"description": "Output format of the generated audio. Formatted as codec_sample_rate_bitrate. So an mp3 with 22.05kHz sample rate at 32kbs is represented as mp3_22050_32. MP3 with 192kbps bitrate requires you to be subscribed to Creator tier or above. PCM with 44.1kHz sample rate requires you to be subscribed to Pro tier or above. Note that the μ-law format (sometimes written mu-law, often approximated as u-law) is commonly used for Twilio audio inputs.",
|
|
1774
|
+
"required": false,
|
|
1775
|
+
"schema": {
|
|
1776
|
+
"description": "Output format of the generated audio. Formatted as codec_sample_rate_bitrate. So an mp3 with 22.05kHz sample rate at 32kbs is represented as mp3_22050_32. MP3 with 192kbps bitrate requires you to be subscribed to Creator tier or above. PCM with 44.1kHz sample rate requires you to be subscribed to Pro tier or above. Note that the μ-law format (sometimes written mu-law, often approximated as u-law) is commonly used for Twilio audio inputs.",
|
|
1777
|
+
"type": "string",
|
|
1778
|
+
"default": "mp3_44100_128",
|
|
1779
|
+
"enum": [
|
|
1780
|
+
"mp3_22050_32",
|
|
1781
|
+
"mp3_44100_32",
|
|
1782
|
+
"mp3_44100_64",
|
|
1783
|
+
"mp3_44100_96",
|
|
1784
|
+
"mp3_44100_128",
|
|
1785
|
+
"mp3_44100_192",
|
|
1786
|
+
"pcm_8000",
|
|
1787
|
+
"pcm_16000",
|
|
1788
|
+
"pcm_22050",
|
|
1789
|
+
"pcm_24000",
|
|
1790
|
+
"pcm_44100",
|
|
1791
|
+
"pcm_48000",
|
|
1792
|
+
"ulaw_8000",
|
|
1793
|
+
"alaw_8000",
|
|
1794
|
+
"opus_48000_32",
|
|
1795
|
+
"opus_48000_64",
|
|
1796
|
+
"opus_48000_96",
|
|
1797
|
+
"opus_48000_128",
|
|
1798
|
+
"opus_48000_192"
|
|
1799
|
+
],
|
|
1800
|
+
"title": "Output format of the generated audio."
|
|
1801
|
+
}
|
|
1802
|
+
},
|
|
1803
|
+
{
|
|
1804
|
+
"name": "xi-api-key",
|
|
1805
|
+
"in": "header",
|
|
1806
|
+
"description": "Your API key. This is required by most endpoints to access our API programatically. You can view your xi-api-key using the 'Profile' tab on the website.",
|
|
1807
|
+
"required": false,
|
|
1808
|
+
"schema": {
|
|
1809
|
+
"description": "Your API key. This is required by most endpoints to access our API programatically. You can view your xi-api-key using the 'Profile' tab on the website.",
|
|
1810
|
+
"anyOf": [
|
|
1811
|
+
{
|
|
1812
|
+
"type": "string"
|
|
1813
|
+
},
|
|
1814
|
+
{
|
|
1815
|
+
"type": "null"
|
|
1816
|
+
}
|
|
1817
|
+
],
|
|
1818
|
+
"title": "Xi-Api-Key"
|
|
1819
|
+
}
|
|
1820
|
+
}
|
|
1821
|
+
],
|
|
1822
|
+
"requestBody": {
|
|
1823
|
+
"required": true,
|
|
1824
|
+
"content": {
|
|
1825
|
+
"application/json": {
|
|
1826
|
+
"schema": {
|
|
1827
|
+
"$ref": "#/components/schemas/Body_Text_to_dialogue__multi_voice__streaming_v1_text_to_dialogue_stream_post"
|
|
1828
|
+
}
|
|
1829
|
+
}
|
|
1830
|
+
}
|
|
1831
|
+
},
|
|
1832
|
+
"responses": {
|
|
1833
|
+
"200": {
|
|
1834
|
+
"description": "Streaming audio data",
|
|
1835
|
+
"content": {
|
|
1836
|
+
"audio/mpeg": {
|
|
1837
|
+
"schema": {
|
|
1838
|
+
"type": "string",
|
|
1839
|
+
"format": "binary"
|
|
1840
|
+
}
|
|
1841
|
+
}
|
|
1842
|
+
}
|
|
1843
|
+
},
|
|
1844
|
+
"422": {
|
|
1845
|
+
"description": "Validation Error",
|
|
1846
|
+
"content": {
|
|
1847
|
+
"application/json": {
|
|
1848
|
+
"schema": {
|
|
1849
|
+
"$ref": "#/components/schemas/HTTPValidationError"
|
|
1850
|
+
}
|
|
1851
|
+
}
|
|
1852
|
+
}
|
|
1853
|
+
}
|
|
1854
|
+
},
|
|
1855
|
+
"tags": [
|
|
1856
|
+
"text-to-dialogue"
|
|
1857
|
+
],
|
|
1858
|
+
"x-fern-sdk-group-name": "text_to_dialogue",
|
|
1859
|
+
"x-fern-sdk-method-name": "stream",
|
|
1860
|
+
"x-fern-streaming": true
|
|
1861
|
+
}
|
|
1862
|
+
},
|
|
1404
1863
|
"/v1/speech-to-speech/{voice_id}": {
|
|
1405
1864
|
"post": {
|
|
1406
1865
|
"operationId": "Speech_to_Speech_v1_speech_to_speech__voice_id__post",
|
|
@@ -8165,6 +8624,27 @@
|
|
|
8165
8624
|
"title": "Include Custom Rates"
|
|
8166
8625
|
}
|
|
8167
8626
|
},
|
|
8627
|
+
{
|
|
8628
|
+
"name": "include_live_moderated",
|
|
8629
|
+
"in": "query",
|
|
8630
|
+
"description": "Include/exclude voices that are live moderated",
|
|
8631
|
+
"required": false,
|
|
8632
|
+
"schema": {
|
|
8633
|
+
"description": "Include/exclude voices that are live moderated",
|
|
8634
|
+
"anyOf": [
|
|
8635
|
+
{
|
|
8636
|
+
"type": "boolean"
|
|
8637
|
+
},
|
|
8638
|
+
{
|
|
8639
|
+
"type": "null"
|
|
8640
|
+
}
|
|
8641
|
+
],
|
|
8642
|
+
"examples": [
|
|
8643
|
+
true
|
|
8644
|
+
],
|
|
8645
|
+
"title": "Include Live Moderated"
|
|
8646
|
+
}
|
|
8647
|
+
},
|
|
8168
8648
|
{
|
|
8169
8649
|
"name": "reader_app_enabled",
|
|
8170
8650
|
"in": "query",
|
|
@@ -9074,10 +9554,17 @@
|
|
|
9074
9554
|
"name": "xi-api-key",
|
|
9075
9555
|
"in": "header",
|
|
9076
9556
|
"description": "Your API key. This is required by most endpoints to access our API programatically. You can view your xi-api-key using the 'Profile' tab on the website.",
|
|
9077
|
-
"required":
|
|
9557
|
+
"required": false,
|
|
9078
9558
|
"schema": {
|
|
9079
9559
|
"description": "Your API key. This is required by most endpoints to access our API programatically. You can view your xi-api-key using the 'Profile' tab on the website.",
|
|
9080
|
-
"
|
|
9560
|
+
"anyOf": [
|
|
9561
|
+
{
|
|
9562
|
+
"type": "string"
|
|
9563
|
+
},
|
|
9564
|
+
{
|
|
9565
|
+
"type": "null"
|
|
9566
|
+
}
|
|
9567
|
+
],
|
|
9081
9568
|
"title": "Xi-Api-Key"
|
|
9082
9569
|
}
|
|
9083
9570
|
}
|
|
@@ -9139,10 +9626,17 @@
|
|
|
9139
9626
|
"name": "xi-api-key",
|
|
9140
9627
|
"in": "header",
|
|
9141
9628
|
"description": "Your API key. This is required by most endpoints to access our API programatically. You can view your xi-api-key using the 'Profile' tab on the website.",
|
|
9142
|
-
"required":
|
|
9629
|
+
"required": false,
|
|
9143
9630
|
"schema": {
|
|
9144
9631
|
"description": "Your API key. This is required by most endpoints to access our API programatically. You can view your xi-api-key using the 'Profile' tab on the website.",
|
|
9145
|
-
"
|
|
9632
|
+
"anyOf": [
|
|
9633
|
+
{
|
|
9634
|
+
"type": "string"
|
|
9635
|
+
},
|
|
9636
|
+
{
|
|
9637
|
+
"type": "null"
|
|
9638
|
+
}
|
|
9639
|
+
],
|
|
9146
9640
|
"title": "Xi-Api-Key"
|
|
9147
9641
|
}
|
|
9148
9642
|
}
|
|
@@ -9211,10 +9705,17 @@
|
|
|
9211
9705
|
"name": "xi-api-key",
|
|
9212
9706
|
"in": "header",
|
|
9213
9707
|
"description": "Your API key. This is required by most endpoints to access our API programatically. You can view your xi-api-key using the 'Profile' tab on the website.",
|
|
9214
|
-
"required":
|
|
9708
|
+
"required": false,
|
|
9215
9709
|
"schema": {
|
|
9216
9710
|
"description": "Your API key. This is required by most endpoints to access our API programatically. You can view your xi-api-key using the 'Profile' tab on the website.",
|
|
9217
|
-
"
|
|
9711
|
+
"anyOf": [
|
|
9712
|
+
{
|
|
9713
|
+
"type": "string"
|
|
9714
|
+
},
|
|
9715
|
+
{
|
|
9716
|
+
"type": "null"
|
|
9717
|
+
}
|
|
9718
|
+
],
|
|
9218
9719
|
"title": "Xi-Api-Key"
|
|
9219
9720
|
}
|
|
9220
9721
|
}
|
|
@@ -9809,7 +10310,7 @@
|
|
|
9809
10310
|
"post": {
|
|
9810
10311
|
"operationId": "Speech_to_Text_v1_speech_to_text_post",
|
|
9811
10312
|
"summary": "Speech To Text",
|
|
9812
|
-
"description": "Transcribe an audio or video file.",
|
|
10313
|
+
"description": "Transcribe an audio or video file. If webhook is set to true, the request will be processed asynchronously and results sent to configured webhooks.",
|
|
9813
10314
|
"parameters": [
|
|
9814
10315
|
{
|
|
9815
10316
|
"name": "enable_logging",
|
|
@@ -9854,7 +10355,7 @@
|
|
|
9854
10355
|
},
|
|
9855
10356
|
"responses": {
|
|
9856
10357
|
"200": {
|
|
9857
|
-
"description": "
|
|
10358
|
+
"description": "Synchronous transcription result",
|
|
9858
10359
|
"content": {
|
|
9859
10360
|
"application/json": {
|
|
9860
10361
|
"schema": {
|
|
@@ -9863,6 +10364,17 @@
|
|
|
9863
10364
|
}
|
|
9864
10365
|
}
|
|
9865
10366
|
},
|
|
10367
|
+
"202": {
|
|
10368
|
+
"description": "Asynchronous request accepted",
|
|
10369
|
+
"content": {
|
|
10370
|
+
"application/json": {
|
|
10371
|
+
"example": {
|
|
10372
|
+
"message": "Request accepted. Transcription result will be sent to the webhook.",
|
|
10373
|
+
"request_id": "abc123"
|
|
10374
|
+
}
|
|
10375
|
+
}
|
|
10376
|
+
}
|
|
10377
|
+
},
|
|
9866
10378
|
"422": {
|
|
9867
10379
|
"description": "Validation Error",
|
|
9868
10380
|
"content": {
|
|
@@ -12670,26 +13182,262 @@
|
|
|
12670
13182
|
"content": {
|
|
12671
13183
|
"application/json": {
|
|
12672
13184
|
"schema": {
|
|
12673
|
-
"discriminator": {
|
|
12674
|
-
"propertyName": "type",
|
|
12675
|
-
"mapping": {
|
|
12676
|
-
"url": "#/components/schemas/GetKnowledgeBaseURLResponseModel",
|
|
12677
|
-
"file": "#/components/schemas/GetKnowledgeBaseFileResponseModel",
|
|
12678
|
-
"text": "#/components/schemas/GetKnowledgeBaseTextResponseModel"
|
|
12679
|
-
}
|
|
12680
|
-
},
|
|
12681
|
-
"oneOf": [
|
|
12682
|
-
{
|
|
12683
|
-
"$ref": "#/components/schemas/GetKnowledgeBaseURLResponseModel"
|
|
12684
|
-
},
|
|
12685
|
-
{
|
|
12686
|
-
"$ref": "#/components/schemas/GetKnowledgeBaseFileResponseModel"
|
|
12687
|
-
},
|
|
12688
|
-
{
|
|
12689
|
-
"$ref": "#/components/schemas/GetKnowledgeBaseTextResponseModel"
|
|
12690
|
-
}
|
|
12691
|
-
],
|
|
12692
|
-
"title": "Response Get Documentation From Knowledge Base V1 Convai Knowledge Base Documentation Id Get"
|
|
13185
|
+
"discriminator": {
|
|
13186
|
+
"propertyName": "type",
|
|
13187
|
+
"mapping": {
|
|
13188
|
+
"url": "#/components/schemas/GetKnowledgeBaseURLResponseModel",
|
|
13189
|
+
"file": "#/components/schemas/GetKnowledgeBaseFileResponseModel",
|
|
13190
|
+
"text": "#/components/schemas/GetKnowledgeBaseTextResponseModel"
|
|
13191
|
+
}
|
|
13192
|
+
},
|
|
13193
|
+
"oneOf": [
|
|
13194
|
+
{
|
|
13195
|
+
"$ref": "#/components/schemas/GetKnowledgeBaseURLResponseModel"
|
|
13196
|
+
},
|
|
13197
|
+
{
|
|
13198
|
+
"$ref": "#/components/schemas/GetKnowledgeBaseFileResponseModel"
|
|
13199
|
+
},
|
|
13200
|
+
{
|
|
13201
|
+
"$ref": "#/components/schemas/GetKnowledgeBaseTextResponseModel"
|
|
13202
|
+
}
|
|
13203
|
+
],
|
|
13204
|
+
"title": "Response Get Documentation From Knowledge Base V1 Convai Knowledge Base Documentation Id Get"
|
|
13205
|
+
}
|
|
13206
|
+
}
|
|
13207
|
+
}
|
|
13208
|
+
},
|
|
13209
|
+
"422": {
|
|
13210
|
+
"description": "Validation Error",
|
|
13211
|
+
"content": {
|
|
13212
|
+
"application/json": {
|
|
13213
|
+
"schema": {
|
|
13214
|
+
"$ref": "#/components/schemas/HTTPValidationError"
|
|
13215
|
+
}
|
|
13216
|
+
}
|
|
13217
|
+
}
|
|
13218
|
+
}
|
|
13219
|
+
},
|
|
13220
|
+
"tags": [
|
|
13221
|
+
"Conversational AI"
|
|
13222
|
+
],
|
|
13223
|
+
"x-fern-sdk-group-name": [
|
|
13224
|
+
"conversational_ai",
|
|
13225
|
+
"knowledge_base",
|
|
13226
|
+
"documents"
|
|
13227
|
+
],
|
|
13228
|
+
"x-fern-sdk-method-name": "get"
|
|
13229
|
+
},
|
|
13230
|
+
"delete": {
|
|
13231
|
+
"operationId": "Delete_knowledge_base_document_v1_convai_knowledge_base__documentation_id__delete",
|
|
13232
|
+
"summary": "Delete Knowledge Base Document",
|
|
13233
|
+
"description": "Delete a document from the knowledge base",
|
|
13234
|
+
"parameters": [
|
|
13235
|
+
{
|
|
13236
|
+
"name": "documentation_id",
|
|
13237
|
+
"in": "path",
|
|
13238
|
+
"description": "The id of a document from the knowledge base. This is returned on document addition.",
|
|
13239
|
+
"required": true,
|
|
13240
|
+
"schema": {
|
|
13241
|
+
"description": "The id of a document from the knowledge base. This is returned on document addition.",
|
|
13242
|
+
"type": "string",
|
|
13243
|
+
"embed": true,
|
|
13244
|
+
"examples": [
|
|
13245
|
+
"21m00Tcm4TlvDq8ikWAM"
|
|
13246
|
+
],
|
|
13247
|
+
"title": "Documentation Id"
|
|
13248
|
+
}
|
|
13249
|
+
},
|
|
13250
|
+
{
|
|
13251
|
+
"name": "force",
|
|
13252
|
+
"in": "query",
|
|
13253
|
+
"description": "If set to true, the document will be deleted regardless of whether it is used by any agents and it will be deleted from the dependent agents.",
|
|
13254
|
+
"required": false,
|
|
13255
|
+
"schema": {
|
|
13256
|
+
"description": "If set to true, the document will be deleted regardless of whether it is used by any agents and it will be deleted from the dependent agents.",
|
|
13257
|
+
"type": "boolean",
|
|
13258
|
+
"default": false,
|
|
13259
|
+
"title": "Force"
|
|
13260
|
+
}
|
|
13261
|
+
},
|
|
13262
|
+
{
|
|
13263
|
+
"name": "xi-api-key",
|
|
13264
|
+
"in": "header",
|
|
13265
|
+
"description": "Your API key. This is required by most endpoints to access our API programatically. You can view your xi-api-key using the 'Profile' tab on the website.",
|
|
13266
|
+
"required": false,
|
|
13267
|
+
"schema": {
|
|
13268
|
+
"description": "Your API key. This is required by most endpoints to access our API programatically. You can view your xi-api-key using the 'Profile' tab on the website.",
|
|
13269
|
+
"anyOf": [
|
|
13270
|
+
{
|
|
13271
|
+
"type": "string"
|
|
13272
|
+
},
|
|
13273
|
+
{
|
|
13274
|
+
"type": "null"
|
|
13275
|
+
}
|
|
13276
|
+
],
|
|
13277
|
+
"title": "Xi-Api-Key"
|
|
13278
|
+
}
|
|
13279
|
+
}
|
|
13280
|
+
],
|
|
13281
|
+
"responses": {
|
|
13282
|
+
"200": {
|
|
13283
|
+
"description": "Successful Response",
|
|
13284
|
+
"content": {
|
|
13285
|
+
"application/json": {
|
|
13286
|
+
"schema": {}
|
|
13287
|
+
}
|
|
13288
|
+
}
|
|
13289
|
+
},
|
|
13290
|
+
"422": {
|
|
13291
|
+
"description": "Validation Error",
|
|
13292
|
+
"content": {
|
|
13293
|
+
"application/json": {
|
|
13294
|
+
"schema": {
|
|
13295
|
+
"$ref": "#/components/schemas/HTTPValidationError"
|
|
13296
|
+
}
|
|
13297
|
+
}
|
|
13298
|
+
}
|
|
13299
|
+
}
|
|
13300
|
+
},
|
|
13301
|
+
"tags": [
|
|
13302
|
+
"Conversational AI"
|
|
13303
|
+
],
|
|
13304
|
+
"x-fern-sdk-group-name": [
|
|
13305
|
+
"conversational_ai",
|
|
13306
|
+
"knowledge_base",
|
|
13307
|
+
"documents"
|
|
13308
|
+
],
|
|
13309
|
+
"x-fern-sdk-method-name": "delete"
|
|
13310
|
+
}
|
|
13311
|
+
},
|
|
13312
|
+
"/v1/convai/knowledge-base/{documentation_id}/rag-index": {
|
|
13313
|
+
"post": {
|
|
13314
|
+
"operationId": "Compute_RAG_index__v1_convai_knowledge_base__documentation_id__rag_index_post",
|
|
13315
|
+
"summary": "Compute Rag Index.",
|
|
13316
|
+
"description": "In case the document is not RAG indexed, it triggers rag indexing task, otherwise it just returns the current status.",
|
|
13317
|
+
"parameters": [
|
|
13318
|
+
{
|
|
13319
|
+
"name": "documentation_id",
|
|
13320
|
+
"in": "path",
|
|
13321
|
+
"description": "The id of a document from the knowledge base. This is returned on document addition.",
|
|
13322
|
+
"required": true,
|
|
13323
|
+
"schema": {
|
|
13324
|
+
"description": "The id of a document from the knowledge base. This is returned on document addition.",
|
|
13325
|
+
"type": "string",
|
|
13326
|
+
"embed": true,
|
|
13327
|
+
"examples": [
|
|
13328
|
+
"21m00Tcm4TlvDq8ikWAM"
|
|
13329
|
+
],
|
|
13330
|
+
"title": "Documentation Id"
|
|
13331
|
+
}
|
|
13332
|
+
},
|
|
13333
|
+
{
|
|
13334
|
+
"name": "xi-api-key",
|
|
13335
|
+
"in": "header",
|
|
13336
|
+
"description": "Your API key. This is required by most endpoints to access our API programatically. You can view your xi-api-key using the 'Profile' tab on the website.",
|
|
13337
|
+
"required": false,
|
|
13338
|
+
"schema": {
|
|
13339
|
+
"description": "Your API key. This is required by most endpoints to access our API programatically. You can view your xi-api-key using the 'Profile' tab on the website.",
|
|
13340
|
+
"anyOf": [
|
|
13341
|
+
{
|
|
13342
|
+
"type": "string"
|
|
13343
|
+
},
|
|
13344
|
+
{
|
|
13345
|
+
"type": "null"
|
|
13346
|
+
}
|
|
13347
|
+
],
|
|
13348
|
+
"title": "Xi-Api-Key"
|
|
13349
|
+
}
|
|
13350
|
+
}
|
|
13351
|
+
],
|
|
13352
|
+
"requestBody": {
|
|
13353
|
+
"required": true,
|
|
13354
|
+
"content": {
|
|
13355
|
+
"application/json": {
|
|
13356
|
+
"schema": {
|
|
13357
|
+
"description": "Payload for RAG index status endpoint.",
|
|
13358
|
+
"$ref": "#/components/schemas/RAGIndexRequestModel"
|
|
13359
|
+
}
|
|
13360
|
+
}
|
|
13361
|
+
}
|
|
13362
|
+
},
|
|
13363
|
+
"responses": {
|
|
13364
|
+
"200": {
|
|
13365
|
+
"description": "Successful Response",
|
|
13366
|
+
"content": {
|
|
13367
|
+
"application/json": {
|
|
13368
|
+
"schema": {
|
|
13369
|
+
"$ref": "#/components/schemas/RAGDocumentIndexResponseModel"
|
|
13370
|
+
}
|
|
13371
|
+
}
|
|
13372
|
+
}
|
|
13373
|
+
},
|
|
13374
|
+
"422": {
|
|
13375
|
+
"description": "Validation Error",
|
|
13376
|
+
"content": {
|
|
13377
|
+
"application/json": {
|
|
13378
|
+
"schema": {
|
|
13379
|
+
"$ref": "#/components/schemas/HTTPValidationError"
|
|
13380
|
+
}
|
|
13381
|
+
}
|
|
13382
|
+
}
|
|
13383
|
+
}
|
|
13384
|
+
},
|
|
13385
|
+
"tags": [
|
|
13386
|
+
"Conversational AI"
|
|
13387
|
+
],
|
|
13388
|
+
"x-fern-sdk-group-name": [
|
|
13389
|
+
"conversational_ai",
|
|
13390
|
+
"knowledge_base",
|
|
13391
|
+
"document"
|
|
13392
|
+
],
|
|
13393
|
+
"x-fern-sdk-method-name": "compute_rag_index"
|
|
13394
|
+
},
|
|
13395
|
+
"get": {
|
|
13396
|
+
"operationId": "Get_RAG_indexes_of_the_specified_knowledgebase_document__v1_convai_knowledge_base__documentation_id__rag_index_get",
|
|
13397
|
+
"summary": "Get Rag Indexes Of The Specified Knowledgebase Document.",
|
|
13398
|
+
"description": "Provides information about all RAG indexes of the specified knowledgebase document.",
|
|
13399
|
+
"parameters": [
|
|
13400
|
+
{
|
|
13401
|
+
"name": "documentation_id",
|
|
13402
|
+
"in": "path",
|
|
13403
|
+
"description": "The id of a document from the knowledge base. This is returned on document addition.",
|
|
13404
|
+
"required": true,
|
|
13405
|
+
"schema": {
|
|
13406
|
+
"description": "The id of a document from the knowledge base. This is returned on document addition.",
|
|
13407
|
+
"type": "string",
|
|
13408
|
+
"embed": true,
|
|
13409
|
+
"examples": [
|
|
13410
|
+
"21m00Tcm4TlvDq8ikWAM"
|
|
13411
|
+
],
|
|
13412
|
+
"title": "Documentation Id"
|
|
13413
|
+
}
|
|
13414
|
+
},
|
|
13415
|
+
{
|
|
13416
|
+
"name": "xi-api-key",
|
|
13417
|
+
"in": "header",
|
|
13418
|
+
"description": "Your API key. This is required by most endpoints to access our API programatically. You can view your xi-api-key using the 'Profile' tab on the website.",
|
|
13419
|
+
"required": false,
|
|
13420
|
+
"schema": {
|
|
13421
|
+
"description": "Your API key. This is required by most endpoints to access our API programatically. You can view your xi-api-key using the 'Profile' tab on the website.",
|
|
13422
|
+
"anyOf": [
|
|
13423
|
+
{
|
|
13424
|
+
"type": "string"
|
|
13425
|
+
},
|
|
13426
|
+
{
|
|
13427
|
+
"type": "null"
|
|
13428
|
+
}
|
|
13429
|
+
],
|
|
13430
|
+
"title": "Xi-Api-Key"
|
|
13431
|
+
}
|
|
13432
|
+
}
|
|
13433
|
+
],
|
|
13434
|
+
"responses": {
|
|
13435
|
+
"200": {
|
|
13436
|
+
"description": "Successful Response",
|
|
13437
|
+
"content": {
|
|
13438
|
+
"application/json": {
|
|
13439
|
+
"schema": {
|
|
13440
|
+
"$ref": "#/components/schemas/RAGDocumentIndexesResponseModel"
|
|
12693
13441
|
}
|
|
12694
13442
|
}
|
|
12695
13443
|
}
|
|
@@ -12708,17 +13456,15 @@
|
|
|
12708
13456
|
"tags": [
|
|
12709
13457
|
"Conversational AI"
|
|
12710
13458
|
],
|
|
12711
|
-
"x-fern-sdk-group-name":
|
|
12712
|
-
|
|
12713
|
-
|
|
12714
|
-
|
|
12715
|
-
|
|
12716
|
-
"x-fern-sdk-method-name": "get"
|
|
12717
|
-
},
|
|
13459
|
+
"x-fern-sdk-group-name": "conversational_ai",
|
|
13460
|
+
"x-fern-sdk-method-name": "get_document_rag_indexes"
|
|
13461
|
+
}
|
|
13462
|
+
},
|
|
13463
|
+
"/v1/convai/knowledge-base/{documentation_id}/rag-index/{rag_index_id}": {
|
|
12718
13464
|
"delete": {
|
|
12719
|
-
"operationId": "
|
|
12720
|
-
"summary": "Delete
|
|
12721
|
-
"description": "Delete
|
|
13465
|
+
"operationId": "Delete_RAG_index__v1_convai_knowledge_base__documentation_id__rag_index__rag_index_id__delete",
|
|
13466
|
+
"summary": "Delete Rag Index.",
|
|
13467
|
+
"description": "Delete RAG index for the knowledgebase document.",
|
|
12722
13468
|
"parameters": [
|
|
12723
13469
|
{
|
|
12724
13470
|
"name": "documentation_id",
|
|
@@ -12735,6 +13481,21 @@
|
|
|
12735
13481
|
"title": "Documentation Id"
|
|
12736
13482
|
}
|
|
12737
13483
|
},
|
|
13484
|
+
{
|
|
13485
|
+
"name": "rag_index_id",
|
|
13486
|
+
"in": "path",
|
|
13487
|
+
"description": "The id of RAG index of document from the knowledge base.",
|
|
13488
|
+
"required": true,
|
|
13489
|
+
"schema": {
|
|
13490
|
+
"description": "The id of RAG index of document from the knowledge base.",
|
|
13491
|
+
"type": "string",
|
|
13492
|
+
"embed": true,
|
|
13493
|
+
"examples": [
|
|
13494
|
+
"21m00Tcm4TlvDq8ikWAM"
|
|
13495
|
+
],
|
|
13496
|
+
"title": "Rag Index Id"
|
|
13497
|
+
}
|
|
13498
|
+
},
|
|
12738
13499
|
{
|
|
12739
13500
|
"name": "xi-api-key",
|
|
12740
13501
|
"in": "header",
|
|
@@ -12759,7 +13520,9 @@
|
|
|
12759
13520
|
"description": "Successful Response",
|
|
12760
13521
|
"content": {
|
|
12761
13522
|
"application/json": {
|
|
12762
|
-
"schema": {
|
|
13523
|
+
"schema": {
|
|
13524
|
+
"$ref": "#/components/schemas/RAGDocumentIndexResponseModel"
|
|
13525
|
+
}
|
|
12763
13526
|
}
|
|
12764
13527
|
}
|
|
12765
13528
|
},
|
|
@@ -12777,35 +13540,16 @@
|
|
|
12777
13540
|
"tags": [
|
|
12778
13541
|
"Conversational AI"
|
|
12779
13542
|
],
|
|
12780
|
-
"x-fern-sdk-group-name":
|
|
12781
|
-
|
|
12782
|
-
"knowledge_base",
|
|
12783
|
-
"documents"
|
|
12784
|
-
],
|
|
12785
|
-
"x-fern-sdk-method-name": "delete"
|
|
13543
|
+
"x-fern-sdk-group-name": "conversational_ai",
|
|
13544
|
+
"x-fern-sdk-method-name": "delete_document_rag_index"
|
|
12786
13545
|
}
|
|
12787
13546
|
},
|
|
12788
|
-
"/v1/convai/knowledge-base/
|
|
12789
|
-
"
|
|
12790
|
-
"operationId": "
|
|
12791
|
-
"summary": "
|
|
12792
|
-
"description": "
|
|
13547
|
+
"/v1/convai/knowledge-base/rag-index": {
|
|
13548
|
+
"get": {
|
|
13549
|
+
"operationId": "Get_RAG_index_overview__v1_convai_knowledge_base_rag_index_get",
|
|
13550
|
+
"summary": "Get Rag Index Overview.",
|
|
13551
|
+
"description": "Provides total size and other information of RAG indexes used by knowledgebase documents",
|
|
12793
13552
|
"parameters": [
|
|
12794
|
-
{
|
|
12795
|
-
"name": "documentation_id",
|
|
12796
|
-
"in": "path",
|
|
12797
|
-
"description": "The id of a document from the knowledge base. This is returned on document addition.",
|
|
12798
|
-
"required": true,
|
|
12799
|
-
"schema": {
|
|
12800
|
-
"description": "The id of a document from the knowledge base. This is returned on document addition.",
|
|
12801
|
-
"type": "string",
|
|
12802
|
-
"embed": true,
|
|
12803
|
-
"examples": [
|
|
12804
|
-
"21m00Tcm4TlvDq8ikWAM"
|
|
12805
|
-
],
|
|
12806
|
-
"title": "Documentation Id"
|
|
12807
|
-
}
|
|
12808
|
-
},
|
|
12809
13553
|
{
|
|
12810
13554
|
"name": "xi-api-key",
|
|
12811
13555
|
"in": "header",
|
|
@@ -12825,24 +13569,13 @@
|
|
|
12825
13569
|
}
|
|
12826
13570
|
}
|
|
12827
13571
|
],
|
|
12828
|
-
"requestBody": {
|
|
12829
|
-
"required": true,
|
|
12830
|
-
"content": {
|
|
12831
|
-
"application/json": {
|
|
12832
|
-
"schema": {
|
|
12833
|
-
"description": "Payload for RAG index status endpoint.",
|
|
12834
|
-
"$ref": "#/components/schemas/RAGIndexRequestModel"
|
|
12835
|
-
}
|
|
12836
|
-
}
|
|
12837
|
-
}
|
|
12838
|
-
},
|
|
12839
13572
|
"responses": {
|
|
12840
13573
|
"200": {
|
|
12841
13574
|
"description": "Successful Response",
|
|
12842
13575
|
"content": {
|
|
12843
13576
|
"application/json": {
|
|
12844
13577
|
"schema": {
|
|
12845
|
-
"$ref": "#/components/schemas/
|
|
13578
|
+
"$ref": "#/components/schemas/RAGIndexOverviewResponseModel"
|
|
12846
13579
|
}
|
|
12847
13580
|
}
|
|
12848
13581
|
}
|
|
@@ -12861,12 +13594,8 @@
|
|
|
12861
13594
|
"tags": [
|
|
12862
13595
|
"Conversational AI"
|
|
12863
13596
|
],
|
|
12864
|
-
"x-fern-sdk-group-name":
|
|
12865
|
-
|
|
12866
|
-
"knowledge_base",
|
|
12867
|
-
"document"
|
|
12868
|
-
],
|
|
12869
|
-
"x-fern-sdk-method-name": "compute_rag_index"
|
|
13597
|
+
"x-fern-sdk-group-name": "conversational_ai",
|
|
13598
|
+
"x-fern-sdk-method-name": "rag_index_overview"
|
|
12870
13599
|
}
|
|
12871
13600
|
},
|
|
12872
13601
|
"/v1/convai/agents/{agent_id}/knowledge-base/{documentation_id}": {
|
|
@@ -13936,6 +14665,138 @@
|
|
|
13936
14665
|
"x-fern-sdk-method-name": "get"
|
|
13937
14666
|
}
|
|
13938
14667
|
},
|
|
14668
|
+
"/v1/convai/batch-calling/{batch_id}/cancel": {
|
|
14669
|
+
"post": {
|
|
14670
|
+
"operationId": "Cancel_a_batch_call__v1_convai_batch_calling__batch_id__cancel_post",
|
|
14671
|
+
"summary": "Cancel A Batch Call.",
|
|
14672
|
+
"description": "Cancel a running batch call and set all recipients to cancelled status.",
|
|
14673
|
+
"parameters": [
|
|
14674
|
+
{
|
|
14675
|
+
"name": "batch_id",
|
|
14676
|
+
"in": "path",
|
|
14677
|
+
"required": true,
|
|
14678
|
+
"schema": {
|
|
14679
|
+
"type": "string",
|
|
14680
|
+
"title": "Batch Id"
|
|
14681
|
+
}
|
|
14682
|
+
},
|
|
14683
|
+
{
|
|
14684
|
+
"name": "xi-api-key",
|
|
14685
|
+
"in": "header",
|
|
14686
|
+
"description": "Your API key. This is required by most endpoints to access our API programatically. You can view your xi-api-key using the 'Profile' tab on the website.",
|
|
14687
|
+
"required": false,
|
|
14688
|
+
"schema": {
|
|
14689
|
+
"description": "Your API key. This is required by most endpoints to access our API programatically. You can view your xi-api-key using the 'Profile' tab on the website.",
|
|
14690
|
+
"anyOf": [
|
|
14691
|
+
{
|
|
14692
|
+
"type": "string"
|
|
14693
|
+
},
|
|
14694
|
+
{
|
|
14695
|
+
"type": "null"
|
|
14696
|
+
}
|
|
14697
|
+
],
|
|
14698
|
+
"title": "Xi-Api-Key"
|
|
14699
|
+
}
|
|
14700
|
+
}
|
|
14701
|
+
],
|
|
14702
|
+
"responses": {
|
|
14703
|
+
"200": {
|
|
14704
|
+
"description": "Successful Response",
|
|
14705
|
+
"content": {
|
|
14706
|
+
"application/json": {
|
|
14707
|
+
"schema": {
|
|
14708
|
+
"$ref": "#/components/schemas/BatchCallResponse"
|
|
14709
|
+
}
|
|
14710
|
+
}
|
|
14711
|
+
}
|
|
14712
|
+
},
|
|
14713
|
+
"422": {
|
|
14714
|
+
"description": "Validation Error",
|
|
14715
|
+
"content": {
|
|
14716
|
+
"application/json": {
|
|
14717
|
+
"schema": {
|
|
14718
|
+
"$ref": "#/components/schemas/HTTPValidationError"
|
|
14719
|
+
}
|
|
14720
|
+
}
|
|
14721
|
+
}
|
|
14722
|
+
}
|
|
14723
|
+
},
|
|
14724
|
+
"tags": [
|
|
14725
|
+
"Conversational AI"
|
|
14726
|
+
],
|
|
14727
|
+
"x-fern-sdk-group-name": [
|
|
14728
|
+
"conversational_ai",
|
|
14729
|
+
"batch_calls"
|
|
14730
|
+
],
|
|
14731
|
+
"x-fern-sdk-method-name": "cancel"
|
|
14732
|
+
}
|
|
14733
|
+
},
|
|
14734
|
+
"/v1/convai/batch-calling/{batch_id}/retry": {
|
|
14735
|
+
"post": {
|
|
14736
|
+
"operationId": "Retry_a_batch_call__v1_convai_batch_calling__batch_id__retry_post",
|
|
14737
|
+
"summary": "Retry A Batch Call.",
|
|
14738
|
+
"description": "Retry a batch call by setting completed recipients back to pending status.",
|
|
14739
|
+
"parameters": [
|
|
14740
|
+
{
|
|
14741
|
+
"name": "batch_id",
|
|
14742
|
+
"in": "path",
|
|
14743
|
+
"required": true,
|
|
14744
|
+
"schema": {
|
|
14745
|
+
"type": "string",
|
|
14746
|
+
"title": "Batch Id"
|
|
14747
|
+
}
|
|
14748
|
+
},
|
|
14749
|
+
{
|
|
14750
|
+
"name": "xi-api-key",
|
|
14751
|
+
"in": "header",
|
|
14752
|
+
"description": "Your API key. This is required by most endpoints to access our API programatically. You can view your xi-api-key using the 'Profile' tab on the website.",
|
|
14753
|
+
"required": false,
|
|
14754
|
+
"schema": {
|
|
14755
|
+
"description": "Your API key. This is required by most endpoints to access our API programatically. You can view your xi-api-key using the 'Profile' tab on the website.",
|
|
14756
|
+
"anyOf": [
|
|
14757
|
+
{
|
|
14758
|
+
"type": "string"
|
|
14759
|
+
},
|
|
14760
|
+
{
|
|
14761
|
+
"type": "null"
|
|
14762
|
+
}
|
|
14763
|
+
],
|
|
14764
|
+
"title": "Xi-Api-Key"
|
|
14765
|
+
}
|
|
14766
|
+
}
|
|
14767
|
+
],
|
|
14768
|
+
"responses": {
|
|
14769
|
+
"200": {
|
|
14770
|
+
"description": "Successful Response",
|
|
14771
|
+
"content": {
|
|
14772
|
+
"application/json": {
|
|
14773
|
+
"schema": {
|
|
14774
|
+
"$ref": "#/components/schemas/BatchCallResponse"
|
|
14775
|
+
}
|
|
14776
|
+
}
|
|
14777
|
+
}
|
|
14778
|
+
},
|
|
14779
|
+
"422": {
|
|
14780
|
+
"description": "Validation Error",
|
|
14781
|
+
"content": {
|
|
14782
|
+
"application/json": {
|
|
14783
|
+
"schema": {
|
|
14784
|
+
"$ref": "#/components/schemas/HTTPValidationError"
|
|
14785
|
+
}
|
|
14786
|
+
}
|
|
14787
|
+
}
|
|
14788
|
+
}
|
|
14789
|
+
},
|
|
14790
|
+
"tags": [
|
|
14791
|
+
"Conversational AI"
|
|
14792
|
+
],
|
|
14793
|
+
"x-fern-sdk-group-name": [
|
|
14794
|
+
"conversational_ai",
|
|
14795
|
+
"batch_calls"
|
|
14796
|
+
],
|
|
14797
|
+
"x-fern-sdk-method-name": "retry"
|
|
14798
|
+
}
|
|
14799
|
+
},
|
|
13939
14800
|
"/v1/convai/sip-trunk/outbound-call": {
|
|
13940
14801
|
"post": {
|
|
13941
14802
|
"operationId": "Handle_an_outbound_call_via_SIP_trunk_v1_convai_sip_trunk_outbound_call_post",
|
|
@@ -15289,16 +16150,11 @@
|
|
|
15289
16150
|
"name": {
|
|
15290
16151
|
"type": "string",
|
|
15291
16152
|
"title": "Name"
|
|
15292
|
-
},
|
|
15293
|
-
"prompt_injectable": {
|
|
15294
|
-
"type": "boolean",
|
|
15295
|
-
"title": "Prompt Injectable"
|
|
15296
16153
|
}
|
|
15297
16154
|
},
|
|
15298
16155
|
"required": [
|
|
15299
16156
|
"id",
|
|
15300
|
-
"name"
|
|
15301
|
-
"prompt_injectable"
|
|
16157
|
+
"name"
|
|
15302
16158
|
],
|
|
15303
16159
|
"title": "AddKnowledgeBaseResponseModel"
|
|
15304
16160
|
},
|
|
@@ -15574,13 +16430,16 @@
|
|
|
15574
16430
|
"description": "If non-empty, the first message the agent will say. If empty, the agent waits for the user to start the discussion.",
|
|
15575
16431
|
"type": "string",
|
|
15576
16432
|
"default": "",
|
|
15577
|
-
"title": "First Message"
|
|
16433
|
+
"title": "First Message",
|
|
16434
|
+
"x-convai-client-override": true,
|
|
16435
|
+
"x-convai-language-override": true
|
|
15578
16436
|
},
|
|
15579
16437
|
"language": {
|
|
15580
16438
|
"description": "Language of the agent - used for ASR and TTS",
|
|
15581
16439
|
"type": "string",
|
|
15582
16440
|
"default": "en",
|
|
15583
|
-
"title": "Language"
|
|
16441
|
+
"title": "Language",
|
|
16442
|
+
"x-convai-client-override": true
|
|
15584
16443
|
},
|
|
15585
16444
|
"dynamic_variables": {
|
|
15586
16445
|
"description": "Configuration for dynamic variables",
|
|
@@ -15604,13 +16463,16 @@
|
|
|
15604
16463
|
"description": "If non-empty, the first message the agent will say. If empty, the agent waits for the user to start the discussion.",
|
|
15605
16464
|
"type": "string",
|
|
15606
16465
|
"default": "",
|
|
15607
|
-
"title": "First Message"
|
|
16466
|
+
"title": "First Message",
|
|
16467
|
+
"x-convai-client-override": true,
|
|
16468
|
+
"x-convai-language-override": true
|
|
15608
16469
|
},
|
|
15609
16470
|
"language": {
|
|
15610
16471
|
"description": "Language of the agent - used for ASR and TTS",
|
|
15611
16472
|
"type": "string",
|
|
15612
16473
|
"default": "en",
|
|
15613
|
-
"title": "Language"
|
|
16474
|
+
"title": "Language",
|
|
16475
|
+
"x-convai-client-override": true
|
|
15614
16476
|
},
|
|
15615
16477
|
"dynamic_variables": {
|
|
15616
16478
|
"description": "Configuration for dynamic variables",
|
|
@@ -15634,13 +16496,16 @@
|
|
|
15634
16496
|
"description": "If non-empty, the first message the agent will say. If empty, the agent waits for the user to start the discussion.",
|
|
15635
16497
|
"type": "string",
|
|
15636
16498
|
"default": "",
|
|
15637
|
-
"title": "First Message"
|
|
16499
|
+
"title": "First Message",
|
|
16500
|
+
"x-convai-client-override": true,
|
|
16501
|
+
"x-convai-language-override": true
|
|
15638
16502
|
},
|
|
15639
16503
|
"language": {
|
|
15640
16504
|
"description": "Language of the agent - used for ASR and TTS",
|
|
15641
16505
|
"type": "string",
|
|
15642
16506
|
"default": "en",
|
|
15643
|
-
"title": "Language"
|
|
16507
|
+
"title": "Language",
|
|
16508
|
+
"x-convai-client-override": true
|
|
15644
16509
|
},
|
|
15645
16510
|
"dynamic_variables": {
|
|
15646
16511
|
"description": "Configuration for dynamic variables",
|
|
@@ -15659,19 +16524,22 @@
|
|
|
15659
16524
|
"AgentConfigOverride": {
|
|
15660
16525
|
"type": "object",
|
|
15661
16526
|
"properties": {
|
|
15662
|
-
"
|
|
15663
|
-
"description": "
|
|
16527
|
+
"first_message": {
|
|
16528
|
+
"description": "If non-empty, the first message the agent will say. If empty, the agent waits for the user to start the discussion.",
|
|
15664
16529
|
"anyOf": [
|
|
15665
16530
|
{
|
|
15666
|
-
"
|
|
16531
|
+
"type": "string"
|
|
15667
16532
|
},
|
|
15668
16533
|
{
|
|
15669
16534
|
"type": "null"
|
|
15670
16535
|
}
|
|
15671
|
-
]
|
|
16536
|
+
],
|
|
16537
|
+
"title": "First Message",
|
|
16538
|
+
"x-convai-client-override": true,
|
|
16539
|
+
"x-convai-language-override": true
|
|
15672
16540
|
},
|
|
15673
|
-
"
|
|
15674
|
-
"description": "
|
|
16541
|
+
"language": {
|
|
16542
|
+
"description": "Language of the agent - used for ASR and TTS",
|
|
15675
16543
|
"anyOf": [
|
|
15676
16544
|
{
|
|
15677
16545
|
"type": "string"
|
|
@@ -15680,52 +16548,48 @@
|
|
|
15680
16548
|
"type": "null"
|
|
15681
16549
|
}
|
|
15682
16550
|
],
|
|
15683
|
-
"title": "
|
|
16551
|
+
"title": "Language",
|
|
16552
|
+
"x-convai-client-override": true
|
|
15684
16553
|
},
|
|
15685
|
-
"
|
|
15686
|
-
"description": "The
|
|
16554
|
+
"prompt": {
|
|
16555
|
+
"description": "The prompt for the agent",
|
|
15687
16556
|
"anyOf": [
|
|
15688
16557
|
{
|
|
15689
|
-
"
|
|
16558
|
+
"$ref": "#/components/schemas/PromptAgentOverride"
|
|
15690
16559
|
},
|
|
15691
16560
|
{
|
|
15692
16561
|
"type": "null"
|
|
15693
16562
|
}
|
|
15694
|
-
]
|
|
15695
|
-
"title": "Language"
|
|
16563
|
+
]
|
|
15696
16564
|
}
|
|
15697
16565
|
},
|
|
15698
16566
|
"example": {
|
|
15699
16567
|
"first_message": "Hello, how can I help you today?",
|
|
15700
|
-
"language": "en"
|
|
16568
|
+
"language": "en",
|
|
16569
|
+
"prompt": {
|
|
16570
|
+
"prompt": "You are a helpful assistant that can answer questions about the topic of the conversation."
|
|
16571
|
+
}
|
|
15701
16572
|
},
|
|
15702
16573
|
"title": "AgentConfigOverride"
|
|
15703
16574
|
},
|
|
15704
16575
|
"AgentConfigOverrideConfig": {
|
|
15705
16576
|
"type": "object",
|
|
15706
16577
|
"properties": {
|
|
15707
|
-
"prompt": {
|
|
15708
|
-
"description": "Overrides for the prompt configuration",
|
|
15709
|
-
"$ref": "#/components/schemas/PromptAgentOverrideConfig"
|
|
15710
|
-
},
|
|
15711
16578
|
"first_message": {
|
|
15712
|
-
"description": "Whether to allow overriding the
|
|
16579
|
+
"description": "Whether to allow overriding the first_message field.",
|
|
15713
16580
|
"type": "boolean",
|
|
15714
16581
|
"default": false,
|
|
15715
16582
|
"title": "First Message"
|
|
15716
16583
|
},
|
|
15717
16584
|
"language": {
|
|
15718
|
-
"description": "Whether to allow overriding the language",
|
|
16585
|
+
"description": "Whether to allow overriding the language field.",
|
|
15719
16586
|
"type": "boolean",
|
|
15720
16587
|
"default": false,
|
|
15721
16588
|
"title": "Language"
|
|
15722
|
-
}
|
|
15723
|
-
},
|
|
15724
|
-
"example": {
|
|
15725
|
-
"first_message": false,
|
|
15726
|
-
"language": false,
|
|
16589
|
+
},
|
|
15727
16590
|
"prompt": {
|
|
15728
|
-
"
|
|
16591
|
+
"description": "Configures overrides for nested fields.",
|
|
16592
|
+
"$ref": "#/components/schemas/PromptAgentOverrideConfig"
|
|
15729
16593
|
}
|
|
15730
16594
|
},
|
|
15731
16595
|
"title": "AgentConfigOverrideConfig"
|
|
@@ -15757,7 +16621,7 @@
|
|
|
15757
16621
|
},
|
|
15758
16622
|
"widget": {
|
|
15759
16623
|
"description": "Configuration for the widget",
|
|
15760
|
-
"$ref": "#/components/schemas/WidgetConfig"
|
|
16624
|
+
"$ref": "#/components/schemas/WidgetConfig-Input"
|
|
15761
16625
|
},
|
|
15762
16626
|
"data_collection": {
|
|
15763
16627
|
"description": "Data collection settings",
|
|
@@ -15799,7 +16663,7 @@
|
|
|
15799
16663
|
},
|
|
15800
16664
|
"widget": {
|
|
15801
16665
|
"description": "Configuration for the widget",
|
|
15802
|
-
"$ref": "#/components/schemas/WidgetConfig"
|
|
16666
|
+
"$ref": "#/components/schemas/WidgetConfig-Output"
|
|
15803
16667
|
},
|
|
15804
16668
|
"data_collection": {
|
|
15805
16669
|
"description": "Data collection settings",
|
|
@@ -16343,7 +17207,8 @@
|
|
|
16343
17207
|
"signed_url",
|
|
16344
17208
|
"shareable_link",
|
|
16345
17209
|
"livekit_token",
|
|
16346
|
-
"livekit_token_website"
|
|
17210
|
+
"livekit_token_website",
|
|
17211
|
+
"genesys_api_key"
|
|
16347
17212
|
],
|
|
16348
17213
|
"title": "AuthorizationMethod"
|
|
16349
17214
|
},
|
|
@@ -20103,6 +20968,12 @@
|
|
|
20103
20968
|
"https://account123.r2.cloudflarestorage.com/my-bucket/audio.mp3"
|
|
20104
20969
|
],
|
|
20105
20970
|
"title": "Cloud Storage Url"
|
|
20971
|
+
},
|
|
20972
|
+
"webhook": {
|
|
20973
|
+
"description": "Whether to send the transcription result to configured speech-to-text webhooks. If set the request will return early without the transcription, which will be delivered later via webhook. Webhooks can be created and assigned to a transcription task in webhook settings page in the UI.",
|
|
20974
|
+
"type": "boolean",
|
|
20975
|
+
"default": false,
|
|
20976
|
+
"title": "Webhook"
|
|
20106
20977
|
}
|
|
20107
20978
|
},
|
|
20108
20979
|
"required": [
|
|
@@ -20202,6 +21073,186 @@
|
|
|
20202
21073
|
],
|
|
20203
21074
|
"title": "Body_Submit_a_batch_call_request__v1_convai_batch_calling_submit_post"
|
|
20204
21075
|
},
|
|
21076
|
+
"Body_Text_to_dialogue__multi_voice__streaming_v1_text_to_dialogue_stream_post": {
|
|
21077
|
+
"type": "object",
|
|
21078
|
+
"properties": {
|
|
21079
|
+
"inputs": {
|
|
21080
|
+
"description": "A list of dialogue inputs, each containing text and a voice ID which will be converted into speech.",
|
|
21081
|
+
"type": "array",
|
|
21082
|
+
"items": {
|
|
21083
|
+
"$ref": "#/components/schemas/DialogueInput"
|
|
21084
|
+
},
|
|
21085
|
+
"examples": [
|
|
21086
|
+
[
|
|
21087
|
+
{
|
|
21088
|
+
"text": "Hello, how are you?",
|
|
21089
|
+
"voice_id": "bYTqZQo3Jz7LQtmGTgwi"
|
|
21090
|
+
},
|
|
21091
|
+
{
|
|
21092
|
+
"text": "I'm doing well, thank you!",
|
|
21093
|
+
"voice_id": "6lCwbsX1yVjD49QmpkTR"
|
|
21094
|
+
}
|
|
21095
|
+
]
|
|
21096
|
+
],
|
|
21097
|
+
"title": "Inputs"
|
|
21098
|
+
},
|
|
21099
|
+
"model_id": {
|
|
21100
|
+
"description": "Identifier of the model that will be used, you can query them using GET /v1/models. The model needs to have support for text to speech, you can check this using the can_do_text_to_speech property.",
|
|
21101
|
+
"type": "string",
|
|
21102
|
+
"default": "eleven_v3",
|
|
21103
|
+
"title": "Model Id"
|
|
21104
|
+
},
|
|
21105
|
+
"settings": {
|
|
21106
|
+
"description": "Settings controlling the dialogue generation.",
|
|
21107
|
+
"anyOf": [
|
|
21108
|
+
{
|
|
21109
|
+
"$ref": "#/components/schemas/ModelSettingsResponseModel"
|
|
21110
|
+
},
|
|
21111
|
+
{
|
|
21112
|
+
"type": "null"
|
|
21113
|
+
}
|
|
21114
|
+
],
|
|
21115
|
+
"examples": [
|
|
21116
|
+
{
|
|
21117
|
+
"stability": 0.5,
|
|
21118
|
+
"use_speaker_boost": true
|
|
21119
|
+
}
|
|
21120
|
+
]
|
|
21121
|
+
},
|
|
21122
|
+
"pronunciation_dictionary_locators": {
|
|
21123
|
+
"description": "A list of pronunciation dictionary locators (id, version_id) to be applied to the text. They will be applied in order. You may have up to 3 locators per request",
|
|
21124
|
+
"anyOf": [
|
|
21125
|
+
{
|
|
21126
|
+
"items": {
|
|
21127
|
+
"$ref": "#/components/schemas/PronunciationDictionaryVersionLocatorRequestModel"
|
|
21128
|
+
},
|
|
21129
|
+
"type": "array"
|
|
21130
|
+
},
|
|
21131
|
+
{
|
|
21132
|
+
"type": "null"
|
|
21133
|
+
}
|
|
21134
|
+
],
|
|
21135
|
+
"examples": [
|
|
21136
|
+
[
|
|
21137
|
+
{
|
|
21138
|
+
"pronunciation_dictionary_id": "test",
|
|
21139
|
+
"version_id": "id2"
|
|
21140
|
+
}
|
|
21141
|
+
]
|
|
21142
|
+
],
|
|
21143
|
+
"title": "Pronunciation Dictionary Locators"
|
|
21144
|
+
},
|
|
21145
|
+
"seed": {
|
|
21146
|
+
"description": "If specified, our system will make a best effort to sample deterministically, such that repeated requests with the same seed and parameters should return the same result. Determinism is not guaranteed. Must be integer between 0 and 4294967295.",
|
|
21147
|
+
"anyOf": [
|
|
21148
|
+
{
|
|
21149
|
+
"type": "integer"
|
|
21150
|
+
},
|
|
21151
|
+
{
|
|
21152
|
+
"type": "null"
|
|
21153
|
+
}
|
|
21154
|
+
],
|
|
21155
|
+
"examples": [
|
|
21156
|
+
12345
|
|
21157
|
+
],
|
|
21158
|
+
"title": "Seed"
|
|
21159
|
+
}
|
|
21160
|
+
},
|
|
21161
|
+
"required": [
|
|
21162
|
+
"inputs"
|
|
21163
|
+
],
|
|
21164
|
+
"title": "Body_Text_to_dialogue__multi_voice__streaming_v1_text_to_dialogue_stream_post"
|
|
21165
|
+
},
|
|
21166
|
+
"Body_Text_to_dialogue__multi_voice__v1_text_to_dialogue_post": {
|
|
21167
|
+
"type": "object",
|
|
21168
|
+
"properties": {
|
|
21169
|
+
"inputs": {
|
|
21170
|
+
"description": "A list of dialogue inputs, each containing text and a voice ID which will be converted into speech.",
|
|
21171
|
+
"type": "array",
|
|
21172
|
+
"items": {
|
|
21173
|
+
"$ref": "#/components/schemas/DialogueInput"
|
|
21174
|
+
},
|
|
21175
|
+
"examples": [
|
|
21176
|
+
[
|
|
21177
|
+
{
|
|
21178
|
+
"text": "Hello, how are you?",
|
|
21179
|
+
"voice_id": "bYTqZQo3Jz7LQtmGTgwi"
|
|
21180
|
+
},
|
|
21181
|
+
{
|
|
21182
|
+
"text": "I'm doing well, thank you!",
|
|
21183
|
+
"voice_id": "6lCwbsX1yVjD49QmpkTR"
|
|
21184
|
+
}
|
|
21185
|
+
]
|
|
21186
|
+
],
|
|
21187
|
+
"title": "Inputs"
|
|
21188
|
+
},
|
|
21189
|
+
"model_id": {
|
|
21190
|
+
"description": "Identifier of the model that will be used, you can query them using GET /v1/models. The model needs to have support for text to speech, you can check this using the can_do_text_to_speech property.",
|
|
21191
|
+
"type": "string",
|
|
21192
|
+
"default": "eleven_v3",
|
|
21193
|
+
"title": "Model Id"
|
|
21194
|
+
},
|
|
21195
|
+
"settings": {
|
|
21196
|
+
"description": "Settings controlling the dialogue generation.",
|
|
21197
|
+
"anyOf": [
|
|
21198
|
+
{
|
|
21199
|
+
"$ref": "#/components/schemas/ModelSettingsResponseModel"
|
|
21200
|
+
},
|
|
21201
|
+
{
|
|
21202
|
+
"type": "null"
|
|
21203
|
+
}
|
|
21204
|
+
],
|
|
21205
|
+
"examples": [
|
|
21206
|
+
{
|
|
21207
|
+
"stability": 0.5,
|
|
21208
|
+
"use_speaker_boost": true
|
|
21209
|
+
}
|
|
21210
|
+
]
|
|
21211
|
+
},
|
|
21212
|
+
"pronunciation_dictionary_locators": {
|
|
21213
|
+
"description": "A list of pronunciation dictionary locators (id, version_id) to be applied to the text. They will be applied in order. You may have up to 3 locators per request",
|
|
21214
|
+
"anyOf": [
|
|
21215
|
+
{
|
|
21216
|
+
"items": {
|
|
21217
|
+
"$ref": "#/components/schemas/PronunciationDictionaryVersionLocatorRequestModel"
|
|
21218
|
+
},
|
|
21219
|
+
"type": "array"
|
|
21220
|
+
},
|
|
21221
|
+
{
|
|
21222
|
+
"type": "null"
|
|
21223
|
+
}
|
|
21224
|
+
],
|
|
21225
|
+
"examples": [
|
|
21226
|
+
[
|
|
21227
|
+
{
|
|
21228
|
+
"pronunciation_dictionary_id": "test",
|
|
21229
|
+
"version_id": "id2"
|
|
21230
|
+
}
|
|
21231
|
+
]
|
|
21232
|
+
],
|
|
21233
|
+
"title": "Pronunciation Dictionary Locators"
|
|
21234
|
+
},
|
|
21235
|
+
"seed": {
|
|
21236
|
+
"description": "If specified, our system will make a best effort to sample deterministically, such that repeated requests with the same seed and parameters should return the same result. Determinism is not guaranteed. Must be integer between 0 and 4294967295.",
|
|
21237
|
+
"anyOf": [
|
|
21238
|
+
{
|
|
21239
|
+
"type": "integer"
|
|
21240
|
+
},
|
|
21241
|
+
{
|
|
21242
|
+
"type": "null"
|
|
21243
|
+
}
|
|
21244
|
+
],
|
|
21245
|
+
"examples": [
|
|
21246
|
+
12345
|
|
21247
|
+
],
|
|
21248
|
+
"title": "Seed"
|
|
21249
|
+
}
|
|
21250
|
+
},
|
|
21251
|
+
"required": [
|
|
21252
|
+
"inputs"
|
|
21253
|
+
],
|
|
21254
|
+
"title": "Body_Text_to_dialogue__multi_voice__v1_text_to_dialogue_post"
|
|
21255
|
+
},
|
|
20205
21256
|
"Body_Text_to_speech_streaming_v1_text_to_speech__voice_id__stream_post": {
|
|
20206
21257
|
"type": "object",
|
|
20207
21258
|
"properties": {
|
|
@@ -22055,7 +23106,8 @@
|
|
|
22055
23106
|
"client_tool_call",
|
|
22056
23107
|
"vad_score",
|
|
22057
23108
|
"internal_turn_probability",
|
|
22058
|
-
"internal_tentative_agent_response"
|
|
23109
|
+
"internal_tentative_agent_response",
|
|
23110
|
+
"internal_native_mcp_tool_call"
|
|
22059
23111
|
],
|
|
22060
23112
|
"title": "ClientEvent"
|
|
22061
23113
|
},
|
|
@@ -22376,7 +23428,8 @@
|
|
|
22376
23428
|
"description": "If enabled audio will not be processed and only text will be used, use to avoid audio pricing.",
|
|
22377
23429
|
"type": "boolean",
|
|
22378
23430
|
"default": false,
|
|
22379
|
-
"title": "Text Only"
|
|
23431
|
+
"title": "Text Only",
|
|
23432
|
+
"x-convai-client-override": true
|
|
22380
23433
|
},
|
|
22381
23434
|
"max_duration_seconds": {
|
|
22382
23435
|
"description": "The maximum duration of a conversation in seconds",
|
|
@@ -22405,33 +23458,33 @@
|
|
|
22405
23458
|
"ConversationConfigClientOverride-Input": {
|
|
22406
23459
|
"type": "object",
|
|
22407
23460
|
"properties": {
|
|
22408
|
-
"
|
|
22409
|
-
"description": "
|
|
23461
|
+
"tts": {
|
|
23462
|
+
"description": "Configuration for conversational text to speech",
|
|
22410
23463
|
"anyOf": [
|
|
22411
23464
|
{
|
|
22412
|
-
"$ref": "#/components/schemas/
|
|
23465
|
+
"$ref": "#/components/schemas/TTSConversationalConfigOverride"
|
|
22413
23466
|
},
|
|
22414
23467
|
{
|
|
22415
23468
|
"type": "null"
|
|
22416
23469
|
}
|
|
22417
23470
|
]
|
|
22418
23471
|
},
|
|
22419
|
-
"
|
|
22420
|
-
"description": "
|
|
23472
|
+
"conversation": {
|
|
23473
|
+
"description": "Configuration for conversational events",
|
|
22421
23474
|
"anyOf": [
|
|
22422
23475
|
{
|
|
22423
|
-
"$ref": "#/components/schemas/
|
|
23476
|
+
"$ref": "#/components/schemas/ConversationConfigOverride"
|
|
22424
23477
|
},
|
|
22425
23478
|
{
|
|
22426
23479
|
"type": "null"
|
|
22427
23480
|
}
|
|
22428
23481
|
]
|
|
22429
23482
|
},
|
|
22430
|
-
"
|
|
22431
|
-
"description": "
|
|
23483
|
+
"agent": {
|
|
23484
|
+
"description": "Agent specific configuration",
|
|
22432
23485
|
"anyOf": [
|
|
22433
23486
|
{
|
|
22434
|
-
"$ref": "#/components/schemas/
|
|
23487
|
+
"$ref": "#/components/schemas/AgentConfigOverride"
|
|
22435
23488
|
},
|
|
22436
23489
|
{
|
|
22437
23490
|
"type": "null"
|
|
@@ -22439,38 +23492,50 @@
|
|
|
22439
23492
|
]
|
|
22440
23493
|
}
|
|
22441
23494
|
},
|
|
23495
|
+
"example": {
|
|
23496
|
+
"agent": {
|
|
23497
|
+
"first_message": "Hello, how can I help you today?",
|
|
23498
|
+
"language": "en",
|
|
23499
|
+
"prompt": {
|
|
23500
|
+
"prompt": "You are a helpful assistant that can answer questions about the topic of the conversation."
|
|
23501
|
+
}
|
|
23502
|
+
},
|
|
23503
|
+
"tts": {
|
|
23504
|
+
"voice_id": "cjVigY5qzO86Huf0OWal"
|
|
23505
|
+
}
|
|
23506
|
+
},
|
|
22442
23507
|
"title": "ConversationConfigClientOverride"
|
|
22443
23508
|
},
|
|
22444
23509
|
"ConversationConfigClientOverride-Output": {
|
|
22445
23510
|
"type": "object",
|
|
22446
23511
|
"properties": {
|
|
22447
|
-
"
|
|
22448
|
-
"description": "
|
|
23512
|
+
"tts": {
|
|
23513
|
+
"description": "Configuration for conversational text to speech",
|
|
22449
23514
|
"anyOf": [
|
|
22450
23515
|
{
|
|
22451
|
-
"$ref": "#/components/schemas/
|
|
23516
|
+
"$ref": "#/components/schemas/TTSConversationalConfigOverride"
|
|
22452
23517
|
},
|
|
22453
23518
|
{
|
|
22454
23519
|
"type": "null"
|
|
22455
23520
|
}
|
|
22456
23521
|
]
|
|
22457
23522
|
},
|
|
22458
|
-
"
|
|
22459
|
-
"description": "
|
|
23523
|
+
"conversation": {
|
|
23524
|
+
"description": "Configuration for conversational events",
|
|
22460
23525
|
"anyOf": [
|
|
22461
23526
|
{
|
|
22462
|
-
"$ref": "#/components/schemas/
|
|
23527
|
+
"$ref": "#/components/schemas/ConversationConfigOverride"
|
|
22463
23528
|
},
|
|
22464
23529
|
{
|
|
22465
23530
|
"type": "null"
|
|
22466
23531
|
}
|
|
22467
23532
|
]
|
|
22468
23533
|
},
|
|
22469
|
-
"
|
|
22470
|
-
"description": "
|
|
23534
|
+
"agent": {
|
|
23535
|
+
"description": "Agent specific configuration",
|
|
22471
23536
|
"anyOf": [
|
|
22472
23537
|
{
|
|
22473
|
-
"$ref": "#/components/schemas/
|
|
23538
|
+
"$ref": "#/components/schemas/AgentConfigOverride"
|
|
22474
23539
|
},
|
|
22475
23540
|
{
|
|
22476
23541
|
"type": "null"
|
|
@@ -22478,22 +23543,34 @@
|
|
|
22478
23543
|
]
|
|
22479
23544
|
}
|
|
22480
23545
|
},
|
|
23546
|
+
"example": {
|
|
23547
|
+
"agent": {
|
|
23548
|
+
"first_message": "Hello, how can I help you today?",
|
|
23549
|
+
"language": "en",
|
|
23550
|
+
"prompt": {
|
|
23551
|
+
"prompt": "You are a helpful assistant that can answer questions about the topic of the conversation."
|
|
23552
|
+
}
|
|
23553
|
+
},
|
|
23554
|
+
"tts": {
|
|
23555
|
+
"voice_id": "cjVigY5qzO86Huf0OWal"
|
|
23556
|
+
}
|
|
23557
|
+
},
|
|
22481
23558
|
"title": "ConversationConfigClientOverride"
|
|
22482
23559
|
},
|
|
22483
23560
|
"ConversationConfigClientOverrideConfig-Input": {
|
|
22484
23561
|
"type": "object",
|
|
22485
23562
|
"properties": {
|
|
22486
|
-
"agent": {
|
|
22487
|
-
"description": "Overrides for the agent configuration",
|
|
22488
|
-
"$ref": "#/components/schemas/AgentConfigOverrideConfig"
|
|
22489
|
-
},
|
|
22490
23563
|
"tts": {
|
|
22491
|
-
"description": "
|
|
23564
|
+
"description": "Configures overrides for nested fields.",
|
|
22492
23565
|
"$ref": "#/components/schemas/TTSConversationalConfigOverrideConfig"
|
|
22493
23566
|
},
|
|
22494
23567
|
"conversation": {
|
|
22495
|
-
"description": "
|
|
23568
|
+
"description": "Configures overrides for nested fields.",
|
|
22496
23569
|
"$ref": "#/components/schemas/ConversationConfigOverrideConfig"
|
|
23570
|
+
},
|
|
23571
|
+
"agent": {
|
|
23572
|
+
"description": "Configures overrides for nested fields.",
|
|
23573
|
+
"$ref": "#/components/schemas/AgentConfigOverrideConfig"
|
|
22497
23574
|
}
|
|
22498
23575
|
},
|
|
22499
23576
|
"title": "ConversationConfigClientOverrideConfig"
|
|
@@ -22501,17 +23578,17 @@
|
|
|
22501
23578
|
"ConversationConfigClientOverrideConfig-Output": {
|
|
22502
23579
|
"type": "object",
|
|
22503
23580
|
"properties": {
|
|
22504
|
-
"agent": {
|
|
22505
|
-
"description": "Overrides for the agent configuration",
|
|
22506
|
-
"$ref": "#/components/schemas/AgentConfigOverrideConfig"
|
|
22507
|
-
},
|
|
22508
23581
|
"tts": {
|
|
22509
|
-
"description": "
|
|
23582
|
+
"description": "Configures overrides for nested fields.",
|
|
22510
23583
|
"$ref": "#/components/schemas/TTSConversationalConfigOverrideConfig"
|
|
22511
23584
|
},
|
|
22512
23585
|
"conversation": {
|
|
22513
|
-
"description": "
|
|
23586
|
+
"description": "Configures overrides for nested fields.",
|
|
22514
23587
|
"$ref": "#/components/schemas/ConversationConfigOverrideConfig"
|
|
23588
|
+
},
|
|
23589
|
+
"agent": {
|
|
23590
|
+
"description": "Configures overrides for nested fields.",
|
|
23591
|
+
"$ref": "#/components/schemas/AgentConfigOverrideConfig"
|
|
22515
23592
|
}
|
|
22516
23593
|
},
|
|
22517
23594
|
"title": "ConversationConfigClientOverrideConfig"
|
|
@@ -22520,6 +23597,7 @@
|
|
|
22520
23597
|
"type": "object",
|
|
22521
23598
|
"properties": {
|
|
22522
23599
|
"text_only": {
|
|
23600
|
+
"description": "If enabled audio will not be processed and only text will be used, use to avoid audio pricing.",
|
|
22523
23601
|
"anyOf": [
|
|
22524
23602
|
{
|
|
22525
23603
|
"type": "boolean"
|
|
@@ -22528,7 +23606,8 @@
|
|
|
22528
23606
|
"type": "null"
|
|
22529
23607
|
}
|
|
22530
23608
|
],
|
|
22531
|
-
"title": "Text Only"
|
|
23609
|
+
"title": "Text Only",
|
|
23610
|
+
"x-convai-client-override": true
|
|
22532
23611
|
}
|
|
22533
23612
|
},
|
|
22534
23613
|
"title": "ConversationConfigOverride"
|
|
@@ -22537,15 +23616,12 @@
|
|
|
22537
23616
|
"type": "object",
|
|
22538
23617
|
"properties": {
|
|
22539
23618
|
"text_only": {
|
|
22540
|
-
"description": "Whether to allow overriding the
|
|
23619
|
+
"description": "Whether to allow overriding the text_only field.",
|
|
22541
23620
|
"type": "boolean",
|
|
22542
23621
|
"default": false,
|
|
22543
23622
|
"title": "Text Only"
|
|
22544
23623
|
}
|
|
22545
23624
|
},
|
|
22546
|
-
"example": {
|
|
22547
|
-
"text_only": false
|
|
22548
|
-
},
|
|
22549
23625
|
"title": "ConversationConfigOverrideConfig"
|
|
22550
23626
|
},
|
|
22551
23627
|
"ConversationDeletionSettings": {
|
|
@@ -22845,6 +23921,14 @@
|
|
|
22845
23921
|
"type": "null"
|
|
22846
23922
|
}
|
|
22847
23923
|
]
|
|
23924
|
+
},
|
|
23925
|
+
"text_only": {
|
|
23926
|
+
"type": "boolean",
|
|
23927
|
+
"default": false,
|
|
23928
|
+
"title": "Text Only"
|
|
23929
|
+
},
|
|
23930
|
+
"features_usage": {
|
|
23931
|
+
"$ref": "#/components/schemas/FeaturesUsageCommonModel"
|
|
22848
23932
|
}
|
|
22849
23933
|
},
|
|
22850
23934
|
"required": [
|
|
@@ -22971,21 +24055,6 @@
|
|
|
22971
24055
|
],
|
|
22972
24056
|
"title": "Llm Override"
|
|
22973
24057
|
},
|
|
22974
|
-
"source_medium": {
|
|
22975
|
-
"anyOf": [
|
|
22976
|
-
{
|
|
22977
|
-
"type": "string",
|
|
22978
|
-
"enum": [
|
|
22979
|
-
"audio",
|
|
22980
|
-
"text"
|
|
22981
|
-
]
|
|
22982
|
-
},
|
|
22983
|
-
{
|
|
22984
|
-
"type": "null"
|
|
22985
|
-
}
|
|
22986
|
-
],
|
|
22987
|
-
"title": "Source Medium"
|
|
22988
|
-
},
|
|
22989
24058
|
"time_in_call_secs": {
|
|
22990
24059
|
"type": "integer",
|
|
22991
24060
|
"title": "Time In Call Secs"
|
|
@@ -23035,6 +24104,21 @@
|
|
|
23035
24104
|
}
|
|
23036
24105
|
],
|
|
23037
24106
|
"title": "Original Message"
|
|
24107
|
+
},
|
|
24108
|
+
"source_medium": {
|
|
24109
|
+
"anyOf": [
|
|
24110
|
+
{
|
|
24111
|
+
"type": "string",
|
|
24112
|
+
"enum": [
|
|
24113
|
+
"audio",
|
|
24114
|
+
"text"
|
|
24115
|
+
]
|
|
24116
|
+
},
|
|
24117
|
+
{
|
|
24118
|
+
"type": "null"
|
|
24119
|
+
}
|
|
24120
|
+
],
|
|
24121
|
+
"title": "Source Medium"
|
|
23038
24122
|
}
|
|
23039
24123
|
},
|
|
23040
24124
|
"required": [
|
|
@@ -23100,21 +24184,6 @@
|
|
|
23100
24184
|
],
|
|
23101
24185
|
"title": "Llm Override"
|
|
23102
24186
|
},
|
|
23103
|
-
"source_medium": {
|
|
23104
|
-
"anyOf": [
|
|
23105
|
-
{
|
|
23106
|
-
"type": "string",
|
|
23107
|
-
"enum": [
|
|
23108
|
-
"audio",
|
|
23109
|
-
"text"
|
|
23110
|
-
]
|
|
23111
|
-
},
|
|
23112
|
-
{
|
|
23113
|
-
"type": "null"
|
|
23114
|
-
}
|
|
23115
|
-
],
|
|
23116
|
-
"title": "Source Medium"
|
|
23117
|
-
},
|
|
23118
24187
|
"time_in_call_secs": {
|
|
23119
24188
|
"type": "integer",
|
|
23120
24189
|
"title": "Time In Call Secs"
|
|
@@ -23164,6 +24233,21 @@
|
|
|
23164
24233
|
}
|
|
23165
24234
|
],
|
|
23166
24235
|
"title": "Original Message"
|
|
24236
|
+
},
|
|
24237
|
+
"source_medium": {
|
|
24238
|
+
"anyOf": [
|
|
24239
|
+
{
|
|
24240
|
+
"type": "string",
|
|
24241
|
+
"enum": [
|
|
24242
|
+
"audio",
|
|
24243
|
+
"text"
|
|
24244
|
+
]
|
|
24245
|
+
},
|
|
24246
|
+
{
|
|
24247
|
+
"type": "null"
|
|
24248
|
+
}
|
|
24249
|
+
],
|
|
24250
|
+
"title": "Source Medium"
|
|
23167
24251
|
}
|
|
23168
24252
|
},
|
|
23169
24253
|
"required": [
|
|
@@ -23795,7 +24879,7 @@
|
|
|
23795
24879
|
},
|
|
23796
24880
|
"tts": {
|
|
23797
24881
|
"description": "Configuration for conversational text to speech",
|
|
23798
|
-
"$ref": "#/components/schemas/TTSConversationalConfig"
|
|
24882
|
+
"$ref": "#/components/schemas/TTSConversationalConfig-Input"
|
|
23799
24883
|
},
|
|
23800
24884
|
"conversation": {
|
|
23801
24885
|
"description": "Configuration for conversational events",
|
|
@@ -23829,7 +24913,7 @@
|
|
|
23829
24913
|
},
|
|
23830
24914
|
"tts": {
|
|
23831
24915
|
"description": "Configuration for conversational text to speech",
|
|
23832
|
-
"$ref": "#/components/schemas/TTSConversationalConfig"
|
|
24916
|
+
"$ref": "#/components/schemas/TTSConversationalConfig-Output"
|
|
23833
24917
|
},
|
|
23834
24918
|
"conversation": {
|
|
23835
24919
|
"description": "Configuration for conversational events",
|
|
@@ -24074,6 +25158,24 @@
|
|
|
24074
25158
|
"type": "null"
|
|
24075
25159
|
}
|
|
24076
25160
|
]
|
|
25161
|
+
},
|
|
25162
|
+
"request_headers": {
|
|
25163
|
+
"description": "Headers that should be included in the request",
|
|
25164
|
+
"type": "object",
|
|
25165
|
+
"additionalProperties": {
|
|
25166
|
+
"anyOf": [
|
|
25167
|
+
{
|
|
25168
|
+
"type": "string"
|
|
25169
|
+
},
|
|
25170
|
+
{
|
|
25171
|
+
"$ref": "#/components/schemas/ConvAISecretLocator"
|
|
25172
|
+
},
|
|
25173
|
+
{
|
|
25174
|
+
"$ref": "#/components/schemas/ConvAIDynamicVariable"
|
|
25175
|
+
}
|
|
25176
|
+
]
|
|
25177
|
+
},
|
|
25178
|
+
"title": "Request Headers"
|
|
24077
25179
|
}
|
|
24078
25180
|
},
|
|
24079
25181
|
"required": [
|
|
@@ -24540,6 +25642,52 @@
|
|
|
24540
25642
|
},
|
|
24541
25643
|
"title": "DependentUnknownToolIdentifier"
|
|
24542
25644
|
},
|
|
25645
|
+
"DialogueInput": {
|
|
25646
|
+
"type": "object",
|
|
25647
|
+
"properties": {
|
|
25648
|
+
"text": {
|
|
25649
|
+
"description": "The text to be converted into speech.",
|
|
25650
|
+
"type": "string",
|
|
25651
|
+
"title": "Text"
|
|
25652
|
+
},
|
|
25653
|
+
"voice_id": {
|
|
25654
|
+
"description": "The ID of the voice to be used for the generation.",
|
|
25655
|
+
"type": "string",
|
|
25656
|
+
"title": "Voice Id"
|
|
25657
|
+
}
|
|
25658
|
+
},
|
|
25659
|
+
"required": [
|
|
25660
|
+
"text",
|
|
25661
|
+
"voice_id"
|
|
25662
|
+
],
|
|
25663
|
+
"title": "DialogueInput"
|
|
25664
|
+
},
|
|
25665
|
+
"DialogueInputResponseModel": {
|
|
25666
|
+
"type": "object",
|
|
25667
|
+
"properties": {
|
|
25668
|
+
"text": {
|
|
25669
|
+
"description": "The text of the dialogue input line.",
|
|
25670
|
+
"type": "string",
|
|
25671
|
+
"title": "Text"
|
|
25672
|
+
},
|
|
25673
|
+
"voice_id": {
|
|
25674
|
+
"description": "The ID of the voice used for this dialogue input line.",
|
|
25675
|
+
"type": "string",
|
|
25676
|
+
"title": "Voice Id"
|
|
25677
|
+
},
|
|
25678
|
+
"voice_name": {
|
|
25679
|
+
"description": "The name of the voice used for this dialogue input line.",
|
|
25680
|
+
"type": "string",
|
|
25681
|
+
"title": "Voice Name"
|
|
25682
|
+
}
|
|
25683
|
+
},
|
|
25684
|
+
"required": [
|
|
25685
|
+
"text",
|
|
25686
|
+
"voice_id",
|
|
25687
|
+
"voice_name"
|
|
25688
|
+
],
|
|
25689
|
+
"title": "DialogueInputResponseModel"
|
|
25690
|
+
},
|
|
24543
25691
|
"DoDubbingResponseModel": {
|
|
24544
25692
|
"type": "object",
|
|
24545
25693
|
"properties": {
|
|
@@ -24988,6 +26136,7 @@
|
|
|
24988
26136
|
"EmbedVariant": {
|
|
24989
26137
|
"type": "string",
|
|
24990
26138
|
"enum": [
|
|
26139
|
+
"tiny",
|
|
24991
26140
|
"compact",
|
|
24992
26141
|
"full",
|
|
24993
26142
|
"expandable"
|
|
@@ -25194,18 +26343,7 @@
|
|
|
25194
26343
|
},
|
|
25195
26344
|
"status": {
|
|
25196
26345
|
"description": "The status of the user's subscription.",
|
|
25197
|
-
"
|
|
25198
|
-
"enum": [
|
|
25199
|
-
"trialing",
|
|
25200
|
-
"active",
|
|
25201
|
-
"incomplete",
|
|
25202
|
-
"incomplete_expired",
|
|
25203
|
-
"past_due",
|
|
25204
|
-
"canceled",
|
|
25205
|
-
"unpaid",
|
|
25206
|
-
"free"
|
|
25207
|
-
],
|
|
25208
|
-
"title": "Status"
|
|
26346
|
+
"$ref": "#/components/schemas/SubscriptionStatusType"
|
|
25209
26347
|
},
|
|
25210
26348
|
"billing_period": {
|
|
25211
26349
|
"description": "The billing period of the user's subscription.",
|
|
@@ -25283,6 +26421,50 @@
|
|
|
25283
26421
|
],
|
|
25284
26422
|
"title": "ExtendedSubscriptionResponseModel"
|
|
25285
26423
|
},
|
|
26424
|
+
"FeatureStatusCommonModel": {
|
|
26425
|
+
"type": "object",
|
|
26426
|
+
"properties": {
|
|
26427
|
+
"enabled": {
|
|
26428
|
+
"type": "boolean",
|
|
26429
|
+
"default": false,
|
|
26430
|
+
"title": "Enabled"
|
|
26431
|
+
},
|
|
26432
|
+
"used": {
|
|
26433
|
+
"type": "boolean",
|
|
26434
|
+
"default": false,
|
|
26435
|
+
"title": "Used"
|
|
26436
|
+
}
|
|
26437
|
+
},
|
|
26438
|
+
"title": "FeatureStatusCommonModel"
|
|
26439
|
+
},
|
|
26440
|
+
"FeaturesUsageCommonModel": {
|
|
26441
|
+
"type": "object",
|
|
26442
|
+
"properties": {
|
|
26443
|
+
"language_detection": {
|
|
26444
|
+
"$ref": "#/components/schemas/FeatureStatusCommonModel"
|
|
26445
|
+
},
|
|
26446
|
+
"transfer_to_agent": {
|
|
26447
|
+
"$ref": "#/components/schemas/FeatureStatusCommonModel"
|
|
26448
|
+
},
|
|
26449
|
+
"transfer_to_number": {
|
|
26450
|
+
"$ref": "#/components/schemas/FeatureStatusCommonModel"
|
|
26451
|
+
},
|
|
26452
|
+
"multivoice": {
|
|
26453
|
+
"$ref": "#/components/schemas/FeatureStatusCommonModel"
|
|
26454
|
+
},
|
|
26455
|
+
"pii_zrm_workspace": {
|
|
26456
|
+
"type": "boolean",
|
|
26457
|
+
"default": false,
|
|
26458
|
+
"title": "Pii Zrm Workspace"
|
|
26459
|
+
},
|
|
26460
|
+
"pii_zrm_agent": {
|
|
26461
|
+
"type": "boolean",
|
|
26462
|
+
"default": false,
|
|
26463
|
+
"title": "Pii Zrm Agent"
|
|
26464
|
+
}
|
|
26465
|
+
},
|
|
26466
|
+
"title": "FeaturesUsageCommonModel"
|
|
26467
|
+
},
|
|
25286
26468
|
"FeedbackResponseModel": {
|
|
25287
26469
|
"type": "object",
|
|
25288
26470
|
"properties": {
|
|
@@ -26091,9 +27273,12 @@
|
|
|
26091
27273
|
"metadata": {
|
|
26092
27274
|
"$ref": "#/components/schemas/KnowledgeBaseDocumentMetadataResponseModel"
|
|
26093
27275
|
},
|
|
26094
|
-
"
|
|
26095
|
-
"type": "
|
|
26096
|
-
"
|
|
27276
|
+
"supported_usages": {
|
|
27277
|
+
"type": "array",
|
|
27278
|
+
"items": {
|
|
27279
|
+
"$ref": "#/components/schemas/DocumentUsageModeEnum"
|
|
27280
|
+
},
|
|
27281
|
+
"title": "Supported Usages"
|
|
26097
27282
|
},
|
|
26098
27283
|
"access_info": {
|
|
26099
27284
|
"$ref": "#/components/schemas/ResourceAccessInfo"
|
|
@@ -26112,7 +27297,7 @@
|
|
|
26112
27297
|
"id",
|
|
26113
27298
|
"name",
|
|
26114
27299
|
"metadata",
|
|
26115
|
-
"
|
|
27300
|
+
"supported_usages",
|
|
26116
27301
|
"access_info",
|
|
26117
27302
|
"extracted_inner_html",
|
|
26118
27303
|
"type"
|
|
@@ -26183,9 +27368,12 @@
|
|
|
26183
27368
|
"metadata": {
|
|
26184
27369
|
"$ref": "#/components/schemas/KnowledgeBaseDocumentMetadataResponseModel"
|
|
26185
27370
|
},
|
|
26186
|
-
"
|
|
26187
|
-
"type": "
|
|
26188
|
-
"
|
|
27371
|
+
"supported_usages": {
|
|
27372
|
+
"type": "array",
|
|
27373
|
+
"items": {
|
|
27374
|
+
"$ref": "#/components/schemas/DocumentUsageModeEnum"
|
|
27375
|
+
},
|
|
27376
|
+
"title": "Supported Usages"
|
|
26189
27377
|
},
|
|
26190
27378
|
"access_info": {
|
|
26191
27379
|
"$ref": "#/components/schemas/ResourceAccessInfo"
|
|
@@ -26221,7 +27409,7 @@
|
|
|
26221
27409
|
"id",
|
|
26222
27410
|
"name",
|
|
26223
27411
|
"metadata",
|
|
26224
|
-
"
|
|
27412
|
+
"supported_usages",
|
|
26225
27413
|
"access_info",
|
|
26226
27414
|
"dependent_agents",
|
|
26227
27415
|
"type"
|
|
@@ -26242,9 +27430,12 @@
|
|
|
26242
27430
|
"metadata": {
|
|
26243
27431
|
"$ref": "#/components/schemas/KnowledgeBaseDocumentMetadataResponseModel"
|
|
26244
27432
|
},
|
|
26245
|
-
"
|
|
26246
|
-
"type": "
|
|
26247
|
-
"
|
|
27433
|
+
"supported_usages": {
|
|
27434
|
+
"type": "array",
|
|
27435
|
+
"items": {
|
|
27436
|
+
"$ref": "#/components/schemas/DocumentUsageModeEnum"
|
|
27437
|
+
},
|
|
27438
|
+
"title": "Supported Usages"
|
|
26248
27439
|
},
|
|
26249
27440
|
"access_info": {
|
|
26250
27441
|
"$ref": "#/components/schemas/ResourceAccessInfo"
|
|
@@ -26280,7 +27471,7 @@
|
|
|
26280
27471
|
"id",
|
|
26281
27472
|
"name",
|
|
26282
27473
|
"metadata",
|
|
26283
|
-
"
|
|
27474
|
+
"supported_usages",
|
|
26284
27475
|
"access_info",
|
|
26285
27476
|
"dependent_agents",
|
|
26286
27477
|
"type"
|
|
@@ -26301,9 +27492,12 @@
|
|
|
26301
27492
|
"metadata": {
|
|
26302
27493
|
"$ref": "#/components/schemas/KnowledgeBaseDocumentMetadataResponseModel"
|
|
26303
27494
|
},
|
|
26304
|
-
"
|
|
26305
|
-
"type": "
|
|
26306
|
-
"
|
|
27495
|
+
"supported_usages": {
|
|
27496
|
+
"type": "array",
|
|
27497
|
+
"items": {
|
|
27498
|
+
"$ref": "#/components/schemas/DocumentUsageModeEnum"
|
|
27499
|
+
},
|
|
27500
|
+
"title": "Supported Usages"
|
|
26307
27501
|
},
|
|
26308
27502
|
"access_info": {
|
|
26309
27503
|
"$ref": "#/components/schemas/ResourceAccessInfo"
|
|
@@ -26343,7 +27537,7 @@
|
|
|
26343
27537
|
"id",
|
|
26344
27538
|
"name",
|
|
26345
27539
|
"metadata",
|
|
26346
|
-
"
|
|
27540
|
+
"supported_usages",
|
|
26347
27541
|
"access_info",
|
|
26348
27542
|
"dependent_agents",
|
|
26349
27543
|
"type",
|
|
@@ -26365,9 +27559,12 @@
|
|
|
26365
27559
|
"metadata": {
|
|
26366
27560
|
"$ref": "#/components/schemas/KnowledgeBaseDocumentMetadataResponseModel"
|
|
26367
27561
|
},
|
|
26368
|
-
"
|
|
26369
|
-
"type": "
|
|
26370
|
-
"
|
|
27562
|
+
"supported_usages": {
|
|
27563
|
+
"type": "array",
|
|
27564
|
+
"items": {
|
|
27565
|
+
"$ref": "#/components/schemas/DocumentUsageModeEnum"
|
|
27566
|
+
},
|
|
27567
|
+
"title": "Supported Usages"
|
|
26371
27568
|
},
|
|
26372
27569
|
"access_info": {
|
|
26373
27570
|
"$ref": "#/components/schemas/ResourceAccessInfo"
|
|
@@ -26386,7 +27583,7 @@
|
|
|
26386
27583
|
"id",
|
|
26387
27584
|
"name",
|
|
26388
27585
|
"metadata",
|
|
26389
|
-
"
|
|
27586
|
+
"supported_usages",
|
|
26390
27587
|
"access_info",
|
|
26391
27588
|
"extracted_inner_html",
|
|
26392
27589
|
"type"
|
|
@@ -26407,9 +27604,12 @@
|
|
|
26407
27604
|
"metadata": {
|
|
26408
27605
|
"$ref": "#/components/schemas/KnowledgeBaseDocumentMetadataResponseModel"
|
|
26409
27606
|
},
|
|
26410
|
-
"
|
|
26411
|
-
"type": "
|
|
26412
|
-
"
|
|
27607
|
+
"supported_usages": {
|
|
27608
|
+
"type": "array",
|
|
27609
|
+
"items": {
|
|
27610
|
+
"$ref": "#/components/schemas/DocumentUsageModeEnum"
|
|
27611
|
+
},
|
|
27612
|
+
"title": "Supported Usages"
|
|
26413
27613
|
},
|
|
26414
27614
|
"access_info": {
|
|
26415
27615
|
"$ref": "#/components/schemas/ResourceAccessInfo"
|
|
@@ -26432,7 +27632,7 @@
|
|
|
26432
27632
|
"id",
|
|
26433
27633
|
"name",
|
|
26434
27634
|
"metadata",
|
|
26435
|
-
"
|
|
27635
|
+
"supported_usages",
|
|
26436
27636
|
"access_info",
|
|
26437
27637
|
"extracted_inner_html",
|
|
26438
27638
|
"type",
|
|
@@ -26795,6 +27995,39 @@
|
|
|
26795
27995
|
],
|
|
26796
27996
|
"title": "GetPronunciationDictionaryMetadataResponseModel"
|
|
26797
27997
|
},
|
|
27998
|
+
"GetSharedSoundGenerationsResponseModel": {
|
|
27999
|
+
"type": "object",
|
|
28000
|
+
"properties": {
|
|
28001
|
+
"shared_sound_generations": {
|
|
28002
|
+
"type": "array",
|
|
28003
|
+
"items": {
|
|
28004
|
+
"$ref": "#/components/schemas/SharedSoundGenerationResponseModel"
|
|
28005
|
+
},
|
|
28006
|
+
"title": "Shared Sound Generations"
|
|
28007
|
+
},
|
|
28008
|
+
"last_sort_id": {
|
|
28009
|
+
"anyOf": [
|
|
28010
|
+
{
|
|
28011
|
+
"type": "string"
|
|
28012
|
+
},
|
|
28013
|
+
{
|
|
28014
|
+
"type": "null"
|
|
28015
|
+
}
|
|
28016
|
+
],
|
|
28017
|
+
"title": "Last Sort Id"
|
|
28018
|
+
},
|
|
28019
|
+
"has_more": {
|
|
28020
|
+
"type": "boolean",
|
|
28021
|
+
"title": "Has More"
|
|
28022
|
+
}
|
|
28023
|
+
},
|
|
28024
|
+
"required": [
|
|
28025
|
+
"shared_sound_generations",
|
|
28026
|
+
"last_sort_id",
|
|
28027
|
+
"has_more"
|
|
28028
|
+
],
|
|
28029
|
+
"title": "GetSharedSoundGenerationsResponseModel"
|
|
28030
|
+
},
|
|
26798
28031
|
"GetSpeechHistoryResponseModel": {
|
|
26799
28032
|
"type": "object",
|
|
26800
28033
|
"properties": {
|
|
@@ -27344,16 +28577,41 @@
|
|
|
27344
28577
|
"gpt-3.5-turbo",
|
|
27345
28578
|
"gemini-1.5-pro",
|
|
27346
28579
|
"gemini-1.5-flash",
|
|
27347
|
-
"gemini-2.0-flash
|
|
28580
|
+
"gemini-2.0-flash",
|
|
27348
28581
|
"gemini-2.0-flash-lite",
|
|
27349
28582
|
"gemini-2.5-flash",
|
|
27350
|
-
"
|
|
28583
|
+
"claude-sonnet-4",
|
|
27351
28584
|
"claude-3-7-sonnet",
|
|
27352
28585
|
"claude-3-5-sonnet",
|
|
27353
28586
|
"claude-3-5-sonnet-v1",
|
|
27354
28587
|
"claude-3-haiku",
|
|
27355
28588
|
"grok-beta",
|
|
27356
|
-
"custom-llm"
|
|
28589
|
+
"custom-llm",
|
|
28590
|
+
"gemini-2.5-flash-preview-05-20",
|
|
28591
|
+
"gemini-2.5-flash-preview-04-17",
|
|
28592
|
+
"gemini-2.0-flash-lite-001",
|
|
28593
|
+
"gemini-2.0-flash-001",
|
|
28594
|
+
"gemini-1.5-flash-002",
|
|
28595
|
+
"gemini-1.5-flash-001",
|
|
28596
|
+
"gemini-1.5-pro-002",
|
|
28597
|
+
"gemini-1.5-pro-001",
|
|
28598
|
+
"claude-sonnet-4@20250514",
|
|
28599
|
+
"claude-3-7-sonnet@20250219",
|
|
28600
|
+
"claude-3-5-sonnet@20240620",
|
|
28601
|
+
"claude-3-5-sonnet-v2@20241022",
|
|
28602
|
+
"claude-3-haiku@20240307",
|
|
28603
|
+
"gpt-4.1-2025-04-14",
|
|
28604
|
+
"gpt-4.1-mini-2025-04-14",
|
|
28605
|
+
"gpt-4.1-nano-2025-04-14",
|
|
28606
|
+
"gpt-4o-mini-2024-07-18",
|
|
28607
|
+
"gpt-4o-2024-11-20",
|
|
28608
|
+
"gpt-4o-2024-08-06",
|
|
28609
|
+
"gpt-4o-2024-05-13",
|
|
28610
|
+
"gpt-4-0613",
|
|
28611
|
+
"gpt-4-0314",
|
|
28612
|
+
"gpt-4-turbo-2024-04-09",
|
|
28613
|
+
"gpt-3.5-turbo-0125",
|
|
28614
|
+
"gpt-3.5-turbo-1106"
|
|
27357
28615
|
],
|
|
27358
28616
|
"title": "LLM"
|
|
27359
28617
|
},
|
|
@@ -28018,6 +29276,16 @@
|
|
|
28018
29276
|
],
|
|
28019
29277
|
"title": "LiteralJsonSchemaProperty"
|
|
28020
29278
|
},
|
|
29279
|
+
"MCPApprovalRequiredModel": {
|
|
29280
|
+
"description": "Defines the approval model for an MCP tool",
|
|
29281
|
+
"type": "string",
|
|
29282
|
+
"enum": [
|
|
29283
|
+
"user_approval_always_given",
|
|
29284
|
+
"user_approval_never_given",
|
|
29285
|
+
"user_approval_required_per_tool"
|
|
29286
|
+
],
|
|
29287
|
+
"title": "MCPApprovalRequiredModel"
|
|
29288
|
+
},
|
|
28021
29289
|
"MCPToolConfig-Input": {
|
|
28022
29290
|
"description": "A MCP tool is a tool that is used to call a MCP server",
|
|
28023
29291
|
"type": "object",
|
|
@@ -28071,6 +29339,11 @@
|
|
|
28071
29339
|
"description": "The id of the MCP server to call",
|
|
28072
29340
|
"type": "string",
|
|
28073
29341
|
"title": "Mcp Server Id"
|
|
29342
|
+
},
|
|
29343
|
+
"approval_mode": {
|
|
29344
|
+
"description": "If set to approved, the tool will be pre-approved and not require user approval before executing",
|
|
29345
|
+
"default": "user_approval_never_given",
|
|
29346
|
+
"$ref": "#/components/schemas/MCPApprovalRequiredModel"
|
|
28074
29347
|
}
|
|
28075
29348
|
},
|
|
28076
29349
|
"required": [
|
|
@@ -28134,6 +29407,11 @@
|
|
|
28134
29407
|
"description": "The id of the MCP server to call",
|
|
28135
29408
|
"type": "string",
|
|
28136
29409
|
"title": "Mcp Server Id"
|
|
29410
|
+
},
|
|
29411
|
+
"approval_mode": {
|
|
29412
|
+
"description": "If set to approved, the tool will be pre-approved and not require user approval before executing",
|
|
29413
|
+
"default": "user_approval_never_given",
|
|
29414
|
+
"$ref": "#/components/schemas/MCPApprovalRequiredModel"
|
|
28137
29415
|
}
|
|
28138
29416
|
},
|
|
28139
29417
|
"required": [
|
|
@@ -28415,6 +29693,40 @@
|
|
|
28415
29693
|
],
|
|
28416
29694
|
"title": "ModelResponseModel"
|
|
28417
29695
|
},
|
|
29696
|
+
"ModelSettingsResponseModel": {
|
|
29697
|
+
"type": "object",
|
|
29698
|
+
"properties": {
|
|
29699
|
+
"stability": {
|
|
29700
|
+
"description": "Determines how stable the voice is and the randomness between each generation. Lower values introduce broader emotional range for the voice. Higher values can result in a monotonous voice with limited emotion.",
|
|
29701
|
+
"anyOf": [
|
|
29702
|
+
{
|
|
29703
|
+
"type": "number"
|
|
29704
|
+
},
|
|
29705
|
+
{
|
|
29706
|
+
"type": "null"
|
|
29707
|
+
}
|
|
29708
|
+
],
|
|
29709
|
+
"title": "Stability"
|
|
29710
|
+
},
|
|
29711
|
+
"use_speaker_boost": {
|
|
29712
|
+
"description": "This setting boosts the similarity to the original speaker. Using this setting requires a slightly higher computational load, which in turn increases latency.",
|
|
29713
|
+
"anyOf": [
|
|
29714
|
+
{
|
|
29715
|
+
"type": "boolean"
|
|
29716
|
+
},
|
|
29717
|
+
{
|
|
29718
|
+
"type": "null"
|
|
29719
|
+
}
|
|
29720
|
+
],
|
|
29721
|
+
"title": "Use Speaker Boost"
|
|
29722
|
+
}
|
|
29723
|
+
},
|
|
29724
|
+
"example": {
|
|
29725
|
+
"similarity_boost": 1,
|
|
29726
|
+
"stability": 1
|
|
29727
|
+
},
|
|
29728
|
+
"title": "ModelSettingsResponseModel"
|
|
29729
|
+
},
|
|
28418
29730
|
"ModerationStatusResponseModel": {
|
|
28419
29731
|
"type": "object",
|
|
28420
29732
|
"properties": {
|
|
@@ -28560,6 +29872,11 @@
|
|
|
28560
29872
|
"description": "The id of the MCP server to call",
|
|
28561
29873
|
"type": "string",
|
|
28562
29874
|
"title": "Mcp Server Id"
|
|
29875
|
+
},
|
|
29876
|
+
"approval_mode": {
|
|
29877
|
+
"description": "If set to always accept, the tool will be pre-approved and not require user approval before executing",
|
|
29878
|
+
"default": "user_approval_never_given",
|
|
29879
|
+
"$ref": "#/components/schemas/MCPApprovalRequiredModel"
|
|
28563
29880
|
}
|
|
28564
29881
|
},
|
|
28565
29882
|
"required": [
|
|
@@ -28623,6 +29940,11 @@
|
|
|
28623
29940
|
"description": "The id of the MCP server to call",
|
|
28624
29941
|
"type": "string",
|
|
28625
29942
|
"title": "Mcp Server Id"
|
|
29943
|
+
},
|
|
29944
|
+
"approval_mode": {
|
|
29945
|
+
"description": "If set to always accept, the tool will be pre-approved and not require user approval before executing",
|
|
29946
|
+
"default": "user_approval_never_given",
|
|
29947
|
+
"$ref": "#/components/schemas/MCPApprovalRequiredModel"
|
|
28626
29948
|
}
|
|
28627
29949
|
},
|
|
28628
29950
|
"required": [
|
|
@@ -30245,11 +31567,12 @@
|
|
|
30245
31567
|
"description": "The prompt for the agent",
|
|
30246
31568
|
"type": "string",
|
|
30247
31569
|
"default": "",
|
|
30248
|
-
"title": "Prompt"
|
|
31570
|
+
"title": "Prompt",
|
|
31571
|
+
"x-convai-client-override": true
|
|
30249
31572
|
},
|
|
30250
31573
|
"llm": {
|
|
30251
31574
|
"description": "The LLM to query with the prompt and the chat history",
|
|
30252
|
-
"default": "gemini-2.0-flash
|
|
31575
|
+
"default": "gemini-2.0-flash",
|
|
30253
31576
|
"$ref": "#/components/schemas/LLM"
|
|
30254
31577
|
},
|
|
30255
31578
|
"temperature": {
|
|
@@ -30380,11 +31703,12 @@
|
|
|
30380
31703
|
"description": "The prompt for the agent",
|
|
30381
31704
|
"type": "string",
|
|
30382
31705
|
"default": "",
|
|
30383
|
-
"title": "Prompt"
|
|
31706
|
+
"title": "Prompt",
|
|
31707
|
+
"x-convai-client-override": true
|
|
30384
31708
|
},
|
|
30385
31709
|
"llm": {
|
|
30386
31710
|
"description": "The LLM to query with the prompt and the chat history",
|
|
30387
|
-
"default": "gemini-2.0-flash
|
|
31711
|
+
"default": "gemini-2.0-flash",
|
|
30388
31712
|
"$ref": "#/components/schemas/LLM"
|
|
30389
31713
|
},
|
|
30390
31714
|
"temperature": {
|
|
@@ -30515,11 +31839,12 @@
|
|
|
30515
31839
|
"description": "The prompt for the agent",
|
|
30516
31840
|
"type": "string",
|
|
30517
31841
|
"default": "",
|
|
30518
|
-
"title": "Prompt"
|
|
31842
|
+
"title": "Prompt",
|
|
31843
|
+
"x-convai-client-override": true
|
|
30519
31844
|
},
|
|
30520
31845
|
"llm": {
|
|
30521
31846
|
"description": "The LLM to query with the prompt and the chat history",
|
|
30522
|
-
"default": "gemini-2.0-flash
|
|
31847
|
+
"default": "gemini-2.0-flash",
|
|
30523
31848
|
"$ref": "#/components/schemas/LLM"
|
|
30524
31849
|
},
|
|
30525
31850
|
"temperature": {
|
|
@@ -30654,14 +31979,21 @@
|
|
|
30654
31979
|
"type": "object",
|
|
30655
31980
|
"properties": {
|
|
30656
31981
|
"prompt": {
|
|
30657
|
-
"description": "The
|
|
30658
|
-
"
|
|
30659
|
-
|
|
30660
|
-
|
|
31982
|
+
"description": "The prompt for the agent",
|
|
31983
|
+
"anyOf": [
|
|
31984
|
+
{
|
|
31985
|
+
"type": "string"
|
|
31986
|
+
},
|
|
31987
|
+
{
|
|
31988
|
+
"type": "null"
|
|
31989
|
+
}
|
|
31990
|
+
],
|
|
31991
|
+
"title": "Prompt",
|
|
31992
|
+
"x-convai-client-override": true
|
|
30661
31993
|
}
|
|
30662
31994
|
},
|
|
30663
31995
|
"example": {
|
|
30664
|
-
"prompt": "You are a
|
|
31996
|
+
"prompt": "You are a helpful assistant that can answer questions about the topic of the conversation."
|
|
30665
31997
|
},
|
|
30666
31998
|
"title": "PromptAgentOverride"
|
|
30667
31999
|
},
|
|
@@ -30669,7 +32001,7 @@
|
|
|
30669
32001
|
"type": "object",
|
|
30670
32002
|
"properties": {
|
|
30671
32003
|
"prompt": {
|
|
30672
|
-
"description": "Whether to allow prompt
|
|
32004
|
+
"description": "Whether to allow overriding the prompt field.",
|
|
30673
32005
|
"type": "boolean",
|
|
30674
32006
|
"default": false,
|
|
30675
32007
|
"title": "Prompt"
|
|
@@ -31023,34 +32355,119 @@
|
|
|
31023
32355
|
],
|
|
31024
32356
|
"title": "QueryParamsJsonSchema"
|
|
31025
32357
|
},
|
|
31026
|
-
"
|
|
32358
|
+
"RAGDocumentIndexResponseModel": {
|
|
31027
32359
|
"type": "object",
|
|
31028
32360
|
"properties": {
|
|
32361
|
+
"id": {
|
|
32362
|
+
"type": "string",
|
|
32363
|
+
"title": "Id"
|
|
32364
|
+
},
|
|
31029
32365
|
"model": {
|
|
31030
32366
|
"$ref": "#/components/schemas/EmbeddingModelEnum"
|
|
32367
|
+
},
|
|
32368
|
+
"status": {
|
|
32369
|
+
"$ref": "#/components/schemas/RAGIndexStatus"
|
|
32370
|
+
},
|
|
32371
|
+
"progress_percentage": {
|
|
32372
|
+
"type": "number",
|
|
32373
|
+
"title": "Progress Percentage"
|
|
32374
|
+
},
|
|
32375
|
+
"document_model_index_usage": {
|
|
32376
|
+
"$ref": "#/components/schemas/RAGDocumentIndexUsage"
|
|
31031
32377
|
}
|
|
31032
32378
|
},
|
|
31033
32379
|
"required": [
|
|
31034
|
-
"
|
|
32380
|
+
"id",
|
|
32381
|
+
"model",
|
|
32382
|
+
"status",
|
|
32383
|
+
"progress_percentage",
|
|
32384
|
+
"document_model_index_usage"
|
|
31035
32385
|
],
|
|
31036
|
-
"title": "
|
|
32386
|
+
"title": "RAGDocumentIndexResponseModel"
|
|
31037
32387
|
},
|
|
31038
|
-
"
|
|
32388
|
+
"RAGDocumentIndexUsage": {
|
|
31039
32389
|
"type": "object",
|
|
31040
32390
|
"properties": {
|
|
31041
|
-
"
|
|
31042
|
-
"
|
|
32391
|
+
"used_bytes": {
|
|
32392
|
+
"type": "integer",
|
|
32393
|
+
"title": "Used Bytes"
|
|
32394
|
+
}
|
|
32395
|
+
},
|
|
32396
|
+
"required": [
|
|
32397
|
+
"used_bytes"
|
|
32398
|
+
],
|
|
32399
|
+
"title": "RAGDocumentIndexUsage"
|
|
32400
|
+
},
|
|
32401
|
+
"RAGDocumentIndexesResponseModel": {
|
|
32402
|
+
"type": "object",
|
|
32403
|
+
"properties": {
|
|
32404
|
+
"indexes": {
|
|
32405
|
+
"type": "array",
|
|
32406
|
+
"items": {
|
|
32407
|
+
"$ref": "#/components/schemas/RAGDocumentIndexResponseModel"
|
|
32408
|
+
},
|
|
32409
|
+
"title": "Indexes"
|
|
32410
|
+
}
|
|
32411
|
+
},
|
|
32412
|
+
"required": [
|
|
32413
|
+
"indexes"
|
|
32414
|
+
],
|
|
32415
|
+
"title": "RAGDocumentIndexesResponseModel"
|
|
32416
|
+
},
|
|
32417
|
+
"RAGIndexOverviewEmbeddingModelResponseModel": {
|
|
32418
|
+
"type": "object",
|
|
32419
|
+
"properties": {
|
|
32420
|
+
"model": {
|
|
32421
|
+
"$ref": "#/components/schemas/EmbeddingModelEnum"
|
|
31043
32422
|
},
|
|
31044
|
-
"
|
|
31045
|
-
"type": "
|
|
31046
|
-
"title": "
|
|
32423
|
+
"used_bytes": {
|
|
32424
|
+
"type": "integer",
|
|
32425
|
+
"title": "Used Bytes"
|
|
31047
32426
|
}
|
|
31048
32427
|
},
|
|
31049
32428
|
"required": [
|
|
31050
|
-
"
|
|
31051
|
-
"
|
|
32429
|
+
"model",
|
|
32430
|
+
"used_bytes"
|
|
31052
32431
|
],
|
|
31053
|
-
"title": "
|
|
32432
|
+
"title": "RAGIndexOverviewEmbeddingModelResponseModel"
|
|
32433
|
+
},
|
|
32434
|
+
"RAGIndexOverviewResponseModel": {
|
|
32435
|
+
"type": "object",
|
|
32436
|
+
"properties": {
|
|
32437
|
+
"total_used_bytes": {
|
|
32438
|
+
"type": "integer",
|
|
32439
|
+
"title": "Total Used Bytes"
|
|
32440
|
+
},
|
|
32441
|
+
"total_max_bytes": {
|
|
32442
|
+
"type": "integer",
|
|
32443
|
+
"title": "Total Max Bytes"
|
|
32444
|
+
},
|
|
32445
|
+
"models": {
|
|
32446
|
+
"type": "array",
|
|
32447
|
+
"items": {
|
|
32448
|
+
"$ref": "#/components/schemas/RAGIndexOverviewEmbeddingModelResponseModel"
|
|
32449
|
+
},
|
|
32450
|
+
"title": "Models"
|
|
32451
|
+
}
|
|
32452
|
+
},
|
|
32453
|
+
"required": [
|
|
32454
|
+
"total_used_bytes",
|
|
32455
|
+
"total_max_bytes",
|
|
32456
|
+
"models"
|
|
32457
|
+
],
|
|
32458
|
+
"title": "RAGIndexOverviewResponseModel"
|
|
32459
|
+
},
|
|
32460
|
+
"RAGIndexRequestModel": {
|
|
32461
|
+
"type": "object",
|
|
32462
|
+
"properties": {
|
|
32463
|
+
"model": {
|
|
32464
|
+
"$ref": "#/components/schemas/EmbeddingModelEnum"
|
|
32465
|
+
}
|
|
32466
|
+
},
|
|
32467
|
+
"required": [
|
|
32468
|
+
"model"
|
|
32469
|
+
],
|
|
32470
|
+
"title": "RAGIndexRequestModel"
|
|
31054
32471
|
},
|
|
31055
32472
|
"RAGIndexStatus": {
|
|
31056
32473
|
"type": "string",
|
|
@@ -31058,7 +32475,9 @@
|
|
|
31058
32475
|
"created",
|
|
31059
32476
|
"processing",
|
|
31060
32477
|
"failed",
|
|
31061
|
-
"succeeded"
|
|
32478
|
+
"succeeded",
|
|
32479
|
+
"rag_limit_exceeded",
|
|
32480
|
+
"document_too_small"
|
|
31062
32481
|
],
|
|
31063
32482
|
"title": "RAGIndexStatus"
|
|
31064
32483
|
},
|
|
@@ -31118,6 +32537,17 @@
|
|
|
31118
32537
|
"exclusiveMaximum": 10000000,
|
|
31119
32538
|
"exclusiveMinimum": 0,
|
|
31120
32539
|
"title": "Max Documents Length"
|
|
32540
|
+
},
|
|
32541
|
+
"max_retrieved_rag_chunks_count": {
|
|
32542
|
+
"description": "Maximum number of RAG document chunks to initially retrieve from the vector store. These are then further filtered by vector distance and total length.",
|
|
32543
|
+
"type": "integer",
|
|
32544
|
+
"default": 20,
|
|
32545
|
+
"examples": [
|
|
32546
|
+
5
|
|
32547
|
+
],
|
|
32548
|
+
"exclusiveMinimum": 0,
|
|
32549
|
+
"maximum": 20,
|
|
32550
|
+
"title": "Max Retrieved Rag Chunks Count"
|
|
31121
32551
|
}
|
|
31122
32552
|
},
|
|
31123
32553
|
"title": "RagConfig"
|
|
@@ -32043,6 +33473,77 @@
|
|
|
32043
33473
|
],
|
|
32044
33474
|
"title": "ShareOptionResponseModel"
|
|
32045
33475
|
},
|
|
33476
|
+
"SharedSoundGenerationResponseModel": {
|
|
33477
|
+
"type": "object",
|
|
33478
|
+
"properties": {
|
|
33479
|
+
"public_user_id": {
|
|
33480
|
+
"type": "string",
|
|
33481
|
+
"title": "Public User Id"
|
|
33482
|
+
},
|
|
33483
|
+
"history_item_id": {
|
|
33484
|
+
"type": "string",
|
|
33485
|
+
"title": "History Item Id"
|
|
33486
|
+
},
|
|
33487
|
+
"generation_id": {
|
|
33488
|
+
"type": "string",
|
|
33489
|
+
"title": "Generation Id"
|
|
33490
|
+
},
|
|
33491
|
+
"text": {
|
|
33492
|
+
"type": "string",
|
|
33493
|
+
"title": "Text"
|
|
33494
|
+
},
|
|
33495
|
+
"category": {
|
|
33496
|
+
"type": "string",
|
|
33497
|
+
"title": "Category"
|
|
33498
|
+
},
|
|
33499
|
+
"labels": {
|
|
33500
|
+
"type": "object",
|
|
33501
|
+
"additionalProperties": {
|
|
33502
|
+
"type": "string"
|
|
33503
|
+
},
|
|
33504
|
+
"title": "Labels"
|
|
33505
|
+
},
|
|
33506
|
+
"purchased_count": {
|
|
33507
|
+
"type": "integer",
|
|
33508
|
+
"title": "Purchased Count"
|
|
33509
|
+
},
|
|
33510
|
+
"like_count": {
|
|
33511
|
+
"type": "integer",
|
|
33512
|
+
"title": "Like Count"
|
|
33513
|
+
},
|
|
33514
|
+
"featured": {
|
|
33515
|
+
"type": "boolean",
|
|
33516
|
+
"title": "Featured"
|
|
33517
|
+
},
|
|
33518
|
+
"preview_url": {
|
|
33519
|
+
"type": "string",
|
|
33520
|
+
"title": "Preview Url"
|
|
33521
|
+
},
|
|
33522
|
+
"purchased": {
|
|
33523
|
+
"type": "boolean",
|
|
33524
|
+
"title": "Purchased"
|
|
33525
|
+
},
|
|
33526
|
+
"icon_url": {
|
|
33527
|
+
"type": "string",
|
|
33528
|
+
"title": "Icon Url"
|
|
33529
|
+
}
|
|
33530
|
+
},
|
|
33531
|
+
"required": [
|
|
33532
|
+
"public_user_id",
|
|
33533
|
+
"history_item_id",
|
|
33534
|
+
"generation_id",
|
|
33535
|
+
"text",
|
|
33536
|
+
"category",
|
|
33537
|
+
"labels",
|
|
33538
|
+
"purchased_count",
|
|
33539
|
+
"like_count",
|
|
33540
|
+
"featured",
|
|
33541
|
+
"preview_url",
|
|
33542
|
+
"purchased",
|
|
33543
|
+
"icon_url"
|
|
33544
|
+
],
|
|
33545
|
+
"title": "SharedSoundGenerationResponseModel"
|
|
33546
|
+
},
|
|
32046
33547
|
"SimilarVoice": {
|
|
32047
33548
|
"type": "object",
|
|
32048
33549
|
"properties": {
|
|
@@ -32111,6 +33612,19 @@
|
|
|
32111
33612
|
],
|
|
32112
33613
|
"title": "SimilarVoicesForSpeakerResponse"
|
|
32113
33614
|
},
|
|
33615
|
+
"SkipTurnToolConfig": {
|
|
33616
|
+
"description": "Allows the agent to explicitly skip its turn.\n\nThis tool should be invoked by the LLM when the user indicates they would like\nto think or take a short pause before continuing the conversation—e.g. when\nthey say: \"Give me a second\", \"Let me think\", or \"One moment please\". After\ncalling this tool, the assistant should not speak until the user speaks\nagain, or another normal turn-taking condition is met. The tool itself has\nno parameters and performs no side-effects other than informing the backend\nthat the current turn generation is complete.",
|
|
33617
|
+
"type": "object",
|
|
33618
|
+
"properties": {
|
|
33619
|
+
"system_tool_type": {
|
|
33620
|
+
"type": "string",
|
|
33621
|
+
"default": "skip_turn",
|
|
33622
|
+
"const": "skip_turn",
|
|
33623
|
+
"title": "System Tool Type"
|
|
33624
|
+
}
|
|
33625
|
+
},
|
|
33626
|
+
"title": "SkipTurnToolConfig"
|
|
33627
|
+
},
|
|
32114
33628
|
"SpeakerAudioResponseModel": {
|
|
32115
33629
|
"type": "object",
|
|
32116
33630
|
"properties": {
|
|
@@ -32357,7 +33871,14 @@
|
|
|
32357
33871
|
},
|
|
32358
33872
|
"voice_id": {
|
|
32359
33873
|
"description": "The ID of the voice used.",
|
|
32360
|
-
"
|
|
33874
|
+
"anyOf": [
|
|
33875
|
+
{
|
|
33876
|
+
"type": "string"
|
|
33877
|
+
},
|
|
33878
|
+
{
|
|
33879
|
+
"type": "null"
|
|
33880
|
+
}
|
|
33881
|
+
],
|
|
32361
33882
|
"title": "Voice Id"
|
|
32362
33883
|
},
|
|
32363
33884
|
"model_id": {
|
|
@@ -32374,7 +33895,14 @@
|
|
|
32374
33895
|
},
|
|
32375
33896
|
"voice_name": {
|
|
32376
33897
|
"description": "The name of the voice.",
|
|
32377
|
-
"
|
|
33898
|
+
"anyOf": [
|
|
33899
|
+
{
|
|
33900
|
+
"type": "string"
|
|
33901
|
+
},
|
|
33902
|
+
{
|
|
33903
|
+
"type": "null"
|
|
33904
|
+
}
|
|
33905
|
+
],
|
|
32378
33906
|
"title": "Voice Name"
|
|
32379
33907
|
},
|
|
32380
33908
|
"voice_category": {
|
|
@@ -32397,7 +33925,14 @@
|
|
|
32397
33925
|
},
|
|
32398
33926
|
"text": {
|
|
32399
33927
|
"description": "The text used to generate the audio item.",
|
|
32400
|
-
"
|
|
33928
|
+
"anyOf": [
|
|
33929
|
+
{
|
|
33930
|
+
"type": "string"
|
|
33931
|
+
},
|
|
33932
|
+
{
|
|
33933
|
+
"type": "null"
|
|
33934
|
+
}
|
|
33935
|
+
],
|
|
32401
33936
|
"title": "Text"
|
|
32402
33937
|
},
|
|
32403
33938
|
"date_unix": {
|
|
@@ -32497,6 +34032,21 @@
|
|
|
32497
34032
|
"type": "null"
|
|
32498
34033
|
}
|
|
32499
34034
|
]
|
|
34035
|
+
},
|
|
34036
|
+
"dialogue": {
|
|
34037
|
+
"description": "The dialogue (voice and text pairs) used to generate the audio item. If this is set then the top level `text` and `voice_id` fields will be empty.",
|
|
34038
|
+
"anyOf": [
|
|
34039
|
+
{
|
|
34040
|
+
"items": {
|
|
34041
|
+
"$ref": "#/components/schemas/DialogueInputResponseModel"
|
|
34042
|
+
},
|
|
34043
|
+
"type": "array"
|
|
34044
|
+
},
|
|
34045
|
+
{
|
|
34046
|
+
"type": "null"
|
|
34047
|
+
}
|
|
34048
|
+
],
|
|
34049
|
+
"title": "Dialogue"
|
|
32500
34050
|
}
|
|
32501
34051
|
},
|
|
32502
34052
|
"example": {
|
|
@@ -32522,9 +34072,6 @@
|
|
|
32522
34072
|
},
|
|
32523
34073
|
"required": [
|
|
32524
34074
|
"history_item_id",
|
|
32525
|
-
"voice_id",
|
|
32526
|
-
"voice_name",
|
|
32527
|
-
"text",
|
|
32528
34075
|
"date_unix",
|
|
32529
34076
|
"character_count_change_from",
|
|
32530
34077
|
"character_count_change_to",
|
|
@@ -33207,18 +34754,7 @@
|
|
|
33207
34754
|
},
|
|
33208
34755
|
"status": {
|
|
33209
34756
|
"description": "The status of the user's subscription.",
|
|
33210
|
-
"
|
|
33211
|
-
"enum": [
|
|
33212
|
-
"trialing",
|
|
33213
|
-
"active",
|
|
33214
|
-
"incomplete",
|
|
33215
|
-
"incomplete_expired",
|
|
33216
|
-
"past_due",
|
|
33217
|
-
"canceled",
|
|
33218
|
-
"unpaid",
|
|
33219
|
-
"free"
|
|
33220
|
-
],
|
|
33221
|
-
"title": "Status"
|
|
34757
|
+
"$ref": "#/components/schemas/SubscriptionStatusType"
|
|
33222
34758
|
},
|
|
33223
34759
|
"billing_period": {
|
|
33224
34760
|
"description": "The billing period of the user's subscription.",
|
|
@@ -33293,6 +34829,21 @@
|
|
|
33293
34829
|
],
|
|
33294
34830
|
"title": "SubscriptionResponseModel"
|
|
33295
34831
|
},
|
|
34832
|
+
"SubscriptionStatusType": {
|
|
34833
|
+
"type": "string",
|
|
34834
|
+
"enum": [
|
|
34835
|
+
"trialing",
|
|
34836
|
+
"active",
|
|
34837
|
+
"incomplete",
|
|
34838
|
+
"incomplete_expired",
|
|
34839
|
+
"past_due",
|
|
34840
|
+
"canceled",
|
|
34841
|
+
"unpaid",
|
|
34842
|
+
"free",
|
|
34843
|
+
"free_disabled"
|
|
34844
|
+
],
|
|
34845
|
+
"title": "SubscriptionStatusType"
|
|
34846
|
+
},
|
|
33296
34847
|
"SubscriptionUsageResponseModel": {
|
|
33297
34848
|
"type": "object",
|
|
33298
34849
|
"properties": {
|
|
@@ -33359,6 +34910,58 @@
|
|
|
33359
34910
|
],
|
|
33360
34911
|
"title": "SubscriptionUsageResponseModel"
|
|
33361
34912
|
},
|
|
34913
|
+
"SupportedVoice": {
|
|
34914
|
+
"type": "object",
|
|
34915
|
+
"properties": {
|
|
34916
|
+
"label": {
|
|
34917
|
+
"type": "string",
|
|
34918
|
+
"minLength": 1,
|
|
34919
|
+
"title": "Label"
|
|
34920
|
+
},
|
|
34921
|
+
"voice_id": {
|
|
34922
|
+
"type": "string",
|
|
34923
|
+
"minLength": 1,
|
|
34924
|
+
"title": "Voice Id"
|
|
34925
|
+
},
|
|
34926
|
+
"description": {
|
|
34927
|
+
"anyOf": [
|
|
34928
|
+
{
|
|
34929
|
+
"type": "string"
|
|
34930
|
+
},
|
|
34931
|
+
{
|
|
34932
|
+
"type": "null"
|
|
34933
|
+
}
|
|
34934
|
+
],
|
|
34935
|
+
"title": "Description"
|
|
34936
|
+
},
|
|
34937
|
+
"language": {
|
|
34938
|
+
"anyOf": [
|
|
34939
|
+
{
|
|
34940
|
+
"type": "string"
|
|
34941
|
+
},
|
|
34942
|
+
{
|
|
34943
|
+
"type": "null"
|
|
34944
|
+
}
|
|
34945
|
+
],
|
|
34946
|
+
"title": "Language"
|
|
34947
|
+
},
|
|
34948
|
+
"model_family": {
|
|
34949
|
+
"anyOf": [
|
|
34950
|
+
{
|
|
34951
|
+
"$ref": "#/components/schemas/TTSModelFamily"
|
|
34952
|
+
},
|
|
34953
|
+
{
|
|
34954
|
+
"type": "null"
|
|
34955
|
+
}
|
|
34956
|
+
]
|
|
34957
|
+
}
|
|
34958
|
+
},
|
|
34959
|
+
"required": [
|
|
34960
|
+
"label",
|
|
34961
|
+
"voice_id"
|
|
34962
|
+
],
|
|
34963
|
+
"title": "SupportedVoice"
|
|
34964
|
+
},
|
|
33362
34965
|
"SystemToolConfig-Input": {
|
|
33363
34966
|
"description": "A system tool is a tool that is used to call a system method in the server",
|
|
33364
34967
|
"type": "object",
|
|
@@ -33398,6 +35001,7 @@
|
|
|
33398
35001
|
"mapping": {
|
|
33399
35002
|
"end_call": "#/components/schemas/EndCallToolConfig",
|
|
33400
35003
|
"language_detection": "#/components/schemas/LanguageDetectionToolConfig",
|
|
35004
|
+
"skip_turn": "#/components/schemas/SkipTurnToolConfig",
|
|
33401
35005
|
"transfer_to_agent": "#/components/schemas/TransferToAgentToolConfig",
|
|
33402
35006
|
"transfer_to_number": "#/components/schemas/TransferToNumberToolConfig"
|
|
33403
35007
|
}
|
|
@@ -33414,6 +35018,9 @@
|
|
|
33414
35018
|
},
|
|
33415
35019
|
{
|
|
33416
35020
|
"$ref": "#/components/schemas/TransferToNumberToolConfig"
|
|
35021
|
+
},
|
|
35022
|
+
{
|
|
35023
|
+
"$ref": "#/components/schemas/SkipTurnToolConfig"
|
|
33417
35024
|
}
|
|
33418
35025
|
],
|
|
33419
35026
|
"title": "Params"
|
|
@@ -33468,6 +35075,7 @@
|
|
|
33468
35075
|
"mapping": {
|
|
33469
35076
|
"end_call": "#/components/schemas/EndCallToolConfig",
|
|
33470
35077
|
"language_detection": "#/components/schemas/LanguageDetectionToolConfig",
|
|
35078
|
+
"skip_turn": "#/components/schemas/SkipTurnToolConfig",
|
|
33471
35079
|
"transfer_to_agent": "#/components/schemas/TransferToAgentToolConfig",
|
|
33472
35080
|
"transfer_to_number": "#/components/schemas/TransferToNumberToolConfig"
|
|
33473
35081
|
}
|
|
@@ -33484,6 +35092,9 @@
|
|
|
33484
35092
|
},
|
|
33485
35093
|
{
|
|
33486
35094
|
"$ref": "#/components/schemas/TransferToNumberToolConfig"
|
|
35095
|
+
},
|
|
35096
|
+
{
|
|
35097
|
+
"$ref": "#/components/schemas/SkipTurnToolConfig"
|
|
33487
35098
|
}
|
|
33488
35099
|
],
|
|
33489
35100
|
"title": "Params"
|
|
@@ -33499,7 +35110,7 @@
|
|
|
33499
35110
|
],
|
|
33500
35111
|
"title": "SystemToolConfig"
|
|
33501
35112
|
},
|
|
33502
|
-
"TTSConversationalConfig": {
|
|
35113
|
+
"TTSConversationalConfig-Input": {
|
|
33503
35114
|
"type": "object",
|
|
33504
35115
|
"properties": {
|
|
33505
35116
|
"model_id": {
|
|
@@ -33512,7 +35123,97 @@
|
|
|
33512
35123
|
"type": "string",
|
|
33513
35124
|
"default": "cjVigY5qzO86Huf0OWal",
|
|
33514
35125
|
"minLength": 0,
|
|
33515
|
-
"title": "Voice Id"
|
|
35126
|
+
"title": "Voice Id",
|
|
35127
|
+
"x-convai-client-override": true,
|
|
35128
|
+
"x-convai-language-override": true
|
|
35129
|
+
},
|
|
35130
|
+
"supported_voices": {
|
|
35131
|
+
"description": "Additional supported voices for the agent",
|
|
35132
|
+
"type": "array",
|
|
35133
|
+
"items": {
|
|
35134
|
+
"$ref": "#/components/schemas/SupportedVoice"
|
|
35135
|
+
},
|
|
35136
|
+
"title": "Supported Voices"
|
|
35137
|
+
},
|
|
35138
|
+
"agent_output_audio_format": {
|
|
35139
|
+
"description": "The audio format to use for TTS",
|
|
35140
|
+
"default": "pcm_16000",
|
|
35141
|
+
"$ref": "#/components/schemas/TTSOutputFormat"
|
|
35142
|
+
},
|
|
35143
|
+
"optimize_streaming_latency": {
|
|
35144
|
+
"description": "The optimization for streaming latency",
|
|
35145
|
+
"default": 3,
|
|
35146
|
+
"$ref": "#/components/schemas/TTSOptimizeStreamingLatency"
|
|
35147
|
+
},
|
|
35148
|
+
"stability": {
|
|
35149
|
+
"description": "The stability of generated speech",
|
|
35150
|
+
"type": "number",
|
|
35151
|
+
"default": 0.5,
|
|
35152
|
+
"maximum": 1,
|
|
35153
|
+
"minimum": 0,
|
|
35154
|
+
"title": "Stability"
|
|
35155
|
+
},
|
|
35156
|
+
"speed": {
|
|
35157
|
+
"description": "The speed of generated speech",
|
|
35158
|
+
"type": "number",
|
|
35159
|
+
"default": 1,
|
|
35160
|
+
"maximum": 1.2,
|
|
35161
|
+
"minimum": 0.7,
|
|
35162
|
+
"title": "Speed"
|
|
35163
|
+
},
|
|
35164
|
+
"similarity_boost": {
|
|
35165
|
+
"description": "The similarity boost for generated speech",
|
|
35166
|
+
"type": "number",
|
|
35167
|
+
"default": 0.8,
|
|
35168
|
+
"maximum": 1,
|
|
35169
|
+
"minimum": 0,
|
|
35170
|
+
"title": "Similarity Boost"
|
|
35171
|
+
},
|
|
35172
|
+
"pronunciation_dictionary_locators": {
|
|
35173
|
+
"description": "The pronunciation dictionary locators",
|
|
35174
|
+
"type": "array",
|
|
35175
|
+
"items": {
|
|
35176
|
+
"$ref": "#/components/schemas/PydanticPronunciationDictionaryVersionLocator"
|
|
35177
|
+
},
|
|
35178
|
+
"title": "Pronunciation Dictionary Locators"
|
|
35179
|
+
}
|
|
35180
|
+
},
|
|
35181
|
+
"example": {
|
|
35182
|
+
"agent_output_audio_format": "pcm_16000",
|
|
35183
|
+
"model_id": "eleven_turbo_v2",
|
|
35184
|
+
"optimize_streaming_latency": 3,
|
|
35185
|
+
"pronunciation_dictionary_locators": [],
|
|
35186
|
+
"similarity_boost": 0.8,
|
|
35187
|
+
"speed": 1,
|
|
35188
|
+
"stability": 0.5,
|
|
35189
|
+
"voice_id": "cjVigY5qzO86Huf0OWal"
|
|
35190
|
+
},
|
|
35191
|
+
"title": "TTSConversationalConfig"
|
|
35192
|
+
},
|
|
35193
|
+
"TTSConversationalConfig-Output": {
|
|
35194
|
+
"type": "object",
|
|
35195
|
+
"properties": {
|
|
35196
|
+
"model_id": {
|
|
35197
|
+
"description": "The model to use for TTS",
|
|
35198
|
+
"default": "eleven_turbo_v2",
|
|
35199
|
+
"$ref": "#/components/schemas/TTSConversationalModel"
|
|
35200
|
+
},
|
|
35201
|
+
"voice_id": {
|
|
35202
|
+
"description": "The voice ID to use for TTS",
|
|
35203
|
+
"type": "string",
|
|
35204
|
+
"default": "cjVigY5qzO86Huf0OWal",
|
|
35205
|
+
"minLength": 0,
|
|
35206
|
+
"title": "Voice Id",
|
|
35207
|
+
"x-convai-client-override": true,
|
|
35208
|
+
"x-convai-language-override": true
|
|
35209
|
+
},
|
|
35210
|
+
"supported_voices": {
|
|
35211
|
+
"description": "Additional supported voices for the agent",
|
|
35212
|
+
"type": "array",
|
|
35213
|
+
"items": {
|
|
35214
|
+
"$ref": "#/components/schemas/SupportedVoice"
|
|
35215
|
+
},
|
|
35216
|
+
"title": "Supported Voices"
|
|
33516
35217
|
},
|
|
33517
35218
|
"agent_output_audio_format": {
|
|
33518
35219
|
"description": "The audio format to use for TTS",
|
|
@@ -33573,6 +35274,7 @@
|
|
|
33573
35274
|
"type": "object",
|
|
33574
35275
|
"properties": {
|
|
33575
35276
|
"voice_id": {
|
|
35277
|
+
"description": "The voice ID to use for TTS",
|
|
33576
35278
|
"anyOf": [
|
|
33577
35279
|
{
|
|
33578
35280
|
"type": "string"
|
|
@@ -33581,24 +35283,26 @@
|
|
|
33581
35283
|
"type": "null"
|
|
33582
35284
|
}
|
|
33583
35285
|
],
|
|
33584
|
-
"title": "Voice Id"
|
|
35286
|
+
"title": "Voice Id",
|
|
35287
|
+
"x-convai-client-override": true,
|
|
35288
|
+
"x-convai-language-override": true
|
|
33585
35289
|
}
|
|
33586
35290
|
},
|
|
35291
|
+
"example": {
|
|
35292
|
+
"voice_id": "cjVigY5qzO86Huf0OWal"
|
|
35293
|
+
},
|
|
33587
35294
|
"title": "TTSConversationalConfigOverride"
|
|
33588
35295
|
},
|
|
33589
35296
|
"TTSConversationalConfigOverrideConfig": {
|
|
33590
35297
|
"type": "object",
|
|
33591
35298
|
"properties": {
|
|
33592
35299
|
"voice_id": {
|
|
33593
|
-
"description": "Whether to allow overriding the
|
|
35300
|
+
"description": "Whether to allow overriding the voice_id field.",
|
|
33594
35301
|
"type": "boolean",
|
|
33595
35302
|
"default": false,
|
|
33596
35303
|
"title": "Voice Id"
|
|
33597
35304
|
}
|
|
33598
35305
|
},
|
|
33599
|
-
"example": {
|
|
33600
|
-
"voice_id": false
|
|
33601
|
-
},
|
|
33602
35306
|
"title": "TTSConversationalConfigOverrideConfig"
|
|
33603
35307
|
},
|
|
33604
35308
|
"TTSConversationalModel": {
|
|
@@ -33611,6 +35315,15 @@
|
|
|
33611
35315
|
],
|
|
33612
35316
|
"title": "TTSConversationalModel"
|
|
33613
35317
|
},
|
|
35318
|
+
"TTSModelFamily": {
|
|
35319
|
+
"type": "string",
|
|
35320
|
+
"enum": [
|
|
35321
|
+
"turbo",
|
|
35322
|
+
"flash",
|
|
35323
|
+
"multilingual"
|
|
35324
|
+
],
|
|
35325
|
+
"title": "TTSModelFamily"
|
|
35326
|
+
},
|
|
33614
35327
|
"TTSOptimizeStreamingLatency": {
|
|
33615
35328
|
"type": "integer",
|
|
33616
35329
|
"enum": [
|
|
@@ -35030,20 +36743,20 @@
|
|
|
35030
36743
|
],
|
|
35031
36744
|
"title": "Stability"
|
|
35032
36745
|
},
|
|
35033
|
-
"
|
|
35034
|
-
"description": "
|
|
36746
|
+
"use_speaker_boost": {
|
|
36747
|
+
"description": "This setting boosts the similarity to the original speaker. Using this setting requires a slightly higher computational load, which in turn increases latency.",
|
|
35035
36748
|
"anyOf": [
|
|
35036
36749
|
{
|
|
35037
|
-
"type": "
|
|
36750
|
+
"type": "boolean"
|
|
35038
36751
|
},
|
|
35039
36752
|
{
|
|
35040
36753
|
"type": "null"
|
|
35041
36754
|
}
|
|
35042
36755
|
],
|
|
35043
|
-
"title": "
|
|
36756
|
+
"title": "Use Speaker Boost"
|
|
35044
36757
|
},
|
|
35045
|
-
"
|
|
35046
|
-
"description": "Determines
|
|
36758
|
+
"similarity_boost": {
|
|
36759
|
+
"description": "Determines how closely the AI should adhere to the original voice when attempting to replicate it.",
|
|
35047
36760
|
"anyOf": [
|
|
35048
36761
|
{
|
|
35049
36762
|
"type": "number"
|
|
@@ -35052,19 +36765,19 @@
|
|
|
35052
36765
|
"type": "null"
|
|
35053
36766
|
}
|
|
35054
36767
|
],
|
|
35055
|
-
"title": "
|
|
36768
|
+
"title": "Similarity Boost"
|
|
35056
36769
|
},
|
|
35057
|
-
"
|
|
35058
|
-
"description": "This setting
|
|
36770
|
+
"style": {
|
|
36771
|
+
"description": "Determines the style exaggeration of the voice. This setting attempts to amplify the style of the original speaker. It does consume additional computational resources and might increase latency if set to anything other than 0.",
|
|
35059
36772
|
"anyOf": [
|
|
35060
36773
|
{
|
|
35061
|
-
"type": "
|
|
36774
|
+
"type": "number"
|
|
35062
36775
|
},
|
|
35063
36776
|
{
|
|
35064
36777
|
"type": "null"
|
|
35065
36778
|
}
|
|
35066
36779
|
],
|
|
35067
|
-
"title": "
|
|
36780
|
+
"title": "Style"
|
|
35068
36781
|
},
|
|
35069
36782
|
"speed": {
|
|
35070
36783
|
"description": "Adjusts the speed of the voice. A value of 1.0 is the default speed, while values less than 1.0 slow down the speech, and values greater than 1.0 speed it up.",
|
|
@@ -36012,7 +37725,7 @@
|
|
|
36012
37725
|
],
|
|
36013
37726
|
"title": "WebhookToolConfig"
|
|
36014
37727
|
},
|
|
36015
|
-
"WidgetConfig": {
|
|
37728
|
+
"WidgetConfig-Input": {
|
|
36016
37729
|
"type": "object",
|
|
36017
37730
|
"properties": {
|
|
36018
37731
|
"variant": {
|
|
@@ -36020,6 +37733,327 @@
|
|
|
36020
37733
|
"default": "full",
|
|
36021
37734
|
"$ref": "#/components/schemas/EmbedVariant"
|
|
36022
37735
|
},
|
|
37736
|
+
"placement": {
|
|
37737
|
+
"description": "The placement of the widget on the screen",
|
|
37738
|
+
"default": "bottom-right",
|
|
37739
|
+
"$ref": "#/components/schemas/WidgetPlacement"
|
|
37740
|
+
},
|
|
37741
|
+
"expandable": {
|
|
37742
|
+
"description": "Whether the widget is expandable",
|
|
37743
|
+
"default": "never",
|
|
37744
|
+
"$ref": "#/components/schemas/WidgetExpandable"
|
|
37745
|
+
},
|
|
37746
|
+
"avatar": {
|
|
37747
|
+
"description": "The avatar of the widget",
|
|
37748
|
+
"anyOf": [
|
|
37749
|
+
{
|
|
37750
|
+
"$ref": "#/components/schemas/OrbAvatar"
|
|
37751
|
+
},
|
|
37752
|
+
{
|
|
37753
|
+
"$ref": "#/components/schemas/URLAvatar"
|
|
37754
|
+
},
|
|
37755
|
+
{
|
|
37756
|
+
"$ref": "#/components/schemas/ImageAvatar"
|
|
37757
|
+
}
|
|
37758
|
+
],
|
|
37759
|
+
"title": "Avatar"
|
|
37760
|
+
},
|
|
37761
|
+
"feedback_mode": {
|
|
37762
|
+
"description": "The feedback mode of the widget",
|
|
37763
|
+
"default": "none",
|
|
37764
|
+
"$ref": "#/components/schemas/WidgetFeedbackMode"
|
|
37765
|
+
},
|
|
37766
|
+
"bg_color": {
|
|
37767
|
+
"description": "The background color of the widget",
|
|
37768
|
+
"type": "string",
|
|
37769
|
+
"default": "#ffffff",
|
|
37770
|
+
"title": "Bg Color"
|
|
37771
|
+
},
|
|
37772
|
+
"text_color": {
|
|
37773
|
+
"description": "The text color of the widget",
|
|
37774
|
+
"type": "string",
|
|
37775
|
+
"default": "#000000",
|
|
37776
|
+
"title": "Text Color"
|
|
37777
|
+
},
|
|
37778
|
+
"btn_color": {
|
|
37779
|
+
"description": "The button color of the widget",
|
|
37780
|
+
"type": "string",
|
|
37781
|
+
"default": "#000000",
|
|
37782
|
+
"title": "Btn Color"
|
|
37783
|
+
},
|
|
37784
|
+
"btn_text_color": {
|
|
37785
|
+
"description": "The button text color of the widget",
|
|
37786
|
+
"type": "string",
|
|
37787
|
+
"default": "#ffffff",
|
|
37788
|
+
"title": "Btn Text Color"
|
|
37789
|
+
},
|
|
37790
|
+
"border_color": {
|
|
37791
|
+
"description": "The border color of the widget",
|
|
37792
|
+
"type": "string",
|
|
37793
|
+
"default": "#e1e1e1",
|
|
37794
|
+
"title": "Border Color"
|
|
37795
|
+
},
|
|
37796
|
+
"focus_color": {
|
|
37797
|
+
"description": "The focus color of the widget",
|
|
37798
|
+
"type": "string",
|
|
37799
|
+
"default": "#000000",
|
|
37800
|
+
"title": "Focus Color"
|
|
37801
|
+
},
|
|
37802
|
+
"border_radius": {
|
|
37803
|
+
"description": "The border radius of the widget",
|
|
37804
|
+
"anyOf": [
|
|
37805
|
+
{
|
|
37806
|
+
"type": "integer"
|
|
37807
|
+
},
|
|
37808
|
+
{
|
|
37809
|
+
"type": "null"
|
|
37810
|
+
}
|
|
37811
|
+
],
|
|
37812
|
+
"title": "Border Radius"
|
|
37813
|
+
},
|
|
37814
|
+
"btn_radius": {
|
|
37815
|
+
"description": "The button radius of the widget",
|
|
37816
|
+
"anyOf": [
|
|
37817
|
+
{
|
|
37818
|
+
"type": "integer"
|
|
37819
|
+
},
|
|
37820
|
+
{
|
|
37821
|
+
"type": "null"
|
|
37822
|
+
}
|
|
37823
|
+
],
|
|
37824
|
+
"title": "Btn Radius"
|
|
37825
|
+
},
|
|
37826
|
+
"action_text": {
|
|
37827
|
+
"description": "The action text of the widget",
|
|
37828
|
+
"anyOf": [
|
|
37829
|
+
{
|
|
37830
|
+
"type": "string"
|
|
37831
|
+
},
|
|
37832
|
+
{
|
|
37833
|
+
"type": "null"
|
|
37834
|
+
}
|
|
37835
|
+
],
|
|
37836
|
+
"title": "Action Text"
|
|
37837
|
+
},
|
|
37838
|
+
"start_call_text": {
|
|
37839
|
+
"description": "The start call text of the widget",
|
|
37840
|
+
"anyOf": [
|
|
37841
|
+
{
|
|
37842
|
+
"type": "string"
|
|
37843
|
+
},
|
|
37844
|
+
{
|
|
37845
|
+
"type": "null"
|
|
37846
|
+
}
|
|
37847
|
+
],
|
|
37848
|
+
"title": "Start Call Text"
|
|
37849
|
+
},
|
|
37850
|
+
"end_call_text": {
|
|
37851
|
+
"description": "The end call text of the widget",
|
|
37852
|
+
"anyOf": [
|
|
37853
|
+
{
|
|
37854
|
+
"type": "string"
|
|
37855
|
+
},
|
|
37856
|
+
{
|
|
37857
|
+
"type": "null"
|
|
37858
|
+
}
|
|
37859
|
+
],
|
|
37860
|
+
"title": "End Call Text"
|
|
37861
|
+
},
|
|
37862
|
+
"expand_text": {
|
|
37863
|
+
"description": "The expand text of the widget",
|
|
37864
|
+
"anyOf": [
|
|
37865
|
+
{
|
|
37866
|
+
"type": "string"
|
|
37867
|
+
},
|
|
37868
|
+
{
|
|
37869
|
+
"type": "null"
|
|
37870
|
+
}
|
|
37871
|
+
],
|
|
37872
|
+
"title": "Expand Text"
|
|
37873
|
+
},
|
|
37874
|
+
"listening_text": {
|
|
37875
|
+
"description": "The text to display when the agent is listening",
|
|
37876
|
+
"anyOf": [
|
|
37877
|
+
{
|
|
37878
|
+
"type": "string"
|
|
37879
|
+
},
|
|
37880
|
+
{
|
|
37881
|
+
"type": "null"
|
|
37882
|
+
}
|
|
37883
|
+
],
|
|
37884
|
+
"title": "Listening Text"
|
|
37885
|
+
},
|
|
37886
|
+
"speaking_text": {
|
|
37887
|
+
"description": "The text to display when the agent is speaking",
|
|
37888
|
+
"anyOf": [
|
|
37889
|
+
{
|
|
37890
|
+
"type": "string"
|
|
37891
|
+
},
|
|
37892
|
+
{
|
|
37893
|
+
"type": "null"
|
|
37894
|
+
}
|
|
37895
|
+
],
|
|
37896
|
+
"title": "Speaking Text"
|
|
37897
|
+
},
|
|
37898
|
+
"shareable_page_text": {
|
|
37899
|
+
"description": "The text to display when sharing",
|
|
37900
|
+
"anyOf": [
|
|
37901
|
+
{
|
|
37902
|
+
"type": "string"
|
|
37903
|
+
},
|
|
37904
|
+
{
|
|
37905
|
+
"type": "null"
|
|
37906
|
+
}
|
|
37907
|
+
],
|
|
37908
|
+
"title": "Shareable Page Text"
|
|
37909
|
+
},
|
|
37910
|
+
"shareable_page_show_terms": {
|
|
37911
|
+
"description": "Whether to show terms and conditions on the shareable page",
|
|
37912
|
+
"type": "boolean",
|
|
37913
|
+
"default": true,
|
|
37914
|
+
"title": "Shareable Page Show Terms"
|
|
37915
|
+
},
|
|
37916
|
+
"terms_text": {
|
|
37917
|
+
"description": "The text to display for terms and conditions",
|
|
37918
|
+
"anyOf": [
|
|
37919
|
+
{
|
|
37920
|
+
"type": "string"
|
|
37921
|
+
},
|
|
37922
|
+
{
|
|
37923
|
+
"type": "null"
|
|
37924
|
+
}
|
|
37925
|
+
],
|
|
37926
|
+
"title": "Terms Text"
|
|
37927
|
+
},
|
|
37928
|
+
"terms_html": {
|
|
37929
|
+
"description": "The HTML to display for terms and conditions",
|
|
37930
|
+
"anyOf": [
|
|
37931
|
+
{
|
|
37932
|
+
"type": "string"
|
|
37933
|
+
},
|
|
37934
|
+
{
|
|
37935
|
+
"type": "null"
|
|
37936
|
+
}
|
|
37937
|
+
],
|
|
37938
|
+
"title": "Terms Html"
|
|
37939
|
+
},
|
|
37940
|
+
"terms_key": {
|
|
37941
|
+
"description": "The key to display for terms and conditions",
|
|
37942
|
+
"anyOf": [
|
|
37943
|
+
{
|
|
37944
|
+
"type": "string"
|
|
37945
|
+
},
|
|
37946
|
+
{
|
|
37947
|
+
"type": "null"
|
|
37948
|
+
}
|
|
37949
|
+
],
|
|
37950
|
+
"title": "Terms Key"
|
|
37951
|
+
},
|
|
37952
|
+
"show_avatar_when_collapsed": {
|
|
37953
|
+
"description": "Whether to show the avatar when the widget is collapsed",
|
|
37954
|
+
"default": false,
|
|
37955
|
+
"anyOf": [
|
|
37956
|
+
{
|
|
37957
|
+
"type": "boolean"
|
|
37958
|
+
},
|
|
37959
|
+
{
|
|
37960
|
+
"type": "null"
|
|
37961
|
+
}
|
|
37962
|
+
],
|
|
37963
|
+
"title": "Show Avatar When Collapsed"
|
|
37964
|
+
},
|
|
37965
|
+
"disable_banner": {
|
|
37966
|
+
"description": "Whether to disable the banner",
|
|
37967
|
+
"type": "boolean",
|
|
37968
|
+
"default": false,
|
|
37969
|
+
"title": "Disable Banner"
|
|
37970
|
+
},
|
|
37971
|
+
"override_link": {
|
|
37972
|
+
"description": "The override link for the widget",
|
|
37973
|
+
"anyOf": [
|
|
37974
|
+
{
|
|
37975
|
+
"type": "string"
|
|
37976
|
+
},
|
|
37977
|
+
{
|
|
37978
|
+
"type": "null"
|
|
37979
|
+
}
|
|
37980
|
+
],
|
|
37981
|
+
"title": "Override Link"
|
|
37982
|
+
},
|
|
37983
|
+
"mic_muting_enabled": {
|
|
37984
|
+
"description": "Whether to enable mic muting",
|
|
37985
|
+
"type": "boolean",
|
|
37986
|
+
"default": false,
|
|
37987
|
+
"title": "Mic Muting Enabled"
|
|
37988
|
+
},
|
|
37989
|
+
"transcript_enabled": {
|
|
37990
|
+
"description": "Whether the widget should show the conversation transcript as it goes on",
|
|
37991
|
+
"type": "boolean",
|
|
37992
|
+
"default": false,
|
|
37993
|
+
"title": "Transcript Enabled"
|
|
37994
|
+
},
|
|
37995
|
+
"text_input_enabled": {
|
|
37996
|
+
"description": "Whether the user should be able to send text messages",
|
|
37997
|
+
"type": "boolean",
|
|
37998
|
+
"default": true,
|
|
37999
|
+
"title": "Text Input Enabled"
|
|
38000
|
+
},
|
|
38001
|
+
"text_contents": {
|
|
38002
|
+
"description": "Text contents of the widget",
|
|
38003
|
+
"$ref": "#/components/schemas/WidgetTextContents"
|
|
38004
|
+
},
|
|
38005
|
+
"language_selector": {
|
|
38006
|
+
"description": "Whether to show the language selector",
|
|
38007
|
+
"type": "boolean",
|
|
38008
|
+
"default": false,
|
|
38009
|
+
"title": "Language Selector"
|
|
38010
|
+
},
|
|
38011
|
+
"supports_text_only": {
|
|
38012
|
+
"description": "Whether the widget can switch to text only mode",
|
|
38013
|
+
"type": "boolean",
|
|
38014
|
+
"default": true,
|
|
38015
|
+
"title": "Supports Text Only"
|
|
38016
|
+
},
|
|
38017
|
+
"custom_avatar_path": {
|
|
38018
|
+
"description": "The custom avatar path",
|
|
38019
|
+
"anyOf": [
|
|
38020
|
+
{
|
|
38021
|
+
"type": "string"
|
|
38022
|
+
},
|
|
38023
|
+
{
|
|
38024
|
+
"type": "null"
|
|
38025
|
+
}
|
|
38026
|
+
],
|
|
38027
|
+
"title": "Custom Avatar Path"
|
|
38028
|
+
},
|
|
38029
|
+
"language_presets": {
|
|
38030
|
+
"description": "Language presets for the widget",
|
|
38031
|
+
"type": "object",
|
|
38032
|
+
"additionalProperties": {
|
|
38033
|
+
"$ref": "#/components/schemas/WidgetLanguagePreset"
|
|
38034
|
+
},
|
|
38035
|
+
"title": "Language Presets"
|
|
38036
|
+
}
|
|
38037
|
+
},
|
|
38038
|
+
"example": {
|
|
38039
|
+
"custom_avatar_path": "https://example.com/avatar.png",
|
|
38040
|
+
"language_selector": false
|
|
38041
|
+
},
|
|
38042
|
+
"title": "WidgetConfig"
|
|
38043
|
+
},
|
|
38044
|
+
"WidgetConfig-Output": {
|
|
38045
|
+
"type": "object",
|
|
38046
|
+
"properties": {
|
|
38047
|
+
"variant": {
|
|
38048
|
+
"description": "The variant of the widget",
|
|
38049
|
+
"default": "full",
|
|
38050
|
+
"$ref": "#/components/schemas/EmbedVariant"
|
|
38051
|
+
},
|
|
38052
|
+
"placement": {
|
|
38053
|
+
"description": "The placement of the widget on the screen",
|
|
38054
|
+
"default": "bottom-right",
|
|
38055
|
+
"$ref": "#/components/schemas/WidgetPlacement"
|
|
38056
|
+
},
|
|
36023
38057
|
"expandable": {
|
|
36024
38058
|
"description": "Whether the widget is expandable",
|
|
36025
38059
|
"default": "never",
|
|
@@ -36268,12 +38302,34 @@
|
|
|
36268
38302
|
"default": false,
|
|
36269
38303
|
"title": "Mic Muting Enabled"
|
|
36270
38304
|
},
|
|
38305
|
+
"transcript_enabled": {
|
|
38306
|
+
"description": "Whether the widget should show the conversation transcript as it goes on",
|
|
38307
|
+
"type": "boolean",
|
|
38308
|
+
"default": false,
|
|
38309
|
+
"title": "Transcript Enabled"
|
|
38310
|
+
},
|
|
38311
|
+
"text_input_enabled": {
|
|
38312
|
+
"description": "Whether the user should be able to send text messages",
|
|
38313
|
+
"type": "boolean",
|
|
38314
|
+
"default": true,
|
|
38315
|
+
"title": "Text Input Enabled"
|
|
38316
|
+
},
|
|
38317
|
+
"text_contents": {
|
|
38318
|
+
"description": "Text contents of the widget",
|
|
38319
|
+
"$ref": "#/components/schemas/WidgetTextContents"
|
|
38320
|
+
},
|
|
36271
38321
|
"language_selector": {
|
|
36272
38322
|
"description": "Whether to show the language selector",
|
|
36273
38323
|
"type": "boolean",
|
|
36274
38324
|
"default": false,
|
|
36275
38325
|
"title": "Language Selector"
|
|
36276
38326
|
},
|
|
38327
|
+
"supports_text_only": {
|
|
38328
|
+
"description": "Whether the widget can switch to text only mode",
|
|
38329
|
+
"type": "boolean",
|
|
38330
|
+
"default": true,
|
|
38331
|
+
"title": "Supports Text Only"
|
|
38332
|
+
},
|
|
36277
38333
|
"custom_avatar_path": {
|
|
36278
38334
|
"description": "The custom avatar path",
|
|
36279
38335
|
"anyOf": [
|
|
@@ -36285,6 +38341,14 @@
|
|
|
36285
38341
|
}
|
|
36286
38342
|
],
|
|
36287
38343
|
"title": "Custom Avatar Path"
|
|
38344
|
+
},
|
|
38345
|
+
"language_presets": {
|
|
38346
|
+
"description": "Language presets for the widget",
|
|
38347
|
+
"type": "object",
|
|
38348
|
+
"additionalProperties": {
|
|
38349
|
+
"$ref": "#/components/schemas/WidgetLanguagePreset"
|
|
38350
|
+
},
|
|
38351
|
+
"title": "Language Presets"
|
|
36288
38352
|
}
|
|
36289
38353
|
},
|
|
36290
38354
|
"example": {
|
|
@@ -36301,6 +38365,11 @@
|
|
|
36301
38365
|
"default": "full",
|
|
36302
38366
|
"$ref": "#/components/schemas/EmbedVariant"
|
|
36303
38367
|
},
|
|
38368
|
+
"placement": {
|
|
38369
|
+
"description": "The placement of the widget on the screen",
|
|
38370
|
+
"default": "bottom-right",
|
|
38371
|
+
"$ref": "#/components/schemas/WidgetPlacement"
|
|
38372
|
+
},
|
|
36304
38373
|
"expandable": {
|
|
36305
38374
|
"description": "Whether the widget is expandable",
|
|
36306
38375
|
"default": "never",
|
|
@@ -36549,6 +38618,22 @@
|
|
|
36549
38618
|
"default": false,
|
|
36550
38619
|
"title": "Mic Muting Enabled"
|
|
36551
38620
|
},
|
|
38621
|
+
"transcript_enabled": {
|
|
38622
|
+
"description": "Whether the widget should show the conversation transcript as it goes on",
|
|
38623
|
+
"type": "boolean",
|
|
38624
|
+
"default": false,
|
|
38625
|
+
"title": "Transcript Enabled"
|
|
38626
|
+
},
|
|
38627
|
+
"text_input_enabled": {
|
|
38628
|
+
"description": "Whether the user should be able to send text messages",
|
|
38629
|
+
"type": "boolean",
|
|
38630
|
+
"default": true,
|
|
38631
|
+
"title": "Text Input Enabled"
|
|
38632
|
+
},
|
|
38633
|
+
"text_contents": {
|
|
38634
|
+
"description": "Text contents of the widget",
|
|
38635
|
+
"$ref": "#/components/schemas/WidgetTextContents"
|
|
38636
|
+
},
|
|
36552
38637
|
"language": {
|
|
36553
38638
|
"type": "string",
|
|
36554
38639
|
"title": "Language"
|
|
@@ -36566,6 +38651,37 @@
|
|
|
36566
38651
|
}
|
|
36567
38652
|
],
|
|
36568
38653
|
"title": "Supported Language Overrides"
|
|
38654
|
+
},
|
|
38655
|
+
"language_presets": {
|
|
38656
|
+
"description": "Language presets for the widget",
|
|
38657
|
+
"type": "object",
|
|
38658
|
+
"additionalProperties": {
|
|
38659
|
+
"$ref": "#/components/schemas/WidgetLanguagePresetResponse"
|
|
38660
|
+
},
|
|
38661
|
+
"title": "Language Presets"
|
|
38662
|
+
},
|
|
38663
|
+
"text_only": {
|
|
38664
|
+
"description": "Whether the agent uses text-only mode",
|
|
38665
|
+
"type": "boolean",
|
|
38666
|
+
"default": false,
|
|
38667
|
+
"title": "Text Only"
|
|
38668
|
+
},
|
|
38669
|
+
"supports_text_only": {
|
|
38670
|
+
"description": "Whether the agent can be switched to text-only mode",
|
|
38671
|
+
"type": "boolean",
|
|
38672
|
+
"default": false,
|
|
38673
|
+
"title": "Supports Text Only"
|
|
38674
|
+
},
|
|
38675
|
+
"first_message": {
|
|
38676
|
+
"anyOf": [
|
|
38677
|
+
{
|
|
38678
|
+
"type": "string"
|
|
38679
|
+
},
|
|
38680
|
+
{
|
|
38681
|
+
"type": "null"
|
|
38682
|
+
}
|
|
38683
|
+
],
|
|
38684
|
+
"title": "First Message"
|
|
36569
38685
|
}
|
|
36570
38686
|
},
|
|
36571
38687
|
"example": {
|
|
@@ -36618,6 +38734,321 @@
|
|
|
36618
38734
|
],
|
|
36619
38735
|
"title": "WidgetFeedbackMode"
|
|
36620
38736
|
},
|
|
38737
|
+
"WidgetLanguagePreset": {
|
|
38738
|
+
"type": "object",
|
|
38739
|
+
"properties": {
|
|
38740
|
+
"text_contents": {
|
|
38741
|
+
"description": "The text contents for the selected language",
|
|
38742
|
+
"anyOf": [
|
|
38743
|
+
{
|
|
38744
|
+
"$ref": "#/components/schemas/WidgetTextContents"
|
|
38745
|
+
},
|
|
38746
|
+
{
|
|
38747
|
+
"type": "null"
|
|
38748
|
+
}
|
|
38749
|
+
]
|
|
38750
|
+
}
|
|
38751
|
+
},
|
|
38752
|
+
"title": "WidgetLanguagePreset"
|
|
38753
|
+
},
|
|
38754
|
+
"WidgetLanguagePresetResponse": {
|
|
38755
|
+
"type": "object",
|
|
38756
|
+
"properties": {
|
|
38757
|
+
"first_message": {
|
|
38758
|
+
"anyOf": [
|
|
38759
|
+
{
|
|
38760
|
+
"type": "string"
|
|
38761
|
+
},
|
|
38762
|
+
{
|
|
38763
|
+
"type": "null"
|
|
38764
|
+
}
|
|
38765
|
+
],
|
|
38766
|
+
"title": "First Message"
|
|
38767
|
+
},
|
|
38768
|
+
"text_contents": {
|
|
38769
|
+
"description": "The text contents for the selected language",
|
|
38770
|
+
"anyOf": [
|
|
38771
|
+
{
|
|
38772
|
+
"$ref": "#/components/schemas/WidgetTextContents"
|
|
38773
|
+
},
|
|
38774
|
+
{
|
|
38775
|
+
"type": "null"
|
|
38776
|
+
}
|
|
38777
|
+
]
|
|
38778
|
+
}
|
|
38779
|
+
},
|
|
38780
|
+
"title": "WidgetLanguagePresetResponse"
|
|
38781
|
+
},
|
|
38782
|
+
"WidgetPlacement": {
|
|
38783
|
+
"type": "string",
|
|
38784
|
+
"enum": [
|
|
38785
|
+
"top-left",
|
|
38786
|
+
"top",
|
|
38787
|
+
"top-right",
|
|
38788
|
+
"bottom-left",
|
|
38789
|
+
"bottom",
|
|
38790
|
+
"bottom-right"
|
|
38791
|
+
],
|
|
38792
|
+
"title": "WidgetPlacement"
|
|
38793
|
+
},
|
|
38794
|
+
"WidgetTextContents": {
|
|
38795
|
+
"type": "object",
|
|
38796
|
+
"properties": {
|
|
38797
|
+
"main_label": {
|
|
38798
|
+
"description": "Call to action displayed inside the compact and full variants.",
|
|
38799
|
+
"anyOf": [
|
|
38800
|
+
{
|
|
38801
|
+
"type": "string"
|
|
38802
|
+
},
|
|
38803
|
+
{
|
|
38804
|
+
"type": "null"
|
|
38805
|
+
}
|
|
38806
|
+
],
|
|
38807
|
+
"title": "Main Label"
|
|
38808
|
+
},
|
|
38809
|
+
"start_call": {
|
|
38810
|
+
"description": "Text and ARIA label for the start call button.",
|
|
38811
|
+
"anyOf": [
|
|
38812
|
+
{
|
|
38813
|
+
"type": "string"
|
|
38814
|
+
},
|
|
38815
|
+
{
|
|
38816
|
+
"type": "null"
|
|
38817
|
+
}
|
|
38818
|
+
],
|
|
38819
|
+
"title": "Start Call"
|
|
38820
|
+
},
|
|
38821
|
+
"new_call": {
|
|
38822
|
+
"description": "Text and ARIA label for the new call button. Displayed when the caller already finished at least one call in order ot start the next one.",
|
|
38823
|
+
"anyOf": [
|
|
38824
|
+
{
|
|
38825
|
+
"type": "string"
|
|
38826
|
+
},
|
|
38827
|
+
{
|
|
38828
|
+
"type": "null"
|
|
38829
|
+
}
|
|
38830
|
+
],
|
|
38831
|
+
"title": "New Call"
|
|
38832
|
+
},
|
|
38833
|
+
"end_call": {
|
|
38834
|
+
"description": "Text and ARIA label for the end call button.",
|
|
38835
|
+
"anyOf": [
|
|
38836
|
+
{
|
|
38837
|
+
"type": "string"
|
|
38838
|
+
},
|
|
38839
|
+
{
|
|
38840
|
+
"type": "null"
|
|
38841
|
+
}
|
|
38842
|
+
],
|
|
38843
|
+
"title": "End Call"
|
|
38844
|
+
},
|
|
38845
|
+
"mute_microphone": {
|
|
38846
|
+
"description": "ARIA label for the mute microphone button.",
|
|
38847
|
+
"anyOf": [
|
|
38848
|
+
{
|
|
38849
|
+
"type": "string"
|
|
38850
|
+
},
|
|
38851
|
+
{
|
|
38852
|
+
"type": "null"
|
|
38853
|
+
}
|
|
38854
|
+
],
|
|
38855
|
+
"title": "Mute Microphone"
|
|
38856
|
+
},
|
|
38857
|
+
"change_language": {
|
|
38858
|
+
"description": "ARIA label for the change language dropdown.",
|
|
38859
|
+
"anyOf": [
|
|
38860
|
+
{
|
|
38861
|
+
"type": "string"
|
|
38862
|
+
},
|
|
38863
|
+
{
|
|
38864
|
+
"type": "null"
|
|
38865
|
+
}
|
|
38866
|
+
],
|
|
38867
|
+
"title": "Change Language"
|
|
38868
|
+
},
|
|
38869
|
+
"collapse": {
|
|
38870
|
+
"description": "ARIA label for the collapse button.",
|
|
38871
|
+
"anyOf": [
|
|
38872
|
+
{
|
|
38873
|
+
"type": "string"
|
|
38874
|
+
},
|
|
38875
|
+
{
|
|
38876
|
+
"type": "null"
|
|
38877
|
+
}
|
|
38878
|
+
],
|
|
38879
|
+
"title": "Collapse"
|
|
38880
|
+
},
|
|
38881
|
+
"expand": {
|
|
38882
|
+
"description": "ARIA label for the expand button.",
|
|
38883
|
+
"anyOf": [
|
|
38884
|
+
{
|
|
38885
|
+
"type": "string"
|
|
38886
|
+
},
|
|
38887
|
+
{
|
|
38888
|
+
"type": "null"
|
|
38889
|
+
}
|
|
38890
|
+
],
|
|
38891
|
+
"title": "Expand"
|
|
38892
|
+
},
|
|
38893
|
+
"copied": {
|
|
38894
|
+
"description": "Text displayed when the user copies a value using the copy button.",
|
|
38895
|
+
"anyOf": [
|
|
38896
|
+
{
|
|
38897
|
+
"type": "string"
|
|
38898
|
+
},
|
|
38899
|
+
{
|
|
38900
|
+
"type": "null"
|
|
38901
|
+
}
|
|
38902
|
+
],
|
|
38903
|
+
"title": "Copied"
|
|
38904
|
+
},
|
|
38905
|
+
"accept_terms": {
|
|
38906
|
+
"description": "Text and ARIA label for the accept terms button.",
|
|
38907
|
+
"anyOf": [
|
|
38908
|
+
{
|
|
38909
|
+
"type": "string"
|
|
38910
|
+
},
|
|
38911
|
+
{
|
|
38912
|
+
"type": "null"
|
|
38913
|
+
}
|
|
38914
|
+
],
|
|
38915
|
+
"title": "Accept Terms"
|
|
38916
|
+
},
|
|
38917
|
+
"dismiss_terms": {
|
|
38918
|
+
"description": "Text and ARIA label for the cancel terms button.",
|
|
38919
|
+
"anyOf": [
|
|
38920
|
+
{
|
|
38921
|
+
"type": "string"
|
|
38922
|
+
},
|
|
38923
|
+
{
|
|
38924
|
+
"type": "null"
|
|
38925
|
+
}
|
|
38926
|
+
],
|
|
38927
|
+
"title": "Dismiss Terms"
|
|
38928
|
+
},
|
|
38929
|
+
"listening_status": {
|
|
38930
|
+
"description": "Status displayed when the agent is listening.",
|
|
38931
|
+
"anyOf": [
|
|
38932
|
+
{
|
|
38933
|
+
"type": "string"
|
|
38934
|
+
},
|
|
38935
|
+
{
|
|
38936
|
+
"type": "null"
|
|
38937
|
+
}
|
|
38938
|
+
],
|
|
38939
|
+
"title": "Listening Status"
|
|
38940
|
+
},
|
|
38941
|
+
"speaking_status": {
|
|
38942
|
+
"description": "Status displayed when the agent is speaking.",
|
|
38943
|
+
"anyOf": [
|
|
38944
|
+
{
|
|
38945
|
+
"type": "string"
|
|
38946
|
+
},
|
|
38947
|
+
{
|
|
38948
|
+
"type": "null"
|
|
38949
|
+
}
|
|
38950
|
+
],
|
|
38951
|
+
"title": "Speaking Status"
|
|
38952
|
+
},
|
|
38953
|
+
"connecting_status": {
|
|
38954
|
+
"description": "Status displayed when the agent is connecting.",
|
|
38955
|
+
"anyOf": [
|
|
38956
|
+
{
|
|
38957
|
+
"type": "string"
|
|
38958
|
+
},
|
|
38959
|
+
{
|
|
38960
|
+
"type": "null"
|
|
38961
|
+
}
|
|
38962
|
+
],
|
|
38963
|
+
"title": "Connecting Status"
|
|
38964
|
+
},
|
|
38965
|
+
"input_label": {
|
|
38966
|
+
"description": "ARIA label for the text message input.",
|
|
38967
|
+
"anyOf": [
|
|
38968
|
+
{
|
|
38969
|
+
"type": "string"
|
|
38970
|
+
},
|
|
38971
|
+
{
|
|
38972
|
+
"type": "null"
|
|
38973
|
+
}
|
|
38974
|
+
],
|
|
38975
|
+
"title": "Input Label"
|
|
38976
|
+
},
|
|
38977
|
+
"input_placeholder": {
|
|
38978
|
+
"description": "Placeholder text for the text message input.",
|
|
38979
|
+
"anyOf": [
|
|
38980
|
+
{
|
|
38981
|
+
"type": "string"
|
|
38982
|
+
},
|
|
38983
|
+
{
|
|
38984
|
+
"type": "null"
|
|
38985
|
+
}
|
|
38986
|
+
],
|
|
38987
|
+
"title": "Input Placeholder"
|
|
38988
|
+
},
|
|
38989
|
+
"user_ended_conversation": {
|
|
38990
|
+
"description": "Information message displayed when the user ends the conversation.",
|
|
38991
|
+
"anyOf": [
|
|
38992
|
+
{
|
|
38993
|
+
"type": "string"
|
|
38994
|
+
},
|
|
38995
|
+
{
|
|
38996
|
+
"type": "null"
|
|
38997
|
+
}
|
|
38998
|
+
],
|
|
38999
|
+
"title": "User Ended Conversation"
|
|
39000
|
+
},
|
|
39001
|
+
"agent_ended_conversation": {
|
|
39002
|
+
"description": "Information message displayed when the agent ends the conversation.",
|
|
39003
|
+
"anyOf": [
|
|
39004
|
+
{
|
|
39005
|
+
"type": "string"
|
|
39006
|
+
},
|
|
39007
|
+
{
|
|
39008
|
+
"type": "null"
|
|
39009
|
+
}
|
|
39010
|
+
],
|
|
39011
|
+
"title": "Agent Ended Conversation"
|
|
39012
|
+
},
|
|
39013
|
+
"conversation_id": {
|
|
39014
|
+
"description": "Text label used next to the conversation ID.",
|
|
39015
|
+
"anyOf": [
|
|
39016
|
+
{
|
|
39017
|
+
"type": "string"
|
|
39018
|
+
},
|
|
39019
|
+
{
|
|
39020
|
+
"type": "null"
|
|
39021
|
+
}
|
|
39022
|
+
],
|
|
39023
|
+
"title": "Conversation Id"
|
|
39024
|
+
},
|
|
39025
|
+
"error_occurred": {
|
|
39026
|
+
"description": "Text label used when an error occurs.",
|
|
39027
|
+
"anyOf": [
|
|
39028
|
+
{
|
|
39029
|
+
"type": "string"
|
|
39030
|
+
},
|
|
39031
|
+
{
|
|
39032
|
+
"type": "null"
|
|
39033
|
+
}
|
|
39034
|
+
],
|
|
39035
|
+
"title": "Error Occurred"
|
|
39036
|
+
},
|
|
39037
|
+
"copy_id": {
|
|
39038
|
+
"description": "Text and ARIA label used for the copy ID button.",
|
|
39039
|
+
"anyOf": [
|
|
39040
|
+
{
|
|
39041
|
+
"type": "string"
|
|
39042
|
+
},
|
|
39043
|
+
{
|
|
39044
|
+
"type": "null"
|
|
39045
|
+
}
|
|
39046
|
+
],
|
|
39047
|
+
"title": "Copy Id"
|
|
39048
|
+
}
|
|
39049
|
+
},
|
|
39050
|
+
"title": "WidgetTextContents"
|
|
39051
|
+
},
|
|
36621
39052
|
"WorkspaceBatchCallsResponse": {
|
|
36622
39053
|
"type": "object",
|
|
36623
39054
|
"properties": {
|