Keyframe Labs Plugin Init

Author: kradkfl

CONTRIBUTING.md

@@ -92,6 +92,7 @@ uv pip install pip && uv run mypy --install-types --non-interactive \
     -p livekit.plugins.baseten \
     -p livekit.plugins.sarvam \
     -p livekit.plugins.inworld \
+    -p livekit.plugins.keyframe \
     -p livekit.plugins.simli \
     -p livekit.plugins.anam
 ```

examples/avatar_agents/keyframe/README.md

@@ -0,0 +1,44 @@
+# LiveKit Keyframe Labs Avatar Agent
+
+This example demonstrates how to create an avatar using [Keyframe Labs](https://keyframelabs.com/).
+
+See available personas [here](https://platform.keyframelabs.com).
+
+## Usage
+
+* Update the environment:
+
+```bash
+# Keyframe Config (use either PERSONA_ID or PERSONA_SLUG, not both)
+export KEYFRAME_API_KEY="..."
+export KEYFRAME_PERSONA_ID="..."
+# or: export KEYFRAME_PERSONA_SLUG="public:luna"
+
+# LiveKit config
+export LIVEKIT_API_KEY="..."
+export LIVEKIT_API_SECRET="..."
+export LIVEKIT_URL="..."
+```
+
+* Start the agent worker:
+
+```bash
+python examples/avatar_agents/keyframe/agent_worker.py dev
+```
+
+## Emotion Control
+
+You can change the avatar's facial expression at runtime using `set_emotion()`:
+
+```python
+await avatar.set_emotion("happy")  # "neutral", "happy", "sad", "angry"
+```
+
+To let the LLM control the avatar's expression, register it as a tool:
+
+```python
+@session.tool()
+async def set_avatar_emotion(emotion: keyframe.Emotion):
+    """Set the avatar's facial expression and demeanor."""
+    await avatar.set_emotion(emotion)
+```

examples/avatar_agents/keyframe/agent_worker.py

@@ -0,0 +1,61 @@
+"""
+Minimal LiveKit agent with Keyframe avatar plugin.
+"""
+
+from dotenv import load_dotenv
+
+from livekit.agents import (
+    Agent,
+    AgentSession,
+    JobContext,
+    RunContext,
+    WorkerOptions,
+    cli,
+    function_tool,
+)
+from livekit.plugins import keyframe, openai
+from livekit.plugins.keyframe import Emotion
+
+load_dotenv()
+
+
+class AvatarAgent(Agent):
+    def __init__(self, avatar: keyframe.AvatarSession) -> None:
+        super().__init__(
+            instructions=(
+                "You are a friendly voice assistant with an avatar. "
+                "Use the set_emotion tool to change your facial expression "
+                "whenever the conversation mood shifts."
+            ),
+        )
+        self._avatar = avatar
+
+    @function_tool()
+    async def set_emotion(self, context: RunContext, emotion: Emotion) -> str:
+        """Set the avatar's facial expression to match the conversation mood.
+
+        Args:
+            emotion: The emotion to express. One of 'neutral', 'happy', 'sad', or 'angry'.
+        """
+        await self._avatar.set_emotion(emotion)
+        return f"Emotion set to {emotion}"
+
+
+async def entrypoint(ctx: JobContext):
+    await ctx.connect()
+
+    session = AgentSession(
+        llm=openai.realtime.RealtimeModel(voice="marin"),
+    )
+
+    avatar = keyframe.AvatarSession(persona_slug="public:lyra_persona-1.5-live")
+    await avatar.start(session, room=ctx.room)
+
+    await session.start(
+        agent=AvatarAgent(avatar=avatar),
+        room=ctx.room,
+    )
+
+
+if __name__ == "__main__":
+    cli.run_app(WorkerOptions(entrypoint_fnc=entrypoint))

livekit-plugins/livekit-plugins-keyframe/README.md

@@ -0,0 +1,35 @@
+# livekit-plugins-keyframe
+
+Agent Framework plugin for [Keyframe Labs](https://keyframelabs.com) avatars.
+
+## Installation
+
+```bash
+pip install livekit-plugins-keyframe
+```
+
+## Usage
+
+```python
+from livekit.agents import AgentSession
+from livekit.plugins import keyframe
+
+session = AgentSession(stt=..., llm=..., tts=...)
+
+avatar = keyframe.AvatarSession(
+    persona_id="ab85a2a0-0555-428d-87b2-ff3019a58b93",  # or persona_slug="public:cosmo_persona-1.5-live"
+    api_key="keyframe_sk_live_...",  # or set KEYFRAME_API_KEY env var
+)
+
+await avatar.start(session, room=ctx.room)
+await session.start(room=ctx.room, agent=my_agent)
+```
+
+## Authentication
+
+Set the following environment variables:
+
+- `KEYFRAME_API_KEY` - Your Keyframe API key
+- `LIVEKIT_URL` - LiveKit server URL
+- `LIVEKIT_API_KEY` - LiveKit API key
+- `LIVEKIT_API_SECRET` - LiveKit API secret

livekit-plugins/livekit-plugins-keyframe/livekit/plugins/keyframe/__init__.py

@@ -0,0 +1,38 @@
+# Copyright 2023 LiveKit, Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+from .avatar import AvatarSession
+from .errors import KeyframeException
+from .types import Emotion, PersonaConfig
+from .version import __version__
+
+__all__ = [
+    "AvatarSession",
+    "Emotion",
+    "KeyframeException",
+    "PersonaConfig",
+    "__version__",
+]
+
+from livekit.agents import Plugin
+
+from .log import logger
+
+
+class KeyframePlugin(Plugin):
+    def __init__(self) -> None:
+        super().__init__(__name__, __version__, __package__, logger)
+
+
+Plugin.register_plugin(KeyframePlugin())

livekit-plugins/livekit-plugins-keyframe/livekit/plugins/keyframe/api.py

@@ -0,0 +1,119 @@
+from __future__ import annotations
+
+import asyncio
+from typing import Any
+
+import aiohttp
+
+from livekit.agents import (
+    DEFAULT_API_CONNECT_OPTIONS,
+    APIConnectionError,
+    APIConnectOptions,
+    APIStatusError,
+)
+
+from .log import logger
+
+DEFAULT_API_URL = "https://api.keyframelabs.com"
+
+
+class KeyframeAPI:
+    """Asynchronous client for the Keyframe Labs session API."""
+
+    def __init__(
+        self,
+        api_key: str,
+        api_url: str,
+        *,
+        conn_options: APIConnectOptions = DEFAULT_API_CONNECT_OPTIONS,
+        session: aiohttp.ClientSession | None = None,
+    ) -> None:
+        self._api_key = api_key
+        self._api_url = api_url
+        self._conn_options = conn_options
+        self._session = session
+        self._own_session = session is None
+
+    async def __aenter__(self) -> KeyframeAPI:
+        if self._own_session:
+            self._session = aiohttp.ClientSession()
+        return self
+
+    async def __aexit__(
+        self, exc_type: type | None, exc_val: Exception | None, exc_tb: Any
+    ) -> None:
+        if self._own_session and self._session and not self._session.closed:
+            await self._session.close()
+
+    async def create_plugin_session(
+        self,
+        *,
+        persona_id: str | None = None,
+        persona_slug: str | None = None,
+        room_name: str,
+        livekit_url: str,
+        livekit_token: str,
+        source_participant_identity: str,
+    ) -> dict[str, Any]:
+        """Create a plugin session via POST /v1/sessions/plugins/livekit.
+
+        Returns dict with reservation_id and avatar_participant_identity.
+        """
+        payload: dict[str, Any] = {
+            "room_name": room_name,
+            "livekit_url": livekit_url,
+            "livekit_token": livekit_token,
+            "source_participant_identity": source_participant_identity,
+        }
+        if persona_id:
+            payload["persona_id"] = persona_id
+        if persona_slug:
+            payload["persona_slug"] = persona_slug
+
+        headers = {
+            "Authorization": f"Bearer {self._api_key}",
+            "Content-Type": "application/json",
+        }
+        return await self._post("/v1/sessions/plugins/livekit", payload, headers)
+
+    async def _post(
+        self, endpoint: str, payload: dict[str, Any], headers: dict[str, str]
+    ) -> dict[str, Any]:
+        url = f"{self._api_url}{endpoint}"
+        session = self._session or aiohttp.ClientSession()
+        try:
+            for i in range(self._conn_options.max_retry + 1):
+                try:
+                    async with session.post(
+                        url,
+                        headers=headers,
+                        json=payload,
+                        timeout=aiohttp.ClientTimeout(sock_connect=self._conn_options.timeout),
+                    ) as response:
+                        if not response.ok:
+                            text = await response.text()
+                            raise APIStatusError(
+                                f"Keyframe API error for {url}: {response.status}",
+                                status_code=response.status,
+                                body=text,
+                            )
+                        return await response.json()  # type: ignore
+                except Exception as e:
+                    if isinstance(e, APIStatusError) and not e.retryable:
+                        raise APIConnectionError(
+                            f"Failed to call Keyframe API at {url} with non-retryable error",
+                            retryable=False,
+                        ) from e
+
+                    if isinstance(e, APIConnectionError):
+                        logger.warning("Failed to call Keyframe API", extra={"error": str(e)})
+                    else:
+                        logger.exception("Failed to call Keyframe API")
+
+                    if i < self._conn_options.max_retry:
+                        await asyncio.sleep(self._conn_options._interval_for_retry(i))
+        finally:
+            if not self._session:
+                await session.close()
+
+        raise APIConnectionError("Failed to call Keyframe API after all retries.")