Update localization endpoint docs (#88)

cartesia-ai · Feb 20, 2025 · 91fe7cb · 91fe7cb
1 parent 424447d
commit 91fe7cb
Show file tree

Hide file tree

Showing 2 changed files with 36 additions and 6 deletions.
diff --git a/fern/.preview/fern-python-sdk b/fern/.preview/fern-python-sdk
diff --git a/fern/definition/voices.yml b/fern/definition/voices.yml
@@ -144,7 +144,18 @@ types:
 
   LocalizeVoiceRequest:
     properties:
-      embedding: embedding.Embedding
+      voice_id:
+        type: string
+        docs: |
+          The ID of the voice to localize.
+      name:
+        type: string
+        docs: |
+          The name of the new localized voice.
+      description:
+        type: string
+        docs: |
+          The description of the new localized voice.
       language: LocalizeTargetLanguage
       original_speaker_gender: Gender
       dialect: optional<LocalizeDialect>
@@ -301,9 +312,28 @@ service:
       path: /localize
       method: POST
       display-name: Localize Voice
+      docs: |
+        Create a new voice from an existing voice localized to a new language and dialect.
       request: LocalizeVoiceRequest
-      response: EmbeddingResponse
-
+      response: VoiceMetadata
+      examples:
+        - name: Localize Voice
+          request:
+            voice_id: "694f9389-aac1-45b6-b726-9d9369183238"
+            name: "Sarah Peninsular Spanish"
+            description: "Sarah Voice in Peninsular Spanish"
+            language: es
+            original_speaker_gender: female
+            dialect: pe
+          response:
+            body:
+              id: "8f7d3c2e-1a2b-3c4d-5e6f-7g8h9i0j1k2l"
+              user_id: "user_id"
+              is_public: false
+              name: "Sarah Peninsular Spanish"
+              description: "Sarah Voice in Peninsular Spanish"
+              created_at: "2024-03-15T10:30:00.000Z"
+              language: es
     mix:
       path: /mix
       method: POST
@@ -318,7 +348,7 @@ service:
       docs: |
         Create voice from raw features. If you'd like to clone a voice from an audio file, please use Clone Voice instead.
       request: CreateVoiceRequest
-      response: Voice
+      response: VoiceMetadata
       examples:
         - name: Create Voice
           request:
@@ -330,9 +360,9 @@ service:
           response:
             body:
               id: "8f7d3c2e-1a2b-3c4d-5e6f-7g8h9i0j1k2l"
+              user_id: "user_id"
               is_public: false
               name: "My Custom Voice"
               description: "A custom voice created through the API"
               created_at: "2024-03-15T10:30:00.000Z"
-              embedding: []
               language: en