Skip to main content
The Rime API authenticates every request with a bearer token in the Authorization header: Authorization: Bearer YOUR_API_KEY. See API authentication for how to create a key. The endpoint streams audio in the format you name in the Accept header. If Accept is missing or a wildcard, the API streams headerless 16-bit PCM, which audio players won’t open. If it names a type the API can’t stream, the API returns 406 with the list of supported types.

Audio formats

Set the Accept header to one of the following values:

Deprecated aliases

The API still accepts these for backward compatibility. Use the RFC types above in new code.

Variable parameters

string
required
Must be a Coda voice. See the voice catalog.
string
required
The text you’d like spoken. The API accepts up to 1,000 characters per request.
string
Set to coda to select the Coda voice lineup. Without it, the API uses Mist v3.
string
default:"en"
If provided, the language must match the language spoken by the provided speaker. Pass a BCP 47 language tag:The 3-letter ISO 639-2 codes that older integrations send (eng, spa, fra, por, ger, jpn, ara, hin, ita) remain accepted, and will stay accepted.See the voices documentation for which speakers support each language.
number
default:"24000"
The sampling rate (Hz).
number
default:"1.0"
The time scaling factor. Accepted range is 0.4 to 2.5. Values outside this range are clamped without an error.Values above 1.0 slow the audio down, and values below 1.0 speed it up.