@elevenlabs/elevenlabs-js 2.2.0 → 2.4.0

package/.mock/definition/api.yml

@@ -1,24 +0,0 @@
-name: api
-error-discrimination:
-  strategy: status-code
-display-name: ElevenLabs API Documentation
-environments:
-  Production:
-    urls:
-      Base: https://api.elevenlabs.io/
-      WSS: wss://api.elevenlabs.io
-  Production US:
-    urls:
-      Base: https://api.us.elevenlabs.io/
-      WSS: wss://api.elevenlabs.io
-  Production EU:
-    urls:
-      Base: https://api.eu.residency.elevenlabs.io
-      WSS: wss://api.elevenlabs.io
-default-environment: Production
-default-url: Base
-headers:
-  xi-api-key:
-    name: api-key
-    env: ELEVENLABS_API_KEY
-    type: optional<string>

package/.mock/definition/audioIsolation.yml

@@ -1,83 +0,0 @@
-types:
-  AudioIsolationConvertRequestFileFormat:
-    enum:
-      - pcm_s16le_16
-      - other
-    inline: true
-    source:
-      openapi: openapi.json
-  AudioIsolationStreamRequestFileFormat:
-    enum:
-      - pcm_s16le_16
-      - other
-    inline: true
-    source:
-      openapi: openapi.json
-imports:
-  root: __package__.yml
-service:
-  auth: false
-  base-path: ''
-  endpoints:
-    convert:
-      path: /v1/audio-isolation
-      method: POST
-      auth: false
-      docs: Removes background noise from audio.
-      source:
-        openapi: openapi.json
-      display-name: Audio isolation
-      request:
-        name: Body_Audio_Isolation_v1_audio_isolation_post
-        body:
-          properties:
-            audio:
-              type: file
-              docs: The audio file from which vocals/speech will be isolated from.
-            file_format:
-              type: optional<AudioIsolationConvertRequestFileFormat>
-              docs: >-
-                The format of input audio. Options are 'pcm_s16le_16' or 'other'
-                For `pcm_s16le_16`, the input audio must be 16-bit PCM at a
-                16kHz sample rate, single channel (mono), and little-endian byte
-                order. Latency will be lower than with passing an encoded
-                waveform.
-        content-type: multipart/form-data
-      response:
-        docs: Successful Response
-        type: file
-        status-code: 200
-      errors:
-        - root.UnprocessableEntityError
-    stream:
-      path: /v1/audio-isolation/stream
-      method: POST
-      auth: false
-      docs: Removes background noise from audio.
-      source:
-        openapi: openapi.json
-      display-name: Audio isolation stream
-      request:
-        name: Body_Audio_Isolation_Stream_v1_audio_isolation_stream_post
-        body:
-          properties:
-            audio:
-              type: file
-              docs: The audio file from which vocals/speech will be isolated from.
-            file_format:
-              type: optional<AudioIsolationStreamRequestFileFormat>
-              docs: >-
-                The format of input audio. Options are 'pcm_s16le_16' or 'other'
-                For `pcm_s16le_16`, the input audio must be 16-bit PCM at a
-                16kHz sample rate, single channel (mono), and little-endian byte
-                order. Latency will be lower than with passing an encoded
-                waveform.
-        content-type: multipart/form-data
-      response:
-        docs: Successful Response
-        type: file
-        status-code: 200
-      errors:
-        - root.UnprocessableEntityError
-  source:
-    openapi: openapi.json

package/.mock/definition/audioNative.yml

@@ -1,198 +0,0 @@
-imports:
-  root: __package__.yml
-service:
-  auth: false
-  base-path: ''
-  endpoints:
-    create:
-      path: /v1/audio-native
-      method: POST
-      auth: false
-      docs: >-
-        Creates Audio Native enabled project, optionally starts conversion and
-        returns project ID and embeddable HTML snippet.
-      source:
-        openapi: openapi.json
-      display-name: Create audio native project
-      request:
-        name: Body_Creates_Audio_Native_enabled_project__v1_audio_native_post
-        body:
-          properties:
-            name:
-              type: string
-              docs: Project name.
-            image:
-              type: optional<string>
-              docs: >-
-                (Deprecated) Image URL used in the player. If not provided,
-                default image set in the Player settings is used.
-              availability: deprecated
-            author:
-              type: optional<string>
-              docs: >-
-                Author used in the player and inserted at the start of the
-                uploaded article. If not provided, the default author set in the
-                Player settings is used.
-            title:
-              type: optional<string>
-              docs: >-
-                Title used in the player and inserted at the top of the uploaded
-                article. If not provided, the default title set in the Player
-                settings is used.
-            small:
-              type: optional<boolean>
-              docs: >-
-                (Deprecated) Whether to use small player or not. If not
-                provided, default value set in the Player settings is used.
-              default: false
-              availability: deprecated
-            text_color:
-              type: optional<string>
-              docs: >-
-                Text color used in the player. If not provided, default text
-                color set in the Player settings is used.
-            background_color:
-              type: optional<string>
-              docs: >-
-                Background color used in the player. If not provided, default
-                background color set in the Player settings is used.
-            sessionization:
-              type: optional<integer>
-              docs: >-
-                (Deprecated) Specifies for how many minutes to persist the
-                session across page reloads. If not provided, default
-                sessionization set in the Player settings is used.
-              default: 0
-              availability: deprecated
-            voice_id:
-              type: optional<string>
-              docs: >-
-                Voice ID used to voice the content. If not provided, default
-                voice ID set in the Player settings is used.
-            model_id:
-              type: optional<string>
-              docs: >-
-                TTS Model ID used in the player. If not provided, default model
-                ID set in the Player settings is used.
-            file:
-              type: optional<file>
-              docs: >-
-                Either txt or HTML input file containing the article content.
-                HTML should be formatted as follows
-                '&lt;html&gt;&lt;body&gt;&lt;div&gt;&lt;p&gt;Your
-                content&lt;/p&gt;&lt;h3&gt;More of your
-                content&lt;/h3&gt;&lt;p&gt;Some more of your
-                content&lt;/p&gt;&lt;/div&gt;&lt;/body&gt;&lt;/html&gt;'
-            auto_convert:
-              type: optional<boolean>
-              docs: Whether to auto convert the project to audio or not.
-              default: false
-        content-type: multipart/form-data
-      response:
-        docs: Successful Response
-        type: root.AudioNativeCreateProjectResponseModel
-        status-code: 200
-      errors:
-        - root.UnprocessableEntityError
-      examples:
-        - request:
-            name: name
-          response:
-            body:
-              project_id: JBFqnCBsd6RMkjVDRZzb
-              converting: false
-              html_snippet: <div id='audio-native-player'></div>
-    get_settings:
-      path: /v1/audio-native/{project_id}/settings
-      method: GET
-      auth: false
-      docs: Get player settings for the specific project.
-      source:
-        openapi: openapi.json
-      path-parameters:
-        project_id:
-          type: string
-          docs: The ID of the Studio project.
-      display-name: Get Audio Native Project Settings
-      response:
-        docs: Successful Response
-        type: root.GetAudioNativeProjectSettingsResponseModel
-        status-code: 200
-      errors:
-        - root.UnprocessableEntityError
-      examples:
-        - path-parameters:
-            project_id: 21m00Tcm4TlvDq8ikWAM
-          response:
-            body:
-              enabled: true
-              snapshot_id: JBFqnCBsd6RMkjVDRZzb
-              settings:
-                title: My Project
-                image: https://example.com/image.jpg
-                author: John Doe
-                small: false
-                text_color: '#000000'
-                background_color: '#FFFFFF'
-                sessionization: 1
-                audio_path: audio/my_project.mp3
-                audio_url: https://example.com/audio/my_project.mp3
-                status: ready
-    update:
-      path: /v1/audio-native/{project_id}/content
-      method: POST
-      auth: false
-      docs: Updates content for the specific AudioNative Project.
-      source:
-        openapi: openapi.json
-      path-parameters:
-        project_id:
-          type: string
-          docs: >-
-            The ID of the project to be used. You can use the [List
-            projects](/docs/api-reference/studio/get-projects) endpoint to list
-            all the available projects.
-      display-name: Update audio native project
-      request:
-        name: >-
-          Body_Update_audio_native_Project_content_v1_audio_native__project_id__content_post
-        body:
-          properties:
-            file:
-              type: optional<file>
-              docs: >-
-                Either txt or HTML input file containing the article content.
-                HTML should be formatted as follows
-                '&lt;html&gt;&lt;body&gt;&lt;div&gt;&lt;p&gt;Your
-                content&lt;/p&gt;&lt;h5&gt;More of your
-                content&lt;/h5&gt;&lt;p&gt;Some more of your
-                content&lt;/p&gt;&lt;/div&gt;&lt;/body&gt;&lt;/html&gt;'
-            auto_convert:
-              type: optional<boolean>
-              docs: Whether to auto convert the project to audio or not.
-              default: false
-            auto_publish:
-              type: optional<boolean>
-              docs: >-
-                Whether to auto publish the new project snapshot after it's
-                converted.
-              default: false
-        content-type: multipart/form-data
-      response:
-        docs: Successful Response
-        type: root.AudioNativeEditContentResponseModel
-        status-code: 200
-      errors:
-        - root.UnprocessableEntityError
-      examples:
-        - path-parameters:
-            project_id: 21m00Tcm4TlvDq8ikWAM
-          request: {}
-          response:
-            body:
-              project_id: JBFqnCBsd6RMkjVDRZzb
-              converting: false
-              publishing: false
-              html_snippet: <div id='audio-native-player'></div>
-  source:
-    openapi: openapi.json

package/.mock/definition/conversationalAi/agents/knowledgeBase.yml

@@ -1,32 +0,0 @@
-imports:
-  root: ../../__package__.yml
-service:
-  auth: false
-  base-path: ''
-  endpoints:
-    size:
-      path: /v1/convai/agent/{agent_id}/knowledge-base/size
-      method: GET
-      auth: false
-      docs: Returns the number of pages in the agent's knowledge base.
-      source:
-        openapi: openapi.json
-      path-parameters:
-        agent_id: string
-      display-name: Returns The Size Of The Agent'S Knowledge Base
-      response:
-        docs: Successful Response
-        type: root.GetAgentKnowledgebaseSizeResponseModel
-        status-code: 200
-      errors:
-        - root.UnprocessableEntityError
-      examples:
-        - path-parameters:
-            agent_id: agent_id
-          response:
-            body:
-              number_of_pages: 1.1
-      audiences:
-        - convai
-  source:
-    openapi: openapi.json

package/.mock/definition/conversationalAi/agents/link.yml

@@ -1,40 +0,0 @@
-imports:
-  root: ../../__package__.yml
-service:
-  auth: false
-  base-path: ''
-  endpoints:
-    get:
-      path: /v1/convai/agents/{agent_id}/link
-      method: GET
-      auth: false
-      docs: Get the current link used to share the agent with others
-      source:
-        openapi: openapi.json
-      path-parameters:
-        agent_id:
-          type: string
-          docs: The id of an agent. This is returned on agent creation.
-      display-name: Get Shareable Agent Link
-      response:
-        docs: Successful Response
-        type: root.GetAgentLinkResponseModel
-        status-code: 200
-      errors:
-        - root.UnprocessableEntityError
-      examples:
-        - path-parameters:
-            agent_id: 21m00Tcm4TlvDq8ikWAM
-          response:
-            body:
-              agent_id: J3Pbu5gP6NNKBscdCdwB
-              token:
-                agent_id: agent_J3Pbu5gP6NNKBscdCdwB
-                conversation_token: '1234567890'
-                expiration_time_unix_secs: 1716153600
-                conversation_id: conv_J3Pbu5gP6NNKBscdCdwB
-                purpose: signed_url
-      audiences:
-        - convai
-  source:
-    openapi: openapi.json

package/.mock/definition/conversationalAi/agents/llmUsage.yml

@@ -1,51 +0,0 @@
-imports:
-  root: ../../__package__.yml
-service:
-  auth: false
-  base-path: ''
-  endpoints:
-    calculate:
-      path: /v1/convai/agent/{agent_id}/llm-usage/calculate
-      method: POST
-      auth: false
-      docs: Calculates expected number of LLM tokens needed for the specified agent.
-      source:
-        openapi: openapi.json
-      path-parameters:
-        agent_id: string
-      display-name: Calculate Expected Llm Usage For An Agent
-      request:
-        name: LlmUsageCalculatorRequestModel
-        body:
-          properties:
-            prompt_length:
-              type: optional<integer>
-              docs: Length of the prompt in characters.
-            number_of_pages:
-              type: optional<integer>
-              docs: >-
-                Pages of content in pdf documents OR urls in agent's Knowledge
-                Base.
-            rag_enabled:
-              type: optional<boolean>
-              docs: Whether RAG is enabled.
-        content-type: application/json
-      response:
-        docs: Successful Response
-        type: root.LlmUsageCalculatorResponseModel
-        status-code: 200
-      errors:
-        - root.UnprocessableEntityError
-      examples:
-        - path-parameters:
-            agent_id: agent_id
-          request: {}
-          response:
-            body:
-              llm_prices:
-                - llm: gpt-4o-mini
-                  price_per_minute: 1.1
-      audiences:
-        - convai
-  source:
-    openapi: openapi.json

package/.mock/definition/conversationalAi/agents/widget/avatar.yml

@@ -1,44 +0,0 @@
-imports:
-  root: ../../../__package__.yml
-service:
-  auth: false
-  base-path: ''
-  endpoints:
-    create:
-      path: /v1/convai/agents/{agent_id}/avatar
-      method: POST
-      auth: false
-      docs: Sets the avatar for an agent displayed in the widget
-      source:
-        openapi: openapi.json
-      path-parameters:
-        agent_id:
-          type: string
-          docs: The id of an agent. This is returned on agent creation.
-      display-name: Post Agent Avatar
-      request:
-        name: Body_Post_Agent_avatar_v1_convai_agents__agent_id__avatar_post
-        body:
-          properties:
-            avatar_file:
-              type: file
-              docs: An image file to be used as the agent's avatar.
-        content-type: multipart/form-data
-      response:
-        docs: Successful Response
-        type: root.PostAgentAvatarResponseModel
-        status-code: 200
-      errors:
-        - root.UnprocessableEntityError
-      examples:
-        - path-parameters:
-            agent_id: 21m00Tcm4TlvDq8ikWAM
-          request: {}
-          response:
-            body:
-              agent_id: agent_id
-              avatar_url: avatar_url
-      audiences:
-        - convai
-  source:
-    openapi: openapi.json

package/.mock/definition/conversationalAi/agents/widget.yml

@@ -1,107 +0,0 @@
-imports:
-  root: ../../__package__.yml
-service:
-  auth: false
-  base-path: ''
-  endpoints:
-    get:
-      path: /v1/convai/agents/{agent_id}/widget
-      method: GET
-      auth: false
-      docs: Retrieve the widget configuration for an agent
-      source:
-        openapi: openapi.json
-      path-parameters:
-        agent_id:
-          type: string
-          docs: The id of an agent. This is returned on agent creation.
-      display-name: Get Agent Widget Config
-      request:
-        name: WidgetGetRequest
-        query-parameters:
-          conversation_signature:
-            type: optional<string>
-            docs: >-
-              An expiring token that enables a websocket conversation to start.
-              These can be generated for an agent using the
-              /v1/convai/conversation/get-signed-url endpoint
-      response:
-        docs: Successful Response
-        type: root.GetAgentEmbedResponseModel
-        status-code: 200
-      errors:
-        - root.UnprocessableEntityError
-      examples:
-        - path-parameters:
-            agent_id: 21m00Tcm4TlvDq8ikWAM
-          response:
-            body:
-              agent_id: agent_id
-              widget_config:
-                variant: full
-                placement: top-left
-                expandable: never
-                avatar:
-                  color_1: '#2792dc'
-                  color_2: '#9ce6e6'
-                  type: orb
-                feedback_mode: none
-                bg_color: '#ffffff'
-                text_color: '#000000'
-                btn_color: '#000000'
-                btn_text_color: '#ffffff'
-                border_color: '#e1e1e1'
-                focus_color: '#000000'
-                border_radius: 10
-                btn_radius: 10
-                action_text: Call
-                start_call_text: Start Call
-                end_call_text: End Call
-                expand_text: Expand
-                listening_text: Listening...
-                speaking_text: Speaking...
-                shareable_page_text: Share
-                shareable_page_show_terms: true
-                terms_text: Terms and Conditions
-                terms_html: <p>Terms and Conditions</p>
-                terms_key: terms
-                show_avatar_when_collapsed: true
-                disable_banner: false
-                override_link: override_link
-                mic_muting_enabled: false
-                transcript_enabled: true
-                text_input_enabled: true
-                text_contents:
-                  main_label: main_label
-                  start_call: start_call
-                  new_call: new_call
-                  end_call: end_call
-                  mute_microphone: mute_microphone
-                  change_language: change_language
-                  collapse: collapse
-                  expand: expand
-                  copied: copied
-                  accept_terms: accept_terms
-                  dismiss_terms: dismiss_terms
-                  listening_status: listening_status
-                  speaking_status: speaking_status
-                  connecting_status: connecting_status
-                  input_label: input_label
-                  input_placeholder: input_placeholder
-                  user_ended_conversation: user_ended_conversation
-                  agent_ended_conversation: agent_ended_conversation
-                  conversation_id: conversation_id
-                  error_occurred: error_occurred
-                  copy_id: copy_id
-                language: language
-                supported_language_overrides:
-                  - supported_language_overrides
-                language_presets:
-                  key: {}
-                text_only: true
-                supports_text_only: true
-                first_message: first_message
-      audiences:
-        - convai
-  source:
-    openapi: openapi.json