Azure OpenAI TTS integration guide

Overview

Azure OpenAI provides OpenAI services hosted on Azure. With LiveKit's Azure OpenAI TTS integration and the Agents framework, you can build voice AI applications that sound realistic and natural.

To learn more about TTS and generating agent speech, see Agent speech.

Quick reference

This section includes a basic usage example and some reference material. For links to more detailed documentation, see Additional resources.

Installation

Support for Azure OpenAI TTS is available in the openai plugin.

Install the plugin from PyPI:

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

Authentication

The Azure OpenAI TTS requires authentication using an API key or a managed identity.

Set the following environment variables in your .env file:

AZURE_OPENAI_API_KEY=<azure-openai-api-key>
AZURE_OPENAI_AD_TOKEN=<azure-openai-ad-token>
AZURE_OPENAI_ENDPOINT=<azure-openai-endpoint>

Usage

Use Azure OpenAI 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 openai

session = AgentSession(
   tts=openai.TTS.with_azure(
      model="gpt-4o-mini-tts",
      voice="coral",
   )
   # ... llm, stt, etc.
)

Parameters

This section describes some of the available parameters. For a complete reference of all available parameters, see the plugin reference.

modelstringOptionalDefault: gpt-4o-mini-tts

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

voicestringOptionalDefault: ash

OpenAI text-to-speech voice. To learn more, see the list of supported voices for voice in the Azure documentation.

instructionsstringOptional

Instructions to control tone, style, and other characteristics of the speech.

azure_endpointstringOptionalEnv: AZURE_OPENAI_ENDPOINT

Azure OpenAI endpoint in the following format: https://{your-resource-name}.openai.azure.com.

azure_deploymentstringOptional

Name of your model deployment.

api_versionstringOptionalEnv: OPENAI_API_VERSION

OpenAI REST API version used for the request.

api_keystringOptionalEnv: AZURE_OPENAI_API_KEY

Azure OpenAI API key.

azure_ad_tokenstringOptionalEnv: AZURE_OPENAI_AD_TOKEN

Azure Active Directory token.

organizationstringOptionalEnv: OPENAI_ORG_ID

OpenAI organization ID.

projectstringOptionalEnv: OPENAI_PROJECT_ID

OpenAI project ID.

Additional resources

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

Python package

The livekit-plugins-openai package on PyPI.

Plugin reference

Reference for the Azure OpenAI TTS plugin.

GitHub repo

View the source or contribute to the LiveKit Azure OpenAI plugin.

Azure OpenAI

Azure OpenAI documentation.

Voice AI quickstart

Get started with LiveKit Agents and Azure OpenAI.

Azure ecosystem guide

Overview of the entire Azure AI and LiveKit Agents integration.