Rime Speech-to-Text

Overview

RimeSTTService transcribes speech with Rime’s streaming recognition. Rime transcribes one utterance per stream, so the service streams each VAD speech segment as its own request and pushes interim transcripts followed by one final.

Rime STT API Reference

Pipecat’s API methods for Rime STT integration

Example Implementation

Complete example with Rime STT

Rime Documentation

Official Rime API documentation

Installation

uv add "pipecat-ai[rime]"

Prerequisites

Rime Account Setup

Before using RimeSTTService, you need:

Rime Account: Sign up at Rime AI
API Key: Generate an API key from your account dashboard

Required Environment Variables

RIME_API_KEY: Your Rime API key for authentication

Voice Activity Detection

RimeSTTService starts a request on VADUserStartedSpeakingFrame and ends it on VADUserStoppedSpeakingFrame. Use the user aggregator’s VAD analyzer or a VADProcessor so these frames reach the service.

Configuration

RimeSTTService

from pipecat.services.rime.stt import RimeSTTService

str | None

default:"None"

Rime API key. When None, the RIME_API_KEY environment variable is used.

int | None

default:"None"

Audio sample rate in Hz. When None, the pipeline’s input sample rate is used. Rime takes 8000, 16000, 24000, and 48000 Hz; any other rate is resampled to 16000 Hz before sending.

RimeSTTService.Settings

default:"None"

Runtime-configurable settings. See Settings below.

float | None

default:"RIME_TTFS_P99"

P99 latency from speech end to final transcript, in seconds. Override it for your deployment. See the STT benchmark.

Settings

Runtime-configurable settings passed via the settings constructor argument using RimeSTTService.Settings(...). These can be updated mid-conversation with STTUpdateSettingsFrame, and apply to speech segments that start afterwards. See Service Settings for details.

Parameter	Type	Default	Description
`model`	`None`	`None`	Must be `None`: Rime selects the recognizer. (Inherited from base STT settings.)
`language`	`Language \| str`	`"en"`	Spoken language as a BCP-47 tag, passed to Rime unchanged. See Rime’s documentation for supported languages. Must be a nonempty string. (Inherited from base STT settings.)
`mode`	`Literal["written", "verbatim"]`	`"written"`	`"written"` formats the transcript as written text. `"verbatim"` transcribes the words as spoken.
`context_terms`	`Sequence[str]`	`()`	Recognition hints, such as product names, kept in order. Each term must be nonempty and free of `<\|...\|>` control markers, and the terms joined with `", "` must fit in 1,024 UTF-8 bytes.
`output_contract`	`Literal["revised_hypotheses", "append_fragments"]`	`"revised_hypotheses"`	How Rime sends interim results: as replacement hypotheses or as append-only fragments. Both produce cumulative interim transcripts and one final.

The constructor raises ValueError for an invalid value or a non-empty extra. An invalid settings update pushes an ErrorFrame and leaves the settings unchanged.

Usage

Basic Setup

import os

from pipecat.services.rime.stt import RimeSTTService

stt = RimeSTTService(api_key=os.getenv("RIME_API_KEY"))

With Context Terms

stt = RimeSTTService(
    api_key=os.getenv("RIME_API_KEY"),
    settings=RimeSTTService.Settings(
        language="en",
        mode="verbatim",
        context_terms=["Pipecat", "Rime"],
    ),
)

Notes

Segment length: A speech segment that runs about 90 to 110 seconds without a pause fails with no transcript.
Transcript order: Finals are pushed in speech order. When the user resumes speaking before an earlier segment’s final arrives, only the latest segment’s final finalizes the turn.
Errors: A failed request pushes a non-fatal ErrorFrame naming the Rime error type and request ID.

Get Started

Standards

Pipecat Server

Client SDKs

Pipecat Flows

Pipecat Cloud

CLI

Pipecat Context Hub

Rime Speech-to-Text

Overview

Rime STT API Reference

Example Implementation

Rime Documentation

Installation

Prerequisites

Rime Account Setup

Required Environment Variables

Voice Activity Detection

Configuration

RimeSTTService

Settings

Usage

Basic Setup

With Context Terms

Notes

​Overview

Rime STT API Reference

Example Implementation

Rime Documentation

​Installation

​Prerequisites

​Rime Account Setup

​Required Environment Variables

​Voice Activity Detection

​Configuration

​RimeSTTService

​Settings

​Usage

​Basic Setup

​With Context Terms

​Notes

Overview

Installation

Prerequisites

Rime Account Setup

Required Environment Variables

Voice Activity Detection

Configuration

RimeSTTService

Settings

Usage

Basic Setup

With Context Terms

Notes