@elevenlabs/elevenlabs-js 2.0.0

package/.mock/definition/voices/pvc/samples/waveform.yml

@@ -0,0 +1,44 @@
+imports:
+  root: ../../../__package__.yml
+service:
+  auth: false
+  base-path: ''
+  endpoints:
+    get:
+      path: /v1/voices/pvc/{voice_id}/samples/{sample_id}/waveform
+      method: GET
+      auth: false
+      docs: Retrieve the visual waveform of a voice sample.
+      source:
+        openapi: openapi.json
+      path-parameters:
+        voice_id:
+          type: string
+          docs: >-
+            Voice ID to be used, you can use https://api.elevenlabs.io/v1/voices
+            to list all the available voices.
+        sample_id:
+          type: string
+          docs: Sample ID to be used
+      display-name: Retrieve Voice Sample Visual Waveform
+      response:
+        docs: Successful Response
+        type: root.VoiceSampleVisualWaveformResponseModel
+        status-code: 200
+      errors:
+        - root.UnprocessableEntityError
+      examples:
+        - path-parameters:
+            voice_id: 21m00Tcm4TlvDq8ikWAM
+            sample_id: VW7YKqPnjY4h39yTbx2L
+          response:
+            body:
+              sample_id: DCwhRBWXzGAHq8TQ4Fs18
+              visual_waveform:
+                - 0.1
+                - 0.2
+                - 0.3
+                - 0.4
+                - 0.5
+  source:
+    openapi: openapi.json

package/.mock/definition/voices/pvc/samples.yml

@@ -0,0 +1,159 @@
+imports:
+  root: ../../__package__.yml
+service:
+  auth: false
+  base-path: ''
+  endpoints:
+    create:
+      path: /v1/voices/pvc/{voice_id}/samples
+      method: POST
+      auth: false
+      docs: Add audio samples to a PVC voice
+      source:
+        openapi: openapi.json
+      path-parameters:
+        voice_id:
+          type: string
+          docs: >-
+            Voice ID to be used, you can use https://api.elevenlabs.io/v1/voices
+            to list all the available voices.
+      display-name: Add Samples To Pvc Voice
+      request:
+        name: Body_Add_samples_to_PVC_voice_v1_voices_pvc__voice_id__samples_post
+        body:
+          properties:
+            files:
+              type: list<file>
+              docs: Audio files used to create the voice.
+            remove_background_noise:
+              type: optional<boolean>
+              docs: >-
+                If set will remove background noise for voice samples using our
+                audio isolation model. If the samples do not include background
+                noise, it can make the quality worse.
+              default: false
+        content-type: multipart/form-data
+      response:
+        docs: Successful Response
+        type: list<root.VoiceSample>
+        status-code: 200
+      errors:
+        - root.UnprocessableEntityError
+      examples:
+        - path-parameters:
+            voice_id: 21m00Tcm4TlvDq8ikWAM
+          request: {}
+          response:
+            body:
+              - sample_id: DCwhRBWXzGAHq8TQ4Fs18
+                file_name: sample.mp3
+                mime_type: audio/mpeg
+                size_bytes: 1000000
+                hash: '1234567890'
+                duration_secs: 1.1
+                remove_background_noise: true
+                has_isolated_audio: true
+                has_isolated_audio_preview: true
+                speaker_separation:
+                  voice_id: DCwhRBWXzGAHq8TQ4Fs18
+                  sample_id: DCwhRBWXzGAHq8TQ4Fs18
+                  status: not_started
+                  speakers:
+                    key:
+                      speaker_id: DCwhRBWXzGAHq8TQ4Fs18
+                      duration_secs: 5
+                  selected_speaker_ids:
+                    - selected_speaker_ids
+                trim_start: 1
+                trim_end: 1
+    update:
+      path: /v1/voices/pvc/{voice_id}/samples/{sample_id}
+      method: POST
+      auth: false
+      docs: Update a PVC voice sample - apply noise removal, or select speaker.
+      source:
+        openapi: openapi.json
+      path-parameters:
+        voice_id:
+          type: string
+          docs: >-
+            Voice ID to be used, you can use https://api.elevenlabs.io/v1/voices
+            to list all the available voices.
+        sample_id:
+          type: string
+          docs: Sample ID to be used
+      display-name: Update Pvc Voice Sample
+      request:
+        name: BodyUpdatePvcVoiceSampleV1VoicesPvcVoiceIdSamplesSampleIdPost
+        body:
+          properties:
+            remove_background_noise:
+              type: optional<boolean>
+              docs: >-
+                If set will remove background noise for voice samples using our
+                audio isolation model. If the samples do not include background
+                noise, it can make the quality worse.
+              default: false
+            selected_speaker_ids:
+              type: optional<list<string>>
+              docs: >-
+                Speaker IDs to be used for PVC training. Make sure you send all
+                the speaker IDs you want to use for PVC training in one request
+                because the last request will override the previous ones.
+            trim_start_time:
+              type: optional<integer>
+              docs: >-
+                The start time of the audio to be used for PVC training. Time
+                should be in milliseconds
+            trim_end_time:
+              type: optional<integer>
+              docs: >-
+                The end time of the audio to be used for PVC training. Time
+                should be in milliseconds
+        content-type: application/json
+      response:
+        docs: Successful Response
+        type: root.AddVoiceResponseModel
+        status-code: 200
+      errors:
+        - root.UnprocessableEntityError
+      examples:
+        - path-parameters:
+            voice_id: 21m00Tcm4TlvDq8ikWAM
+            sample_id: VW7YKqPnjY4h39yTbx2L
+          request: {}
+          response:
+            body:
+              voice_id: b38kUX8pkfYO2kHyqfFy
+    delete:
+      path: /v1/voices/pvc/{voice_id}/samples/{sample_id}
+      method: DELETE
+      auth: false
+      docs: Delete a sample from a PVC voice.
+      source:
+        openapi: openapi.json
+      path-parameters:
+        voice_id:
+          type: string
+          docs: >-
+            Voice ID to be used, you can use https://api.elevenlabs.io/v1/voices
+            to list all the available voices.
+        sample_id:
+          type: string
+          docs: Sample ID to be used
+      display-name: Delete Pvc Voice Sample
+      response:
+        docs: Successful Response
+        type: root.DeleteVoiceSampleResponseModel
+        status-code: 200
+      errors:
+        - root.UnprocessableEntityError
+      examples:
+        - path-parameters:
+            voice_id: 21m00Tcm4TlvDq8ikWAM
+            sample_id: VW7YKqPnjY4h39yTbx2L
+          response:
+            body:
+              status: ok
+  source:
+    openapi: openapi.json

package/.mock/definition/voices/pvc/verification/captcha.yml

@@ -0,0 +1,62 @@
+imports:
+  root: ../../../__package__.yml
+service:
+  auth: false
+  base-path: ''
+  endpoints:
+    get:
+      path: /v1/voices/pvc/{voice_id}/captcha
+      method: GET
+      auth: false
+      docs: Get captcha for PVC voice verification.
+      source:
+        openapi: openapi.json
+      path-parameters:
+        voice_id:
+          type: string
+          docs: >-
+            Voice ID to be used, you can use https://api.elevenlabs.io/v1/voices
+            to list all the available voices.
+      display-name: Get Pvc Voice Captcha
+      errors:
+        - root.UnprocessableEntityError
+      examples:
+        - path-parameters:
+            voice_id: 21m00Tcm4TlvDq8ikWAM
+    verify:
+      path: /v1/voices/pvc/{voice_id}/captcha
+      method: POST
+      auth: false
+      docs: Submit captcha verification for PVC voice.
+      source:
+        openapi: openapi.json
+      path-parameters:
+        voice_id:
+          type: string
+          docs: >-
+            Voice ID to be used, you can use https://api.elevenlabs.io/v1/voices
+            to list all the available voices.
+      display-name: Verify Pvc Voice Captcha
+      request:
+        name: Body_Verify_PVC_voice_captcha_v1_voices_pvc__voice_id__captcha_post
+        body:
+          properties:
+            recording:
+              type: file
+              docs: Audio recording of the user
+        content-type: multipart/form-data
+      response:
+        docs: Successful Response
+        type: root.VerifyPvcVoiceCaptchaResponseModel
+        status-code: 200
+      errors:
+        - root.UnprocessableEntityError
+      examples:
+        - path-parameters:
+            voice_id: 21m00Tcm4TlvDq8ikWAM
+          request: {}
+          response:
+            body:
+              status: ok
+  source:
+    openapi: openapi.json

package/.mock/definition/voices/pvc/verification.yml

@@ -0,0 +1,47 @@
+imports:
+  root: ../../__package__.yml
+service:
+  auth: false
+  base-path: ''
+  endpoints:
+    request:
+      path: /v1/voices/pvc/{voice_id}/verification
+      method: POST
+      auth: false
+      docs: Request manual verification for a PVC voice.
+      source:
+        openapi: openapi.json
+      path-parameters:
+        voice_id:
+          type: string
+          docs: >-
+            Voice ID to be used, you can use https://api.elevenlabs.io/v1/voices
+            to list all the available voices.
+      display-name: Request Manual Verification
+      request:
+        name: >-
+          Body_Request_manual_verification_v1_voices_pvc__voice_id__verification_post
+        body:
+          properties:
+            files:
+              type: list<file>
+              docs: Verification documents
+            extra_text:
+              type: optional<string>
+              docs: Extra text to be used in the manual verification process.
+        content-type: multipart/form-data
+      response:
+        docs: Successful Response
+        type: root.RequestPvcManualVerificationResponseModel
+        status-code: 200
+      errors:
+        - root.UnprocessableEntityError
+      examples:
+        - path-parameters:
+            voice_id: 21m00Tcm4TlvDq8ikWAM
+          request: {}
+          response:
+            body:
+              status: ok
+  source:
+    openapi: openapi.json

package/.mock/definition/voices/pvc.yml

@@ -0,0 +1,137 @@
+imports:
+  root: ../__package__.yml
+service:
+  auth: false
+  base-path: ''
+  endpoints:
+    create:
+      path: /v1/voices/pvc
+      method: POST
+      auth: false
+      docs: Creates a new PVC voice with metadata but no samples
+      source:
+        openapi: openapi.json
+      display-name: Create PVC voice
+      request:
+        name: CreatePvcVoiceRequest
+        body:
+          properties:
+            name:
+              type: string
+              docs: >-
+                The name that identifies this voice. This will be displayed in
+                the dropdown of the website.
+              validation:
+                maxLength: 100
+            language:
+              type: string
+              docs: Language used in the samples.
+            description:
+              type: optional<string>
+              docs: Description to use for the created voice.
+              validation:
+                maxLength: 500
+            labels:
+              type: optional<map<string, optional<string>>>
+              docs: Serialized labels dictionary for the voice.
+        content-type: application/json
+      response:
+        docs: Successful Response
+        type: root.AddVoiceResponseModel
+        status-code: 200
+      errors:
+        - root.UnprocessableEntityError
+      examples:
+        - request:
+            name: John Smith
+            language: en
+          response:
+            body:
+              voice_id: b38kUX8pkfYO2kHyqfFy
+    update:
+      path: /v1/voices/pvc/{voice_id}
+      method: POST
+      auth: false
+      docs: Edit PVC voice metadata
+      source:
+        openapi: openapi.json
+      path-parameters:
+        voice_id:
+          type: string
+          docs: >-
+            Voice ID to be used, you can use https://api.elevenlabs.io/v1/voices
+            to list all the available voices.
+      display-name: Edit Pvc Voice
+      request:
+        name: BodyEditPvcVoiceV1VoicesPvcVoiceIdPost
+        body:
+          properties:
+            name:
+              type: optional<string>
+              docs: >-
+                The name that identifies this voice. This will be displayed in
+                the dropdown of the website.
+              validation:
+                maxLength: 100
+            language:
+              type: optional<string>
+              docs: Language used in the samples.
+            description:
+              type: optional<string>
+              docs: Description to use for the created voice.
+              validation:
+                maxLength: 500
+            labels:
+              type: optional<map<string, optional<string>>>
+              docs: Serialized labels dictionary for the voice.
+        content-type: application/json
+      response:
+        docs: Successful Response
+        type: root.AddVoiceResponseModel
+        status-code: 200
+      errors:
+        - root.UnprocessableEntityError
+      examples:
+        - path-parameters:
+            voice_id: 21m00Tcm4TlvDq8ikWAM
+          request: {}
+          response:
+            body:
+              voice_id: b38kUX8pkfYO2kHyqfFy
+    train:
+      path: /v1/voices/pvc/{voice_id}/train
+      method: POST
+      auth: false
+      docs: Start PVC training process for a voice.
+      source:
+        openapi: openapi.json
+      path-parameters:
+        voice_id:
+          type: string
+          docs: >-
+            Voice ID to be used, you can use https://api.elevenlabs.io/v1/voices
+            to list all the available voices.
+      display-name: Run Pvc Training
+      request:
+        name: BodyRunPvcTrainingV1VoicesPvcVoiceIdTrainPost
+        body:
+          properties:
+            model_id:
+              type: optional<string>
+              docs: The model ID to use for the conversion.
+        content-type: application/json
+      response:
+        docs: Successful Response
+        type: root.StartPvcVoiceTrainingResponseModel
+        status-code: 200
+      errors:
+        - root.UnprocessableEntityError
+      examples:
+        - path-parameters:
+            voice_id: 21m00Tcm4TlvDq8ikWAM
+          request: {}
+          response:
+            body:
+              status: ok
+  source:
+    openapi: openapi.json

package/.mock/definition/voices/samples/audio.yml

@@ -0,0 +1,35 @@
+imports:
+  root: ../../__package__.yml
+service:
+  auth: false
+  base-path: ''
+  endpoints:
+    get:
+      path: /v1/voices/{voice_id}/samples/{sample_id}/audio
+      method: GET
+      auth: false
+      docs: Returns the audio corresponding to a sample attached to a voice.
+      source:
+        openapi: openapi.json
+      path-parameters:
+        voice_id:
+          type: string
+          docs: >-
+            ID of the voice to be used. You can use the [Get
+            voices](/docs/api-reference/voices/search) endpoint list all the
+            available voices.
+        sample_id:
+          type: string
+          docs: >-
+            ID of the sample to be used. You can use the [Get
+            voices](/docs/api-reference/voices/get) endpoint list all the
+            available samples for a voice.
+      display-name: Get audio from sample
+      response:
+        docs: Successful Response
+        type: file
+        status-code: 200
+      errors:
+        - root.UnprocessableEntityError
+  source:
+    openapi: openapi.json

package/.mock/definition/voices/settings.yml

@@ -0,0 +1,105 @@
+imports:
+  root: ../__package__.yml
+service:
+  auth: false
+  base-path: ''
+  endpoints:
+    get_default:
+      path: /v1/voices/settings/default
+      method: GET
+      auth: false
+      docs: >-
+        Gets the default settings for voices. "similarity_boost" corresponds
+        to"Clarity + Similarity Enhancement" in the web app and "stability"
+        corresponds to "Stability" slider in the web app.
+      source:
+        openapi: openapi.json
+      display-name: Get default voice settings
+      response:
+        docs: Successful Response
+        type: root.VoiceSettings
+        status-code: 200
+      examples:
+        - response:
+            body:
+              stability: 1
+              similarity_boost: 1
+              style: 0
+              use_speaker_boost: true
+              speed: 1
+    get:
+      path: /v1/voices/{voice_id}/settings
+      method: GET
+      auth: false
+      docs: >-
+        Returns the settings for a specific voice. "similarity_boost"
+        corresponds to"Clarity + Similarity Enhancement" in the web app and
+        "stability" corresponds to "Stability" slider in the web app.
+      source:
+        openapi: openapi.json
+      path-parameters:
+        voice_id:
+          type: string
+          docs: >-
+            Voice ID to be used, you can use https://api.elevenlabs.io/v1/voices
+            to list all the available voices.
+      display-name: Get voice settings
+      response:
+        docs: Successful Response
+        type: root.VoiceSettings
+        status-code: 200
+      errors:
+        - root.UnprocessableEntityError
+      examples:
+        - path-parameters:
+            voice_id: 21m00Tcm4TlvDq8ikWAM
+          response:
+            body:
+              stability: 1
+              similarity_boost: 1
+              style: 0
+              use_speaker_boost: true
+              speed: 1
+    update:
+      path: /v1/voices/{voice_id}/settings/edit
+      method: POST
+      auth: false
+      docs: >-
+        Edit your settings for a specific voice. "similarity_boost" corresponds
+        to "Clarity + Similarity Enhancement" in the web app and "stability"
+        corresponds to "Stability" slider in the web app.
+      source:
+        openapi: openapi.json
+      path-parameters:
+        voice_id:
+          type: string
+          docs: >-
+            ID of the voice to be used. You can use the [Get
+            voices](/docs/api-reference/voices/search) endpoint list all the
+            available voices.
+      display-name: Edit voice settings
+      request:
+        body:
+          type: root.VoiceSettings
+          docs: The settings for a specific voice.
+        content-type: application/json
+      response:
+        docs: Successful Response
+        type: root.EditVoiceSettingsResponseModel
+        status-code: 200
+      errors:
+        - root.UnprocessableEntityError
+      examples:
+        - path-parameters:
+            voice_id: 21m00Tcm4TlvDq8ikWAM
+          request:
+            stability: 1
+            similarity_boost: 1
+            style: 0
+            use_speaker_boost: true
+            speed: 1
+          response:
+            body:
+              status: ok
+  source:
+    openapi: openapi.json