Metadata-Version: 2.4
Name: livekit-plugins-did
Version: 1.5.12
Summary: Agent Framework plugin for D-ID avatar
Project-URL: Documentation, https://docs.livekit.io
Project-URL: Website, https://livekit.io/
Project-URL: Source, https://github.com/livekit/agents
Author-email: LiveKit <support@livekit.io>
License-Expression: Apache-2.0
Keywords: ai,audio,avatar,d-id,livekit,realtime,video,voice,webrtc
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.10
Classifier: Topic :: Multimedia :: Sound/Audio
Classifier: Topic :: Multimedia :: Video
Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
Requires-Python: >=3.10.0
Requires-Dist: livekit-agents>=1.5.12
Description-Content-Type: text/markdown

# 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`

## Supported avatars

This plugin only supports **v4 avatars** (type: `expressive`). Earlier avatar versions are not compatible. See the [D-ID Create Agent API](https://docs.d-id.com/reference/createagent) for details on creating a compatible agent.

Example — creating an expressive agent via the D-ID API:
```bash
curl -X POST https://api.d-id.com/agents \
  -H "Authorization: Basic <YOUR_API_KEY>" \
  -H "Content-Type: application/json" \
  -d '{
    "presenter": {
      "type": "expressive",
      "presenter_id": "public_mia_elegant@avt_TJ0Tq5"
    },
    "preview_name": "My Expressive Agent"
  }'
```

Use the agent ID from the response as the `agent_id` parameter in the plugin.
