Authentication

All API requests require authentication using an API key.

Getting an API Key

1. Sign up at dashboard.avatarium.ai (opens in a new tab)
2. Navigate to API Keys
3. Click Create API Key
4. Give your key a descriptive name (e.g., "Production", "Development")
5. Copy and securely store your key

API Key Format

API keys follow this format:

• Live keys: av_live_xxxxxxxxxxxxx (for production)
• Test keys: av_test_xxxxxxxxxxxxx (for development)

Using API Keys

In the SDK

import { Avatar } from '@avatarium/react';
 
<Avatar
  apiKey={process.env.NEXT_PUBLIC_AVATARIUM_KEY}
  avatarId="aria-001"
/>

In API Requests

curl -X POST https://api.avatarium.ai/v1/conversations \
  -H "Authorization: Bearer av_live_xxxxx" \
  -H "Content-Type: application/json" \
  -d '{"avatar_id": "aria-001"}'

Security Best Practices

Environment Variables

NEXT_PUBLIC_AVATARIUM_KEY=av_live_xxxxx

Key Rotation

Regularly rotate your API keys:

1. Create a new key in the dashboard
2. Update your application with the new key
3. Revoke the old key

Rate Limits