Skip to main content

Avatario Realtime Avatar integration guide

How to use the Avatario virtual avatar plugin for LiveKit Agents.

Available in
Python

Overview

Avatario's Realtime Avatars let you create your own avatar that can participate in live, interactive conversations. You can use the open-source Avatario integration for LiveKit Agents in your voice AI app.

Quick reference

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

Installation

Install the plugin from PyPI:

uv add "livekit-plugins-avatario~=1.4"

Authentication

The Avatario plugin requires a Avatario API key.

Set AVATARIO_API_KEY in your .env file.

Avatar setup

The Avatario plugin requires an avatar ID, which can either be set as the AVATARIO_AVATAR_ID environment variable or as the avatar_id argument in the avatar session. You can choose an avatar on the Avatario dashboard.

Usage

Use the plugin in an AgentSession. For example, you can use this avatar in the Voice AI quickstart.

from livekit import agents
from livekit.agents import AgentServer, AgentSession
from livekit.plugins import avatario
server = AgentServer()
@server.rtc_session(agent_name="my-agent")
async def my_agent(ctx: agents.JobContext):
session = AgentSession(
# ... stt, llm, tts, etc.
)
avatar = avatario.AvatarSession(
avatar_id="...", # ID of the Avatario avatar to use. See "Avatar setup" for details.
)
# Start the avatar and wait for it to join
await avatar.start(session, room=ctx.room)
# Start your agent session with the user
await session.start(
# ... room, agent, room_options, etc....
)

Preview the avatar in the Agents Playground or your own frontend starter app.

Parameters

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

avatar_idstringOptional

ID of the Avatario avatar to use. See Avatar setup for details.

avatar_participant_namestringOptionalDefault: avatario-avatar-agent

The name of the participant to use for the avatar.

Additional resources

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