Skip to main content

Beyond Presence virtual avatar integration guide

How to use the Beyond Presence virtual avatar plugin for LiveKit Agents.

Available inPython
|
Node.js

Overview

Beyond Presence  provides hyper-realistic interactive avatars for conversational video AI agents. You can use the open source Beyond Presence integration for LiveKit Agents to add virtual avatars to your voice AI app.

Avatar: 694c83e2-8895-4a98-bd16-56332ca3f449

Installation

uv add "livekit-agents[bey]~=1.5"
pnpm add @livekit/agents-plugin-bey

Authentication

The Beyond Presence plugin requires a Beyond Presence API key .

Set BEY_API_KEY in your .env file.

Usage

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

from livekit.plugins import bey
session = AgentSession(
# ... stt, llm, tts, etc.
)
avatar = bey.AvatarSession(
avatar_id="...", # ID of the Beyond Presence avatar to use
)
# 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=ctx.room,
)
import { voice } from '@livekit/agents';
import * as bey from '@livekit/agents-plugin-bey';
const session = new voice.AgentSession({
// ... stt, llm, tts, etc.
});
const avatar = new bey.AvatarSession({
avatarId: "...", // ID of the Beyond Presence avatar to use
});
// Start the avatar and wait for it to join
await avatar.start(session, room);
// Start your agent session with the user
await session.start();

Preview the avatar in the Agent Console or a frontend starter app that you build.

Parameters

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

avatar_idstringDefault: b9be11b8-89fb-4227-8f86-4a881393cbdb

ID of the Beyond Presence avatar to use.

avatar_participant_identitystringDefault: bey-avatar-agent

The identity of the participant to use for the avatar.

avatar_participant_namestringDefault: bey-avatar-agent

The name of the participant to use for the avatar.

Additional resources

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