Skip to main content
Start with the LiveKit tutorial for a complete, working voice agent. Use a direct API starter when you already own transport, transcription, turn detection, and orchestration. Rime supplies the speech layer in either case.
Keep RIME_API_KEY on the server. Browser clients should call your application server or connect through a server-side WebSocket bridge rather than authenticate with Rime directly.

Choose an implementation

LiveKit voice agent

Run an end-to-end browser agent with LiveKit transport, turn detection, speech recognition, agent logic, and Rime speech.

Direct API starters

Add a server-side Rime speech route and a browser voice interface to your application stack.

Voice platforms

Use Rime through a framework or service that supplies transport, telephony, or agent orchestration.

WebSocket API

Build directly on persistent synthesis connections when you need incremental text, word timestamps, context management, or interruption control.

Rime is the speech layer

The LiveKit tutorial implements the complete path. The direct API pages are application starters: they demonstrate the Rime proxy and browser interface while leaving the production speech-recognition and agent-logic choices to your application.

Design for live conversation

Stream speech

Start playback while the response is still being generated and choose an audio format for your transport.

Handle interruptions

Use timestamps, context IDs, segmentation, and clear operations to coordinate turns and barge-in.

Reduce latency

Measure time to first audio and tune the synthesis path for responsive conversations.

Choose a voice

Match a voice, model, and language to the agent’s audience and role.