> ## 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.

# API reference index

> Index of Rime's text-to-speech, speech-to-text, Prism, and metadata endpoints across all supported models.

Send HTTP TTS requests to the model's host, such as `https://coda.api.rime.ai/`. For Coda WebSocket v1, connect to `wss://coda.api.rime.ai/ws`. Authenticate with a bearer token in the `Authorization` header. See [API authentication](https://docs.rime.ai/docs/api-authentication.md).

Most clients should start with **Coda**, Rime's flagship model:

* [Coda: Streaming HTTP](https://docs.rime.ai/api-reference/coda/http.md)
* [Coda: WebSocket v1 reference](https://docs.rime.ai/api-reference/coda/websocket-v1.md)
* [Coda: WebSocket v1 JSON quickstart](https://docs.rime.ai/api-reference/coda/websocket-v1-json.md)
* [Coda: WebSocket v1 Protobuf quickstart](https://docs.rime.ai/api-reference/coda/websocket-v1-protobuf.md)
* [Coda: WebSocket v1 with LiveKit](https://docs.rime.ai/api-reference/coda/websocket-v1-livekit.md)

To compare model and protocol support, see the [WebSocket API overview](https://docs.rime.ai/docs/websockets.md).

## TTS endpoints by model

| Model | Streaming HTTP | WebSocket v1 | Legacy WebSocket `/ws` | Legacy WebSocket JSON `/ws3` |
| - | - | - | - | - |
| **Coda** (flagship) | [HTTP](https://docs.rime.ai/api-reference/coda/http.md) | [v1](https://docs.rime.ai/api-reference/coda/websocket-v1.md) | [/ws](https://docs.rime.ai/api-reference/coda/websockets.md) | [/ws3](https://docs.rime.ai/api-reference/coda/websockets-json.md) |
| **Mist v3** | [HTTP](https://docs.rime.ai/api-reference/mistv3/http.md) | Not available | [/ws](https://docs.rime.ai/api-reference/mistv3/websockets.md) | [/ws3](https://docs.rime.ai/api-reference/mistv3/websockets-json.md) |

Mist v1 and Mist v2 retire on December 3, 2026. To move from Mist v1 or Mist v2, see [Move from Mist v1 or Mist v2 to Mist v3](https://docs.rime.ai/docs/migrate-legacy-mist.md).

## Speech-to-text endpoints

Transcribe English or Spanish with your Rime API key. Both endpoints accept streaming 16 kHz mono PCM16 audio. gRPC also accepts a complete WAV file.

* [Speech-to-text: Streaming WebSocket](https://docs.rime.ai/api-reference/stt/websockets.md): `GET wss://stt.api.rime.ai/ws`
* [Speech-to-text: gRPC](https://docs.rime.ai/api-reference/stt/grpc.md): `stt.api.rime.ai:443`, service `rime.SpeechToText`

To transcribe from Python, Node.js, Go, or Rust, start with the [speech-to-text quickstart](https://docs.rime.ai/docs/stt/quickstart.md), which uses the [Rime SDK](https://docs.rime.ai/api-reference/sdk/stt.md). To call the API without the SDK, [Call the API directly](https://docs.rime.ai/docs/stt/live-audio.md#call-the-api-directly) helps you choose a transport and an output contract.

## Prism endpoint

Hold a spoken conversation with Prism, Rime's speech-to-speech API, over one WebSocket.

* [Prism: WebSocket](https://docs.rime.ai/api-reference/prism/websocket.md): `GET wss://prism.api.rime.ai/v1/realtime`

To build with the Rime SDK, start with the [Prism SDK quickstart](https://docs.rime.ai/docs/prism/quickstart.md). To call the API without the SDK, follow the [WebSocket quickstart](https://docs.rime.ai/docs/prism/websocket-quickstart.md).

## Metadata endpoints

* [List All Voices](https://docs.rime.ai/api-reference/data/voices-v2.md): `GET /data/voices/all-v2.json`
* [List Voice Details](https://docs.rime.ai/api-reference/data/voice-details.md): `GET /data/voices/voice_details.json`

## Utility endpoints

* [Coverage (out-of-vocabulary check)](https://docs.rime.ai/api-reference/other/oov.md): `POST /oov`
* [Text Normalization](https://docs.rime.ai/api-reference/other/textnorm.md): `POST /textnorm`

## Related

* [Quickstart: TTS in five minutes](https://docs.rime.ai/docs/quickstart-five-minute.md)
* [Models](https://docs.rime.ai/docs/models.md): comparing Coda and Mist
* [Voices](https://docs.rime.ai/docs/voices.md): voice lineup and language support
* [Latency tuning](https://docs.rime.ai/docs/latency.md)
* [Changelog](https://docs.rime.ai/docs/changelog.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.