Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 31 additions & 0 deletions livekit-plugins/livekit-plugins-rumik/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
# Rumik AI plugin for LiveKit Agents

Support for speech synthesis (TTS) with the [Rumik AI](https://rumik.ai/) API.

## Installation

```bash
pip install livekit-plugins-rumik
```

## Pre-requisites

You'll need an API key from Rumik AI. It can be set as an environment variable: `RUMIK_API_KEY`

## Usage

### Text-to-Speech

```python
from livekit.plugins import rumik

# Standard tone-steered TTS (muga)
tts = rumik.TTS(model="muga")

# Rich instruct-based TTS (mulberry)
tts = rumik.TTS(
model="mulberry",
description="warm, upbeat narrator",
speaker="speaker_2",
)
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
# Copyright 2026 LiveKit, Inc.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

"""Rumik AI plugin for LiveKit Agents

See https://docs.livekit.io/agents/integrations/rumik/ for more information.
"""

from .tts import TTS as TTS, ChunkedStream as ChunkedStream
from .version import __version__ as __version__

__all__ = ["TTS", "ChunkedStream", "__version__"]

from livekit.agents import Plugin


class RumikPlugin(Plugin):
def __init__(self) -> None:
super().__init__(__name__, __version__, __package__)


Plugin.register_plugin(RumikPlugin())

# Cleanup docs of unexported modules
_module = dir()
NOT_IN_ALL = [m for m in _module if m not in __all__]

__pdoc__ = {}

for n in NOT_IN_ALL:
__pdoc__[n] = False
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# Simple logger for the plugin
import logging

logger = logging.getLogger("livekit.plugins.rumik")
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
from typing import Literal

TTSModels = Literal[
"muga",
"mulberry",
]
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Marker file for PEP 561.
Loading