Quick Start

Get a talking AI avatar on your website in under 5 minutes.

Create your avatar

Sign up (opens in a new tab) for a free account
Click Create Avatar
Choose appearance, personality, voice, and brain
Click Create – your avatar is ready

Get your Short ID

Go to Dashboard → Avatars
Click on your avatar
Copy the Short ID (e.g., abc123)

Embed on your website

Drop in a script tag + div:

index.html

<script src="https://avatarium.ai/widget.js"></script>
<div id="avatarium-widget" data-avatar-id="YOUR_SHORT_ID" style="width: 400px; height: 600px;"></div>

That's it. Your avatar will appear and respond to voice conversations.

Talk to your avatar

Click the microphone button to start. The avatar will:

Listen to your speech (STT)
Think and respond (Brain)
Speak back with lip-synced animation (TTS)

Framework guides

npm install @avatarium/react

App.tsx

import { AvatariumEmbed } from '@avatarium/react';
 
function App() {
  return (
    <AvatariumEmbed
      shortId="YOUR_SHORT_ID"
      mode="voice"
      onReady={(data) => console.log('Ready:', data)}
      style={{ width: 400, height: 600 }}
    />
  );
}

Mobile & desktop apps

Load the avatar URL in any WebView:

https://avatarium.ai/a/YOUR_SHORT_ID/voice

Platform	Component
iOS	`WKWebView`
Android	`WebView` with JS enabled
Flutter	`webview_flutter`
React Native	`react-native-webview`
Electron/Tauri	Built-in WebView

Customization

All customization is done in the dashboard – no code changes:

Voice – Basic (Groq), Standard (Deepgram), or Premium (ElevenLabs)
Personality – System prompt, greeting, style
Appearance – 3D avatar model
Brain – AI provider and intelligence level

Changes apply instantly to all embedded instances.

Next steps

SDK Reference – Detailed integration docs
Embedding Guide – Advanced embed options
Pricing (opens in a new tab) – Plans and usage details

Introduction Installation