Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.rime.ai/llms.txt

Use this file to discover all available pages before exploring further.

​
Rime API Changelog

Subscribe to the RSS feed to get notified of new releases.
​
2026-05-19
  • Coda is now available via modelId: coda:
    • New flagship TTS model — sophisticated LLM backbone paired with a dedicated speech inference engine, trained on conversational full-duplex data.
    • Surpasses prior Rime models and competitor offerings in human-led voice-quality evaluations across naturalness, prosody, and artifact-free output.
    • Sub-100ms model latency on the GPU engine (self-hosted or on-prem); cloud API users add roughly 25–50ms network round-trip from most of the continental US — see Regional endpoints.
    • Multilingual support across English, French, German, Japanese, Portuguese, and Spanish.
    • Word-level timestamps over the JSON websocket endpoint for text-audio alignment and interruption handling.
    • Available via the cloud API and on-premises at launch.
    • Recommended successor to Arcana for all existing Arcana traffic — swap modelId: arcana for modelId: coda.
    • See the Coda API reference for details.
​
2026-04-24
  • API on-prem image 20260424:
    • New environment variables for authentication configuration:
      • RIME_API_KEY: pre-configure the API key at the deployment level so callers don’t need to include it in each request. Can also be mounted as a secret file at /secrets/rime_api_key.
      • API_KEY_HEADER: specify an alternate header name for platforms that intercept the Authorization header.
      • PLATFORM_API_KEY: supply a platform API key for authenticated inter-container requests. Can also be mounted as a secret file at /secrets/platform_api_key.
​
2026-04-20
  • Arcana V2, Arcana V3 and Mist V3 release 20260420.
  • General performance improvements and bug fixes.
​
2026-04-09
  • Arcana release 20260404:
    • Improved and stabilized text normalization across all supported languages.
    • Upgrade to 20260404 is recommended.
  • Mist v3 release 20260404:
    • Reached general availability.
  • General performance improvements across the inference stack for all models.
​
2026-04-07
  • API on-prem image 20260407:
    • Compatible with Mist v3.
​
2026-04-06
  • Mist v3 is now available via modelId: mistv3:
    • TTFB well below 100ms — a major latency improvement over Mist v2 without sacrificing quality
    • Popular Mist v2 speakers available, plus 8 Arcana flagship speakers now available as Mist v3 voices
    • See the full voice list
​
2026-02-23
  • Arcana release 20260223:
    • v3 (multilingual)
      • Supported languages: de, en, es, fr, he, ja, pt, si, ta.
    • General performance improvements and bug fixes.
​
2026-02-11
  • API on-prem image 20260212:
    • Exposes a new json websockets endpoint with WLT (equivalent to the cloud api’s ws3 endpoint) on port 8003
​
2026-02-05
  • v3/endeka (Arcana v3) lang parameter: 2- and 3-letter ISO 639 codes that map to the same language are accepted and normalized (e.g. de, deu, or ger for German; fr, fra, or fre for French). Supported languages:
    639-1639-2/639-3Language
    dedeu, gerGerman
    enengEnglish
    esspaSpanish
    frfra, freFrench
    hehebHebrew
    jajpnJapanese
    ptporPortuguese
    Any valid ISO 639-1, 639-2, or 639-3 code that maps to one of these languages is accepted.
​
2026-02-04
  • Regional endpoints available:
    • wss://users-east-ws.rime.ai/ws* offers all the websockets apis currently served served via wss://users-ws.rime.ai/ws* and may provide better latency for clients closer to us-east-1.
    • https://users-east.rime.ai/v1/rime-tts offers all the same API currently served via https://users.rime.ai/v1/rime-tts, and may provide better latency for clients closer to us-east-1.
    • Additionally https://users-west.rime.ai/v1/rime-tts offers all the apis currently served via https://users.rime.ai/v1/rime-tts, and may provide better latency for clients closer to us-west-1.
  • Arcana now supports JSON websockets with Word-Level-Timestamps:
    • wss://users-ws.rime.ai/ws3 and wss://users-east-ws.rime.ai/ws3 serve the JSON websockets api that now supports both mist and arcana model classes.
  • Arcana release 20260204 (Arcana v3):
    • Added support for languages: English (lang=eng), French (lang=fra), German (lang=ger), Hebrew (lang=heb), Japanese (lang=jpn), Portuguese (lang=por), Spanish (lang=spa).
    • Languages can be specified using either 2-character codes (en, fr, de, he, ja, pt, es) or 3-character codes (eng, fra, ger, heb, jpn, por, spa).
​
2026-02-03
  • Arcana now supports the spell() function. You can use spell() to spell out sequences letter by letter or number by number with Arcana voices. See the spell function documentation for examples.
​
2026-01-31
  • Arcana release 20260131:
    • General performance improvements and bug fixes.
​
2026-01-24
  • Arcana release 20260124:
    • Fixed speaker mapping for English Arcana.
    • General performance improvements and bug fixes.
​
2026-01-23
  • API on-prem image 20260123:
    • Exposes the binary websockets API on port 8002. This API is equivalent to the cloud websockets API.
​
2026-01-22
  • Arcana release 20260122:
    • rime.engine.initial_latency and rime.engine.generated_audio_duration have saner defaults and can be tuned.
    • Added spell() support.
    • General performance improvements and bug fixes.
​
2026-01-15
  • Arcana release 20260115:
    • Fixed an issue where there is static noise for some speakers at the end or in the middle of utterances.
    • A full set of ORCA headers are now returned for load balancing.
    • A /statusz endpoint is introduced for the model container that contains diagnostics information.
    • /livez now responds with OK as soon as the server starts up.
    • General performance improvements.
​
2026-01-14
​
2025-12-20
  • Arcana release 20251220:
    • An ORCA header, named_metrics.inference_concurrency_utilization, is now returned in all HTTP responses.
    • Emojis are no longer read out.
    • General reliability updates.
​
2025-12-13
  • Arcana release 20251213:
    • Performance improvements for the English model.
    • Minimum requirements for NVIDIA drivers reduced to 525.60.13.
    • General reliability updates.
  • API release 20251209:
    • Exposes non-JSON WebSockets over port 8002, allowing for Arcana over WebSockets.
    • Fixes an issue where null values were sent to the model for parameter keys not set by the user.
​
2025-12-06
  • Arcana release 20251206:
​
2025-11-21
  • Arcana release 20251121:
    • Fixed an issue with μ-law encoding.
​
2025-11-20
  • Arcana release 20251120:
    • Fixed an issue with audio buffer underrun.
​
2025-11-19
  • Arcana release 20251119:
    • Fixed a startup issue in the 20251118 release.
​
2025-11-18
  • Arcana release 20251118:
    • General improvements.
​
2025-11-10
  • Arcana release 20251110:
    • Separate engine and data package containers for easier deployment.
    • General reliability improvements.
​
2025-11-06
  • Mist on-prem model image us-docker.pkg.dev/rime-labs/mist/v2/en:20251106 released.
  • Includes performance enhancements and minor fixes.
​
2025-11-05
  • Mist on-prem model image us-docker.pkg.dev/rime-labs/mist/v2/en:20251105 released.
​
2025-11-03
  • Arcana on-prem model images tagged 20251101 release with language updates.
​
2025-10-29
  • Arcana language update: additional language support and new voices.
​
2025-10-27
  • Arcana on-prem model images tagged 20251027: performance improvements.
  • Documentation on performance tuning.
​
2025-10-15
  • Arcana is now available via (non-json) websockets users.rime.ai/ws.
​
2025-10-14
  • Arcana on-prem images with tag 20251014: Fixed a bug related to sample rate.
​
2025-10-13
  • Arcana on-prem images with tag 20251013: General performance improvements.
​
2025-10-10
  • Api on-prem image with tag 20251010: Uses https instead of http in the external calls to rime.optimize.ai to acquire licenses and track usage.
  • ⚠️ When upgrading to this image you may have to update your firewall settings to account for the new URLs (see docs).
​
⚠️ 2025-09-30
  • We have made breaking changes in voice details api (https://users.rime.ai/data/voices/voice_details.json)
  • In the voice details API, the field model_id has been renamed to modelId and name have been renamed to speaker for better clarity.
  • In the voice details API, the field region has been renamed to dialect for better clarity.
  • The language field value has been changed from short codes (e.g., eng) to human-readable names (e.g., english).
  • A new field lang has been added to retain the short language code (e.g., eng).
​
2025-09-29
  • Arcana on-prem images with tag 20250929: quality improvements.
​
2025-09-27
  • Arcana on-prem images with tag 20250927: quality improvements.
​
2025-09-25
  • Arcana on-prem English image with tag 20250925: performance improvements and general model stability enhancements.
  • Added two new Australian flagship voices:
    • eucalyptus
    • marlu
​
2025-09-24
  • Arcana on-prem images with tag 20250924: performance improvements.
​
2025-09-17
New api onprem image us-docker.pkg.dev/rime-labs/api/service:20250917 released.
  • api image now supports multiple model backends.
  • /health endpoint on the api image now reports model status.
​
2025-09-13
  • Both /ws and /ws2 support the query param saveOovs, allowing tts users to track which words in their text are out-of-vocabulary on the Speech QA dashboard.
​
2025-09-13
  • Arcana on-prem images from 20250913 now provide better latency and can run on H100 MIG (3g.40gb).
​
2025-09-09
  • Arcana on-prem images from 20250909 now provide /livez and /readyz endpoints for liveness and readiness checks.
​
2025-09-08
  • Arcana on-prem images from 20250908 now use 16-bit little endian for PCM and WAV.
  • Arcana on-prem images from 20250908 now support G-711 μ-law as an audio codec.
  • Arcana on-prem images from 20250908 now support the speedAlpha option for time scaling.
​
2025-09-02
  • saveOovs parameter added to all mistv2 tts endpoints, enabling users to have out-of-vocabulary words logged to their Speech QA dashboard for review and addition to the mist lexicon.
​
2025-08-01
  • Added French and German language support via the lang parameter in WebSocket JSON APIs. The /ws2 api now has full language parity with the /ws and http tts endpoints.
​
2025-07-31
  • Added Spanish language support via the lang: spa parameter in WebSocket JSON APIs.
  • Enhanced text segmentation with new segment parameter:
    • Added segment query parameter with three modes: “immediate”, “never”, and “bySentence” (default)
    • Deprecated immediate boolean parameter (still supported for backward compatibility)
    • Improved control over text processing and synthesis timing
​
2025-05-27
  • The <FLUSH> command is now available on both the the websockets and websockets-json apis, allowing for immediate audio synthesis of all tokens in the buffer.
​
2025-04-24
  • We’ve launched Arcana — a new model for expressive, natural voice synthesis. Available now with modelId: arcana.
​
2025-03-28
  • The lang ID spa-mx has been added. Using this accesses the same spanish languages but uses pesos instead of dolares for currency.
  • New lang: fra has been added. We now have French voices available on the dashboard and via API.
​
2025-03-26
  • The spell() function now works for Spanish. Try it out! “El nombre se escribe spell(Isabella).”
  • Fixed a bug where silence information is not processed properly when pauseBetweenBrackets is True
  • The url demo-api.rime.ai has been deprecated. Please use demo.rime.ai instead if you are using the demo API.