Rime AI TTS

The Rime AI TTS provider enables your agent to use Rime AI's high-quality text-to-speech models for generating natural-sounding voice output.

Installation

Install the Rime AI-enabled VideoSDK Agents package:

pip install "videosdk-plugins-rime"

Importing

from videosdk.agents.plugins import RimeTTS

Authentication

The Rime plugin requires an Rime API key.

Set RIME_API_KEY in your .env file.

Example Usage

from videosdk.agents.plugins import RimeTTS
from videosdk.agents import Pipeline

# Initialize the Rime AI TTS model
tts = RimeTTS(
    speaker="river",
    model_id="mist",
    lang="eng",
    speed_alpha=1.0
)

#  Add tts to pipeline
pipeline = Pipeline(tts=tts)

note

When using .env file for credentials, don't pass them as arguments to model instances or context objects. The SDK automatically reads environment variables, so omit api_key and other credential parameters from your code.

Configuration Options

• speaker: (str) Voice ID to use (default: "river"). Must match the model's available speakers.
• model_id: (str) Rime model identifier (default: "mist"). Supported: "mist", "mistv2".
• lang: (str) Language code for the voice (default: "eng").
• sampling_rate: (int) The audio sampling rate in Hz (default: 24000).
• speed_alpha: (float) Controls speaking rate (default: 1.0, where 1.0 is normal speed).
• reduce_latency: (bool) Whether to minimize streaming delay (default: True).
• pause_between_brackets: (bool) Insert pauses around bracketed text (default: False).
• phonemize_between_brackets: (bool) Use phonemes for bracketed text (default: False).
• inline_speed_alpha: (str, optional) Optional per-word speed override (e.g., "1.2,1.0,0.8"). Defaults to None.
• temperature: (float, optional) Sampling temperature (Arcana model only). The server applies its own default when omitted.
• top_p: (float, optional) Nucleus sampling cutoff (Arcana model only).
• repetition_penalty: (float, optional) Repetition penalty (Arcana model only).
• max_tokens: (int, optional) Token limit for output (Arcana model only).
• api_key: (str) Rime API key. Can also be set via the RIME_API_KEY environment variable.

Additional Resources

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

• Rime AI docs: Rime AI docs.

SDK Reference

GitHub Repository

Python Package