feat: Add D-ID avatar plugin

examples/avatar_agents/did/README.md

@@ -0,0 +1,27 @@
+# LiveKit D-ID Avatar Agent
+
+This example demonstrates how to create an animated avatar using [D-ID](https://www.d-id.com/).
+
+## Usage
+
+* Update the environment:
+
+```bash
+# D-ID Config
+export DID_API_KEY="..."
+export DID_AGENT_ID="..."
+
+# OpenAI config (or other models, tts, stt)
+export OPENAI_API_KEY="..."
+
+# LiveKit config
+export LIVEKIT_API_KEY="..."
+export LIVEKIT_API_SECRET="..."
+export LIVEKIT_URL="..."
+```
+
+* Start the agent worker:
+
+```bash
+python examples/avatar_agents/did/agent_worker.py dev
+```

examples/avatar_agents/did/agent_worker.py

@@ -0,0 +1,38 @@
+import logging
+import os
+
+from dotenv import load_dotenv
+
+from livekit.agents import Agent, AgentServer, AgentSession, JobContext, cli
+from livekit.plugins import did, openai
+
+logger = logging.getLogger("did-avatar-example")
+logger.setLevel(logging.INFO)
+
+load_dotenv()
+
+server = AgentServer()
+
+
+@server.rtc_session()
+async def entrypoint(ctx: JobContext):
+    session = AgentSession(
+        llm=openai.realtime.RealtimeModel(voice="alloy"),
+        resume_false_interruption=False,
+    )
+
+    agent_id = os.getenv("DID_AGENT_ID")
+    did_avatar = did.AvatarSession(agent_id=agent_id)
+    await did_avatar.start(session, room=ctx.room)
+
+    # start the agent, it will join the room and wait for the avatar to join
+    await session.start(
+        agent=Agent(instructions="Talk to me!"),
+        room=ctx.room,
+    )
+
+    session.generate_reply(instructions="say hello to the user")
+
+
+if __name__ == "__main__":
+    cli.run_app(server)

livekit-agents/pyproject.toml

@@ -117,6 +117,7 @@ upliftai = ["livekit-plugins-upliftai>=1.5.1"]
 gradium = ["livekit-plugins-gradium>=1.5.1"]
 xai = ["livekit-plugins-xai>=1.5.1"]
 phonic = ["livekit-plugins-phonic>=1.5.1"]
+did = ["livekit-plugins-did>=1.5.1"]
 
 
 [project.urls]

livekit-plugins/livekit-plugins-did/README.md

@@ -0,0 +1,15 @@
+# D-ID plugin for LiveKit Agents
+
+Support for the [D-ID](https://d-id.com/) virtual avatar.
+
+See the [D-ID integration docs](https://docs.livekit.io/agents/models/avatar/plugins/did/) for more information.
+
+## Installation
+
+```bash
+pip install livekit-plugins-did
+```
+
+## Pre-requisites
+
+You'll need an API key from D-ID. It can be set as an environment variable: `DID_API_KEY`

livekit-plugins/livekit-plugins-did/livekit/plugins/did/__init__.py

@@ -0,0 +1,42 @@
+# Copyright 2025 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.
+
+"""D-ID virtual avatar plugin for LiveKit Agents
+
+See https://docs.livekit.io/agents/integrations/avatar/did/ for more information.
+"""
+
+from .avatar import AvatarSession
+from .errors import DIDException
+from .types import AudioConfig
+from .version import __version__
+
+__all__ = [
+    "AudioConfig",
+    "AvatarSession",
+    "DIDException",
+    "__version__",
+]
+
+from livekit.agents import Plugin
+
+from .log import logger
+
+
+class DIDPlugin(Plugin):
+    def __init__(self) -> None:
+        super().__init__(__name__, __version__, __package__, logger)
+
+
+Plugin.register_plugin(DIDPlugin())

livekit-plugins/livekit-plugins-did/livekit/plugins/did/api.py

@@ -0,0 +1,92 @@
+import asyncio
+import os
+from typing import Any
+
+import aiohttp
+
+from livekit.agents import (
+    DEFAULT_API_CONNECT_OPTIONS,
+    NOT_GIVEN,
+    APIConnectionError,
+    APIConnectOptions,
+    APIStatusError,
+    NotGivenOr,
+    utils,
+)
+
+from .errors import DIDException
+from .log import logger
+
+DEFAULT_API_URL = "https://api.d-id.com"
+
+
+class DIDAPI:
+    def __init__(
+        self,
+        api_key: NotGivenOr[str] = NOT_GIVEN,
+        api_url: NotGivenOr[str] = NOT_GIVEN,
+        *,
+        conn_options: APIConnectOptions = DEFAULT_API_CONNECT_OPTIONS,
+        session: aiohttp.ClientSession | None = None,
+    ) -> None:
+        did_api_key = api_key if utils.is_given(api_key) else os.getenv("DID_API_KEY")
+        if not did_api_key:
+            raise DIDException("DID_API_KEY must be set")
+        self._api_key = did_api_key
+
+        self._api_url = api_url if utils.is_given(api_url) else DEFAULT_API_URL
+        self._conn_options = conn_options
+        self._session = session or aiohttp.ClientSession()
+
+    async def join_session(
+        self,
+        *,
+        agent_id: str,
+        transport: dict[str, Any],
+        audio_config: dict[str, Any],
+    ) -> str:
+        """Dispatch a D-ID avatar worker into the room.
+
+        Returns the session id.
+        """
+        payload: dict[str, Any] = {
+            "transport": transport,
+            "audio_config": audio_config,
+        }
+        response_data = await self._post(f"v2/agents/{agent_id}/sessions/join", payload)
+        return response_data["id"]  # type: ignore
+
+    async def _post(self, endpoint: str, payload: dict[str, Any]) -> dict[str, Any]:
+        url = f"{self._api_url}/{endpoint}"
+        num_attempts = self._conn_options.max_retry + 1
+        for attempt in range(num_attempts):
+            try:
+                async with self._session.post(
+                    url,
+                    headers={
+                        "Content-Type": "application/json",
+                        "Authorization": f"Basic {self._api_key}",
+                    },
+                    json=payload,
+                    timeout=aiohttp.ClientTimeout(sock_connect=self._conn_options.timeout),
+                ) as response:
+                    if not response.ok:
+                        text = await response.text()
+                        raise APIStatusError(
+                            "D-ID API error",
+                            status_code=response.status,
+                            body=text,
+                        )
+                    return await response.json()  # type: ignore
+            except APIStatusError:
+                raise
+            except (aiohttp.ClientError, asyncio.TimeoutError) as e:
+                logger.warning(
+                    f"D-ID API request failed (attempt {attempt + 1}/{num_attempts})",
+                    extra={"error": str(e)},
+                )
+                if attempt == num_attempts - 1:
+                    raise APIConnectionError(f"Failed to connect to D-ID API at {url}") from e
+                await asyncio.sleep(self._conn_options.retry_interval)
+
+        raise APIConnectionError(f"Failed to connect to D-ID API at {url}")

livekit-plugins/livekit-plugins-did/livekit/plugins/did/avatar.py

@@ -0,0 +1,126 @@
+from __future__ import annotations
+
+import os
+
+import aiohttp
+
+from livekit import api, rtc
+from livekit.agents import (
+    DEFAULT_API_CONNECT_OPTIONS,
+    NOT_GIVEN,
+    AgentSession,
+    APIConnectOptions,
+    NotGivenOr,
+    get_job_context,
+    utils,
+)
+from livekit.agents.voice.avatar import DataStreamAudioOutput
+from livekit.agents.voice.room_io import ATTRIBUTE_PUBLISH_ON_BEHALF
+
+from .api import DIDAPI
+from .errors import DIDException
+from .log import logger
+from .types import AudioConfig
+
+_AVATAR_AGENT_IDENTITY = "d-id-avatar-agent"
+_AVATAR_AGENT_NAME = "d-id-avatar-agent"
+
+
+class AvatarSession:
+    """A D-ID avatar session"""
+
+    def __init__(
+        self,
+        *,
+        agent_id: str,
+        api_url: NotGivenOr[str] = NOT_GIVEN,
+        api_key: NotGivenOr[str] = NOT_GIVEN,
+        audio_config: AudioConfig | None = None,
+        avatar_participant_identity: NotGivenOr[str] = NOT_GIVEN,
+        avatar_participant_name: NotGivenOr[str] = NOT_GIVEN,
+        conn_options: APIConnectOptions = DEFAULT_API_CONNECT_OPTIONS,
+    ) -> None:
+        self._http_session: aiohttp.ClientSession | None = None
+        self._conn_options = conn_options
+        self._agent_id = agent_id
+        self._audio_config = audio_config or AudioConfig()
+        self.session_id: str | None = None
+
+        self._api = DIDAPI(
+            api_url=api_url,
+            api_key=api_key,
+            conn_options=conn_options,
+            session=self._ensure_http_session(),
+        )
+
+        self._avatar_participant_identity = (
+            avatar_participant_identity
+            if utils.is_given(avatar_participant_identity)
+            else _AVATAR_AGENT_IDENTITY
+        )
+        self._avatar_participant_name = (
+            avatar_participant_name
+            if utils.is_given(avatar_participant_name)
+            else _AVATAR_AGENT_NAME
+        )
+
+    def _ensure_http_session(self) -> aiohttp.ClientSession:
+        if self._http_session is None:
+            self._http_session = utils.http_context.http_session()
+
+        return self._http_session
+
+    async def start(
+        self,
+        agent_session: AgentSession,
+        room: rtc.Room,
+        *,
+        livekit_url: NotGivenOr[str] = NOT_GIVEN,
+        livekit_api_key: NotGivenOr[str] = NOT_GIVEN,
+        livekit_api_secret: NotGivenOr[str] = NOT_GIVEN,
+    ) -> None:
+        _livekit_url = livekit_url if utils.is_given(livekit_url) else os.getenv("LIVEKIT_URL")
+        _livekit_api_key = (
+            livekit_api_key if utils.is_given(livekit_api_key) else os.getenv("LIVEKIT_API_KEY")
+        )
+        _livekit_api_secret = (
+            livekit_api_secret
+            if utils.is_given(livekit_api_secret)
+            else os.getenv("LIVEKIT_API_SECRET")
+        )
+        if not _livekit_url or not _livekit_api_key or not _livekit_api_secret:
+            raise DIDException(
+                "livekit_url, livekit_api_key, and livekit_api_secret must be set "
+                "by arguments or environment variables"
+            )
+
+        job_ctx = get_job_context()
+        local_participant_identity = job_ctx.local_participant_identity
+        livekit_token = (
+            api.AccessToken(api_key=_livekit_api_key, api_secret=_livekit_api_secret)
+            .with_kind("agent")
+            .with_identity(self._avatar_participant_identity)
+            .with_name(self._avatar_participant_name)
+            .with_grants(api.VideoGrants(room_join=True, room=room.name))
+            .with_attributes({ATTRIBUTE_PUBLISH_ON_BEHALF: local_participant_identity})
+            .to_jwt()
+        )
+
+        logger.debug("starting avatar session")
+        self.session_id = await self._api.join_session(
+            agent_id=self._agent_id,
+            transport={
+                "provider": "livekit",
+                "server_url": _livekit_url,
+                "token": livekit_token,
+                "room_name": room.name,
+            },
+            audio_config={"sample_rate": self._audio_config.sample_rate},
+        )
+
+        agent_session.output.audio = DataStreamAudioOutput(
+            room=room,
+            destination_identity=self._avatar_participant_identity,
+            sample_rate=self._audio_config.sample_rate,
+            wait_remote_track=rtc.TrackKind.KIND_VIDEO,
+        )

livekit-plugins/livekit-plugins-did/livekit/plugins/did/errors.py

@@ -0,0 +1,4 @@
+class DIDException(Exception):
+    """Custom exception for D-ID API errors."""
+
+    pass

livekit-plugins/livekit-plugins-did/livekit/plugins/did/log.py

@@ -0,0 +1,3 @@
+import logging
+
+logger = logging.getLogger("livekit.plugins.did")

livekit-plugins/livekit-plugins-did/livekit/plugins/did/types.py

@@ -0,0 +1,14 @@
+from dataclasses import dataclass
+
+DEFAULT_SAMPLE_RATE = 24000
+
+
+@dataclass
+class AudioConfig:
+    """Configuration for the audio sent to the D-ID avatar.
+
+    Attributes:
+        sample_rate: Sample rate in Hz. Supported values: 16000, 24000, 48000.
+    """
+
+    sample_rate: int = DEFAULT_SAMPLE_RATE

livekit-plugins/livekit-plugins-did/livekit/plugins/did/version.py

@@ -0,0 +1,15 @@
+# Copyright 2025 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.
+
+__version__ = "1.5.1"