OGG over JSON

cURL

curl --request POST \
  --url https://users.rime.ai/v1/rime-tts \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --output output.json \
  --fail \
  --data '{
  "text": "Hello from Rime!",
  "modelId": "mistv2",
  "speaker": "astra",
  "lang": "eng",
  "audioFormat": "ogg",
  "inlineSpeedAlpha": "0.5, 3",
  "noTextNormalization": false,
  "pauseBetweenBrackets": false,
  "phonemizeBetweenBrackets": false,
  "samplingRate": 22050,
  "saveOovs": false,
  "speedAlpha": 1.0
}'

Fixed Parameters

audioFormat · ogg · required

Variable Parameters

speaker · string · required

Must be one of the voices listed in our documentation.

text · string · required

The text you’d like spoken. Character limit per request is 500 via the API and 1,000 in the dashboard UI.

lang · string · default: "eng"

If provided, the language must match the language spoken by the provided speaker. This can be checked in our voices documentation.

pauseBetweenBrackets · bool · default: "false"

When set to true, adds pauses between words enclosed in angle brackets. The number inside the brackets specifies the pause duration in milliseconds.
Example: “Hi. <200> I’d love to have a conversation with you.” adds a 200ms pause between the first and second sentences.

phonemizeBetweenBrackets · bool · default: "false"

When set to true, you can specify the phonemes for a word enclosed in curly brackets.
Example: “{h’El.o} World” will pronounce “Hello” as expected. Learn more about custom pronunciation.

inlineSpeedAlpha · string

Comma-separated list of speed values applied to words in square brackets. Values < 1.0 speed up speech, > 1.0 slow it down. Example: “This is [slow] and [fast]”, use “3, 0.5” to make “slow” slower and “fast” faster.

samplingRate · int · required

Must be one of 8000, 12000, 16000, or 24000

modelId · string

Choose mistv2 for Rime’s fastest, most accurate, and most customizable model, or mist for Rime’s earlier model (default: mist)

speedAlpha · float · default: "1.0"

Adjusts the speed of speech. Lower than 1.0 is faster than default. Higher than 1.0 is slower than default.

noTextNormalization · bool · default: "false"

Skips text normalization of the input text prior to synthesizing audio. This will reduce latency at the cost of some possible mispronunciation of digits and abbreviations.

saveOovs · bool · default: "false"

If set to true, Rime shall save any currently OOV (out-of-vocabulary) words encountered in text, and save them for the User or Team to review on the Speech QA dashboard. Note: It may take up to 15 minutes for OOV words to appear on your dashboard.

cURL

curl --request POST \
  --url https://users.rime.ai/v1/rime-tts \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --output output.json \
  --fail \
  --data '{
  "text": "Hello from Rime!",
  "modelId": "mistv2",
  "speaker": "astra",
  "lang": "eng",
  "audioFormat": "ogg",
  "inlineSpeedAlpha": "0.5, 3",
  "noTextNormalization": false,
  "pauseBetweenBrackets": false,
  "phonemizeBetweenBrackets": false,
  "samplingRate": 22050,
  "saveOovs": false,
  "speedAlpha": 1.0
}'