Installation - Talking Avatar

npm install @interviewflowai/talking-avatar

Add three for the Open Source 3D avatar:

npm install @interviewflowai/talking-avatar three

The package is ESM-only, includes TypeScript types, and is MIT licensed. 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`, `LiveAvatarError`, `createAgentLink`, `listAgentLinks`, `deleteAgentLink`, `TalkingAvatarApiError`
`@interviewflowai/talking-avatar/live`	Realistic Avatars	Your page	`LiveAvatarView`
`@interviewflowai/talking-avatar`	Open Source	Your page	`TalkingAvatar`, `DEFAULT_MODEL_URL`
`@interviewflowai/talking-avatar/react`	Open Source	Your page (React)	`TalkingAvatarView`
`@interviewflowai/talking-avatar/viseme-model.bin`	Open Source		The 1 MB lip-sync model file, for self-hosting

	Requirement
`LiveAvatar`	Node.js 22+, or Node.js 18/20 with the `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.

Never import /server in browser code. It’s where your API key is used.