Quickstart

In 4 Schritten zum KI-Avatar

Integriere einen Avaluma-Avatar in deinen LiveKit-Agenten – in weniger als 30 Minuten.

1

LiveKit Agent erstellen

Falls du bereits einen LiveKit-Agenten hast, kannst du diesen Schritt überspringen. Andernfalls empfehlen wir das offizielle Agent Starter Repo von LiveKit als Einstieg.

Für den schnellen Einstieg empfehlen wir LiveKit Cloud im Free Tier – keine Infrastruktur nötig. Wer eine vollständig selbst gehostete Lösung bevorzugt, kann LiveKit auch on-prem betreiben.

Agent Starter Repo (LiveKit)
2

Avaluma Plugin installieren

Installiere das offizielle Avaluma LiveKit Plugin über pip.

pip install git+https://github.com/avaluma-ai/avaluma-livekit-plugin.git
3

agent.py anpassen

Füge die folgenden Imports hinzu und ersetze await session.start durch den Avatar-Setup-Block.

Imports hinzufügen
from avaluma_livekit_plugin import AvatarSession
from livekit.agents import RoomOutputOptions
Suche nach await session.start und füge dort den folgenden Avatar-Setup-Block hinzu:
# Avatar
avatar = AvatarSession(
    license_key=YOUR_AVALUMA_KEY,
    avatar_id="260218-Avaluma_Avatar_Kadda_v5",  # Avatar identifier without .hvia ("string" -> test stream)
    avaluma_server_url="https://api.avaluma.ai",
)
# Start the avatar and wait for it to join
await avatar.start(room=ctx.room, agent_session=session)

# Start the session, which initializes the voice pipeline and warms up the models
await session.start(
    agent=Assistant(),
    room=ctx.room,
    room_input_options=RoomInputOptions(
        # For telephony applications, use `BVCTelephony` for best results
        noise_cancellation=noise_cancellation.BVC(),
    ),
    room_output_options=RoomOutputOptions(audio_enabled=False),
)

Der Avaluma-Key kann im Login Bereich erstellt werden.

4

Avatar & Agent im LiveKit Playground testen

Starte deinen Agenten und teste ihn direkt im LiveKit Agents Playground – der einfachste und schnellste Weg, um Agent und Avatar in Aktion zu sehen.

LiveKit Playground öffnen

Für die Integration in Web- und Mobile Apps bietet LiveKit entsprechende SDKs und Beispielprojekte – von React und JavaScript über Swift bis hin zu Android.

LiveKit Frontend SDKs & Beispiele für Web, iOS, Android und mehr.

5

Self-Hosting (optional)

Du kannst den Avaluma Avatar Server auch selbst mit Docker hosten – vollständig on-prem, ohne Abhängigkeit von api.avaluma.ai.

1. .hvia-Datei vorbereiten

Lade deine .hvia-Datei im Login-Bereich herunter und lege sie in einen lokalen assets/-Ordner. Dieser Ordner wird in den Container gemountet.

Die .hvia-Datei enthält dein Avatar-Modell und kann via dev@avaluma.ai angefragt werden.

2. Docker Compose starten
services:
  avaluma-avatar:
    image: ghcr.io/avaluma-ai/avaluma-avatar-server:latest
    ports:
      - "8080:8080"
    environment:
      - API_UTILS_PWD="CHANGE_THIS"
    volumes:
      - ./assets:/app/assets   # .hvia-Dateien hier ablegen
    deploy:
      resources:
        reservations:
          devices:
            - driver: nvidia
              count: all
              capabilities: [gpu, compute, utility, graphics]
    
3. avaluma_server_url in agent.py anpassen

Stelle sicher, dass avaluma_server_url auf deinen Container zeigt – nicht mehr auf api.avaluma.ai.

avatar = AvatarSession(
    license_key=YOUR_AVALUMA_KEY,
    avatar_id="your-avatar-name",  # Dateiname ohne .hvia
    avaluma_server_url="http://localhost:8080",  # zeigt auf deinen Container
)

Brauchst du Hilfe?

Schreib uns oder schau in die Dokumentation.