LiveKit Integration

Documentation Index

Fetch the complete documentation index at: https://lemonslice.com/docs/llms.txt

Use this file to discover all available pages before exploring further.

​

Overview

​

Prerequisites

1. LemonSlice avatar configuration (either a base image URL or a LemonSlice avatar ID)
   • Agent base image — a publicly accessible image URL of your avatar, focused on the face. The image should be 368 × 560 pixels. LemonSlice will automatically center-crop your image to the target aspect ratio if the dimensions do not match the expected values. Best results are achieved with anthropomorphic images where the face and mouth are clearly identifiable.
   • LemonSlice Agent ID
     Selected voices and personalities for a LemonSlice agent will be ignored when using the LiveKit plugin.
2. LiveKit Agents app
   • Your own existing application, or
   • The ready-to-use LemonSlice LiveKit Agent Python Example, or
   • Follow the LiveKit VoiceAI quickstart for Python or Node.js to create one.

​

How to use

# When using PIP
pip install "livekit-agents[lemonslice]"

# When using UV
uv add "livekit-agents[lemonslice]"

from livekit import agents
from livekit.agents import AgentSession, RoomOutputOptions
from livekit.plugins import lemonslice

async def entrypoint(ctx: agents.JobContext):
    await ctx.connect()

    session = AgentSession(
        # Add STT, LLM, TTS, and other components here
    )

    avatar = lemonslice.AvatarSession(
        # Publicly accessible image URL for the avatar
        agent_image_url="...",
        # Prompt to guide the avatar's demeanor
        agent_prompt="a person talking"
    )

    # Start the avatar and wait for it to join
    session_id = await avatar.start(session, room=ctx.room)

    # Start your agent session with the user
    await session.start(
        # ... room, agent, room_options, etc....
    )

LEMONSLICE_RPC_TOPIC = "lemonslice"
AVATAR_READY_MSG_TYPE = "bot_ready"

def on_data_received(packet: rtc.DataPacket) -> None:
    if packet.topic != LEMONSLICE_RPC_TOPIC:
        return

    try:
        payload = json.loads(packet.data.decode("utf-8"))
    except (UnicodeDecodeError, json.JSONDecodeError):
        logger.warning("Unable to decode LemonSlice RPC JSON", exc_info=True)
        return

    if (
        not isinstance(payload, dict)
        or payload.get("type") != AVATAR_READY_MSG_TYPE
    ):
        return

    session_id = payload.get("session_id")
    logger.info(f"Avatar has joined and is ready! session_id = {session_id}")

room.on("data_received", on_data_received)

@server.rtc_session()
async def my_agent(ctx: agents.JobContext):
  ...

​

Example Code