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

# Installation

> One npm package, four entry points.

```bash theme={null}
npm install @interviewflowai/talking-avatar
```

Add `three` for the Open Source 3D avatar:

```bash theme={null}
npm install @interviewflowai/talking-avatar three
```

The package is ESM-only, includes TypeScript types, and is [MIT licensed](https://github.com/interviewflowai/talking-avatar/blob/master/LICENSE). The current version is **0.2.0**.

## Entry points

| Import | Product | Runs on | Exports |
| - | - | - | - |
| `@interviewflowai/talking-avatar/server` | Realistic Avatars | Your server (Node.js) | [`LiveAvatar`](https://docs.talking-avatar.dev/sdk/live-avatar), `LiveAvatarError`, [`createAgentLink`, `listAgentLinks`, `deleteAgentLink`](https://docs.talking-avatar.dev/sdk/agent-links), `TalkingAvatarApiError` |
| `@interviewflowai/talking-avatar/live` | Realistic Avatars | Your page | [`LiveAvatarView`](https://docs.talking-avatar.dev/sdk/live-avatar-view) |
| `@interviewflowai/talking-avatar` | Open Source | Your page | [`TalkingAvatar`](https://docs.talking-avatar.dev/sdk/talking-avatar), `DEFAULT_MODEL_URL` |
| `@interviewflowai/talking-avatar/react` | Open Source | Your page (React) | [`TalkingAvatarView`](https://docs.talking-avatar.dev/sdk/react) |
| `@interviewflowai/talking-avatar/viseme-model.bin` | Open Source | | The 1 MB lip-sync model file, for [self-hosting](https://docs.talking-avatar.dev/open-source/self-hosting-the-model.md) |

## Requirements

| | Requirement |
| - | - |
| `LiveAvatar` | Node.js 22+, or Node.js 18/20 with the [`ws`](https://www.npmjs.com/package/ws) package passed as `WebSocket` |
| `createAgentLink` and friends | Node.js 18+ (uses `fetch`) |
| `LiveAvatarView` | A browser with WebRTC |
| `TalkingAvatar` | `three` 0.160 or later; a browser with WebGL 2 and Web Audio `AudioWorklet` |
| `TalkingAvatarView` | React 18 or later, plus `three` |

`three` and `react` are optional peer dependencies: install them only for the entry points that need them.

> [!WARNING]
>
> Never import `/server` in browser code. It's where your API key is used.

## Links

* npm: [@interviewflowai/talking-avatar](https://www.npmjs.com/package/@interviewflowai/talking-avatar)
* Source: [github.com/interviewflowai/talking-avatar](https://github.com/interviewflowai/talking-avatar)
* [Changelog](https://docs.talking-avatar.dev/sdk/changelog.md)


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