Skip to main content
All requests require authentication with a bearer token in the Authorization header: Authorization: Bearer YOUR_API_KEY. See API authentication for how to create a key. The streaming endpoint returns audio bytes in the format specified by the Accept header.

Audio Formats

Set the Accept header to one of the following values:

Deprecated aliases

Still accepted for backwards compatibility; new code should use the RFC types above.

Variable Parameters

speaker
string
required
Must be one of the flagship Arcana voices listed in our documentation.
text
string
required
The text you’d like spoken. Unlimited via API. Character limit per request is 3,000 in the dashboard UI.
modelId
string
Choose arcana for Rime’s most realistic conversational voices.
lang
string
default:"en"
If provided, the language must match the language spoken by the provided speaker. This can be checked in our voices documentation.
samplingRate
number
default:"24000"
The sampling rate (Hz).
timeScaleFactor
number
default:"1.0"
The time scaling factor.A value above 1.0 slows down the audio, a value below 1.0 speeds up the audio.