Simplismart TTS plugin guide | LiveKit Documentation

Available in

Python

Overview

This plugin allows you to use Simplismart as a TTS provider for your voice agents.

Quick reference

This section provides a quick reference for the Simplismart TTS plugin. For more information, see Additional resources.

Installation

Install the plugin from PyPI:

uv add "livekit-agents[simplismart]~=1.3"

Authentication

The Simplismart plugin requires a Simplismart API key.

Set SIMPLISMART_API_KEY in your .env file.

Usage

Use Simplismart 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 simplismart

session = AgentSession(
   tts=simplismart.TTS(
      model="canopylabs/orpheus-3b-0.1-ft",
      voice="tara"
   )
   # ... llm, stt, etc.
)

Parameters

This section describes some of the parameters you can set when you create a Simplismart TTS. See the plugin reference links in the Additional resources section for a complete list of all available parameters.

modelstr | TTSModelsOptionalDefault: canopylabs/orpheus-3b-0.1-ft

Model identifier for the backend TTS model. Examples include canopylabs/orpheus-3b-0.1-ft and maya-research/Veena. See plugin reference for full list.

voicestrOptionalDefault: tara

Voice identifier to use for generation.

temperaturefloatOptionalDefault: 0.7

Controls the randomness in the model output. Lower values make output more deterministic.

top_pfloatOptionalDefault: 0.9

Nucleus sampling probability threshold. Limits the sampling pool of predicted tokens.

repetition_penaltyfloatOptionalDefault: 1.5

Penalty applied to repeated text to reduce repetition.

max_tokensintOptionalDefault: 1000

Maximum number of output tokens allowed in the synthesized speech.

Additional resources

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

Python plugin

Reference GitHub PyPI

Simplismart docs

Simplismart TTS docs.

Voice AI quickstart

Get started with LiveKit Agents and Simplismart TTS.