> ## Documentation Index
> Fetch the complete documentation index at: https://docs.zeroruntime.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Simli

> Use the Simli avatar plugin in a Zero Runtime pipeline. Setup and usage in Python.

Simli is an **avatar** plugin. It renders a real-time, lip-synced AI avatar video track
from the agent's speech.

## Setup

Set your Simli API key in the worker environment. Generate a key from the [Simli dashboard](https://app.simli.com/apikey):

```bash theme={null}
export SIMLI_API_KEY=<key>
```

## Usage

Import the plugin and pass it to the pipeline's `avatar` slot.

```python theme={null}
from zrt.plugins import SimliAvatar

avatar = SimliAvatar(
    face_id="<face-id>",   # falls back to SIMLI_FACE_ID / a default
)

# Pipeline(avatar=avatar, ...)
```

## Parameters

| Parameter    | Type   | Default | Description                                                                                                                           |
| ------------ | ------ | ------- | ------------------------------------------------------------------------------------------------------------------------------------- |
| `api_key`    | `str`  | `None`  | Simli API key. Falls back to the `SIMLI_API_KEY` environment variable when unset.                                                     |
| `face_id`    | `str`  | `""`    | Identifier of the face to render. Falls back to the `SIMLI_FACE_ID` environment variable, then to a built-in default face when empty. |
| `model`      | `str`  | `None`  | Optional Simli model identifier for the avatar.                                                                                       |
| `is_trinity` | `bool` | `False` | Set to `True` when the face ID belongs to a Trinity avatar, to keep lip-sync correct.                                                 |

The avatar renders the [TTS](/plugins/overview) output as a lip-synced video track in the room.