Rime TTS

Overview

Rime text-to-speech is available in LiveKit Agents through LiveKit Inference and the Rime plugin. Pricing for LiveKit Inference is available on the pricing page.

LiveKit Inference

Use LiveKit Inference to access Rime TTS without a separate Rime API key.

Usage

The simplest way to use Rime TTS is to pass it to the tts argument in your AgentSession, including the model and voice to use:

from livekit.agents import AgentSession

session = AgentSession(
    tts="rime/arcana:celeste",
    # ... llm, stt, vad, turn_detection, etc.
)

import { AgentSession } from '@livekit/agents';

session = new AgentSession({
    tts: "rime/arcana:celeste",
    // ... tts, stt, vad, turn_detection, etc.
});

Parameters

To customize additional parameters, use the TTS class from the inference module:

from livekit.agents import AgentSession, inference

session = AgentSession(
    tts=inference.TTS(
        model="rime/arcana", 
        voice="celeste", 
        language="en"
    ),
    # ... tts, stt, vad, turn_detection, etc.
)

import { AgentSession } from '@livekit/agents';

session = new AgentSession({
    tts: new inference.TTS({ 
        model: "rime/arcana", 
        voice: "celeste", 
        language: "en" 
    }),
    // ... tts, stt, vad, turn_detection, etc.
});

Voices

LiveKit Inference supports all of the voices available in the Rime API. You can view the default voices and explore the wider set in the API in the Rime voices documentation, and use the voice by copying its name into your LiveKit agent session.

The following is a small sample of the Rime voices available in LiveKit Inference.

Customizing pronunciation

Rime TTS supports customizing pronunciation. To learn more, see Custom Pronunciation guide.

Plugin

Use the Rime plugin to connect directly to Rime's TTS API with your own API key.

Installation

Install the plugin:

uv add "livekit-agents[rime]~=1.4"

pnpm add @livekit/agents-plugin-rime@1.x

Authentication

The Rime plugin requires a Rime API key.

Set RIME_API_KEY in your .env file.

Usage

Use Rime TTS within an AgentSession or as a standalone speech generator. For example, you can use this TTS in the Voice AI quickstart.

from livekit.plugins import rime

session = AgentSession(
   tts=rime.TTS(
      model="arcana",
      speaker="celeste",
      speed_alpha=0.9,
   ),
   # ... llm, stt, etc.
)

import * as rime from '@livekit/agents-plugin-rime';

const session = new voice.AgentSession({
    tts: new rime.TTS({
      modelId: "arcana",
      speaker: "celeste",
      speedAlpha: 0.9,
    }),
    // ... llm, tts, etc.
});

Parameters

This section describes some of the available parameters. See the plugin reference for a complete list of all available parameters.

Additional resources

The following resources provide more information about using Rime with LiveKit Agents.

Python

PyPIReferenceGitHub

Node.js

NPMReferenceGitHub

Rime docs

Rime TTS docs.

Voice AI quickstart

Get started with LiveKit Agents and Rime TTS.