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

string
required
Must be a voice available on arcana. See the voice catalog.
string
required
The text you’d like spoken. Unlimited via API. Character limit per request is 3,000 in the dashboard UI.
string
Set to arcana.
string
default:"en"
If provided, the language must match the language spoken by the selected speaker. Verify the pairing in the Rime voice catalog.
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 it are clamped without an error.A value above 1.0 slows down the audio, a value below 1.0 speeds up the audio.