> ## 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 and JavaScript.

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.

<CodeGroup>
  ```python Python theme={null}
  from zeroruntime.plugins import SimliAvatar

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

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

  ```typescript Node JS theme={null}
  import { SimliAvatar } from '@zeroruntime/js-sdk/plugins';

  const avatar = SimliAvatar({
    config: { faceId: '<face-id>' },  // Simli's own config object
  });

  // Pipeline({ avatar, ... })
  ```
</CodeGroup>

## Parameters

| Parameter | Type | Default | Description |
| - | - | - | - |
| `api_key` | `str` | `None` | Simli API key. Falls back to the `SIMLI_API_KEY` environment variable when unset. |
| `config` | `SimliConfig` | *required* | Simli's own configuration object, from the `simli` package. Carries the face id and the rest of the vendor's settings. |
| `transport_mode` | `str` | `'P2P'` | Transport used to reach Simli. |
| `simli_url` | `str` | `'https://api.simli.ai'` | Simli API base URL. |
| `is_trinity_avatar` | `bool` | `False` | Set to `True` when the face belongs to a Trinity avatar, to keep lip-sync correct. |

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


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.