Gradium TTS plugin guide | LiveKit Documentation

Available in

Python

Overview

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

This section includes a brief overview of the Gradium TTS plugin.

Install the plugin from PyPI:

pip install "livekit-agents[gradium]~=1.3"

The Gradium plugin requires a Gradium API key.

Set GRADIUM_API_KEY in your .env file.

Use Gradium 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 gradium

session = AgentSession(
    tts=gradium.TTS(
    ),
    # ... llm, stt, etc.
)

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

voice_idstringOptionalDefault: YTpq7expH9539ERJ

Gradium TTS voice id to use.

json_configdict[str, Any]Optional

Defines advanced options for Gradium TTS such as speed, rewrite rules, and more. See the Gradium API docs for details on available options.

model_namestringOptionalDefault: default

Gradium TTS model to use.

model_endpointstringOptionalDefault: wss://eu.api.gradium.ai/api/speech/tts

Sets the endpoint to be used, switch to us.api.gradium.ai for US region.

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

The livekit-plugins-gradium package on PyPI.

Reference for the Gradium TTS plugin.

Gradium API documentation.

Get started with LiveKit Agents and Gradium TTS.