Inworld TTS plugin guide | LiveKit Documentation

Available in

Python

Node.js

Overview

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

LiveKit Inference

Inworld TTS is also available in LiveKit Inference, with billing and integration handled automatically. See the docs for more information.

Quick reference

This section includes a brief overview of the Inworld TTS plugin. For more information, see Additional resources.

Installation

Install the plugin from PyPI:

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

pnpm add @livekit/agents-plugin-inworld@1.x

Authentication

The Inworld plugin requires Base64 Inworld API key.

Set INWORLD_API_KEY in your .env file.

Usage

Use Inworld 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 inworld

session = AgentSession(
   tts=inworld.TTS(model="inworld-tts-1.5-max", voice="Ashley")
   # ... llm, stt, etc.
)

import * as inworld from '@livekit/agents-plugin-inworld';

const session = new voice.AgentSession({
    tts: inworld.TTS(
        model: "inworld-tts-1.5-max",
        voice: "Ashley",
    ),
    // ... llm, stt, etc.
});

Parameters

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

modelstringOptionalDefault: "inworld-tts-1.5-max"

ID of the model to use for generation. See supported models.

voicestringOptionalDefault: "Ashley"

ID of the voice to use for generation. Use the List voices API endpoint for possible values.

temperaturefloatOptionalDefault: 1.1

Controls randomness in the output. Recommended to set between 0.6 and 1.1. See docs.

speaking_ratefloatOptionalDefault: 1.0

Controls how fast the voice speaks. 1.0 is the normal native speed, while 0.5 is half the normal speed and 1.5 is 1.5x faster than the normal speed. See docs.

text_normalizationstringOptionalDefault: ON

Controls text normalization. When "ON", numbers, dates, and abbreviations are expanded (e.g., "Dr." -> "Doctor"). When "OFF", text is read exactly as written. See docs.

Customizing pronunciation

Inworld TTS supports customizing pronunciation. To learn more, see Custom Pronunciation guide.

Additional resources

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

Python package

The livekit-plugins-inworld package on PyPI.

Plugin reference

Reference for the Inworld TTS plugin.

GitHub repo

View the source or contribute to the LiveKit Inworld TTS plugin.

Inworld docs

Inworld TTS docs.