Inworld TTS integration guide

Overview

Inworld develops AI products for builders of consumer applications, including an accessible, high quality text-to-speech service for developers. With LiveKit's Inworld TTS integration and the Agents framework, you can build engaging and immersive voice AI experiences.

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:

pip install "livekit-agents[inworld]~=1.0"

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(voice="Hades")
   # ... 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"

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.

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.