Streaming MP3

Fixed Headers

Accept · audio/mp3 · required

Variable Parameters

speaker · string · required

Must be one of the flagship Arcana voices listed in our documentation or a string description in the format “gen z woman” or a fictional name like “doe_john”.

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.

repetition_penalty · float · default: "1.5"

The repetition penalty. We do not recommend changing this from the default value. Typical range is 1 to 2.

Float that penalizes new tokens based on whether they appear in the prompt and the generated text so far. Values > 1 encourage the model to use new tokens, while values < 1 encourage the model to repeat tokens.

temperature · float · default: "0.5"

The temperature. We do not recommend changing this from the default value. Typical range is 0 to 1.

Float that controls the randomness of the sampling. Lower values make the model more deterministic, while higher values make the model more random. Zero means greedy sampling.

top_p · float · default: "0.5"

The top p. We do not recommend changing this from the default value. Typical range is 0 to 1.

Float that controls the cumulative probability of the top tokens to consider. Must be in (0, 1]. Set to 1 to consider all tokens.

samplingRate · int · default: "24000"

The sampling rate (Hz). Accepted values: 8000, 16000, 22050, 24000, 44100, 48000, 96000. Anything above 24000 is up sampling.

max_tokens · int · default: "1200"

The max tokens. Range is 200 to 5000.

cURL

curl --request POST \
  --url https://users.rime.ai/v1/rime-tts \
  --header 'Accept: audio/mp3' \
  --header 'Authorization: Bearer <authorization>' \
  --header 'Content-Type: application/json' \
  --data '{
  "speaker": "<string>",
  "text": "<string>",
  "modelId": "arcana",
  "repetition_penalty": 1.5,
  "temperature": 0.5,
  "top_p": 0.5,
  "samplingRate": 24000,
  "max_tokens": 1200
}'