Add examples (#33)

cartesia-ai · Nov 2, 2024 · a929285 · a929285
1 parent f503cff
commit a929285
Show file tree

Hide file tree

Showing 2 changed files with 75 additions and 0 deletions.
diff --git a/fern/definition/tts.yml b/fern/definition/tts.yml
@@ -13,6 +13,43 @@ service:
       method: POST
       display-name: Text to Speech (Bytes)
       request: TTSRequest
+      examples:
+        - name: MP3
+          request:
+            model_id: "sonic-english"
+            transcript: "Hello, world!"
+            voice:
+              mode: "id"
+              id: "694f9389-aac1-45b6-b726-9d9369183238"
+            language: "en"
+            output_format:
+              container: "mp3"
+              sample_rate: 44100
+              bit_rate: 128000
+        - name: WAV
+          request:
+            model_id: "sonic-english"
+            transcript: "Hello, world!"
+            voice:
+              mode: "id"
+              id: "694f9389-aac1-45b6-b726-9d9369183238"
+            language: "en"
+            output_format:
+              container: "wav"
+              sample_rate: 44100
+              encoding: "pcm_f32le"
+        - name: RAW
+          request:
+            model_id: "sonic-english"
+            transcript: "Hello, world!"
+            voice:
+              mode: "id"
+              id: "694f9389-aac1-45b6-b726-9d9369183238"
+            language: "en"
+            output_format:
+              container: "raw"
+              sample_rate: 44100
+              encoding: "pcm_f32le"
 
     sse:
       path: /sse

diff --git a/fern/definition/voice-changer.yml b/fern/definition/voice-changer.yml
@@ -32,6 +32,25 @@ service:
               docs: |
                 Required for MP3 and WAV containers.
       response: file
+      examples:
+        - name: MP3
+          request:
+            voice[id]: "694f9389-aac1-45b6-b726-9d9369183238"
+            output_format[container]: mp3
+            output_format[sample_rate]: 44100
+            output_format[bit_rate]: 128000
+        - name: WAV
+          request:
+            voice[id]: "694f9389-aac1-45b6-b726-9d9369183238"
+            output_format[container]: wav
+            output_format[sample_rate]: 44100
+            output_format[encoding]: pcm_f32le
+        - name: RAW
+          request:
+            voice[id]: "694f9389-aac1-45b6-b726-9d9369183238"
+            output_format[container]: raw
+            output_format[sample_rate]: 44100
+            output_format[encoding]: pcm_f32le
 
     sse:
       path: /sse
@@ -60,6 +79,25 @@ service:
               docs: |
                 Required for MP3 and WAV containers.
       response-stream: StreamingResponse
+      examples:
+        - name: MP3
+          request:
+            voice[id]: "694f9389-aac1-45b6-b726-9d9369183238"
+            output_format[container]: mp3
+            output_format[sample_rate]: 44100
+            output_format[bit_rate]: 128000
+        - name: WAV
+          request:
+            voice[id]: "694f9389-aac1-45b6-b726-9d9369183238"
+            output_format[container]: wav
+            output_format[sample_rate]: 44100
+            output_format[encoding]: pcm_f32le
+        - name: RAW
+          request:
+            voice[id]: "694f9389-aac1-45b6-b726-9d9369183238"
+            output_format[container]: raw
+            output_format[sample_rate]: 44100
+            output_format[encoding]: pcm_f32le
 
 types:
   OutputFormatContainer: