Skip to main content

OpenAI TTS plugin guide

How to use the OpenAI TTS plugin for LiveKit Agents.

Available in
Python
|
Node.js
Try LiveKit.fm

Chat with OpenAI's latest `gpt-4o-mini-tts` model in a LiveKit demo inspired by OpenAI.fm

Try LiveKit.fm

Overview

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

Installation

Install the plugin from PyPI:

pip install "livekit-agents[openai]~=1.5"
pnpm add @livekit/agents-plugin-openai@1.x

Authentication

The OpenAI plugin requires an OpenAI API key .

Set OPENAI_API_KEY in your .env file.

Usage

Use OpenAI TTS in an AgentSession or as a standalone speech generator. For example, you can use this TTS in the Voice AI quickstart.

from livekit.plugins import openai
session = AgentSession(
tts = openai.TTS(
model="gpt-4o-mini-tts",
voice="ash",
instructions="Speak in a friendly and conversational tone.",
),
# ... llm, stt, etc.
)
import * as openai from '@livekit/agents-plugin-openai';
const session = new voice.AgentSession({
tts: new openai.TTS(
model: "gpt-4o-mini-tts",
voice: "ash",
instructions: "Speak in a friendly and conversational tone.",
),
// ... llm, stt, etc.
});

Parameters

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

modelTTSModels | stringDefault: gpt-4o-mini-tts

ID of the model to use for speech generation. To learn more, see TTS models .

voiceTTSVoice | stringDefault: ash

ID of the voice used for speech generation. To learn more, see TTS voice options .

instructionsstring

Instructions to control tone, style, and other characteristics of the speech. Does not work with tts-1 or tts-1-hd models.

Additional resources

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