API Reference

The Avatarium REST API allows you to create and manage avatar conversations programmatically.

Base URL

https://api.avatarium.ai/v1

Authentication

All requests require a Bearer token:

curl https://api.avatarium.ai/v1/avatars \
  -H "Authorization: Bearer av_live_xxxxx"

Request Format

• Content-Type: application/json
• All request bodies should be JSON
• All timestamps are ISO 8601 format

Response Format

Successful responses return JSON:

{
  "id": "conv_abc123",
  "created_at": "2025-01-15T10:00:00Z",
  ...
}

Error responses include code and message:

{
  "error": {
    "code": "invalid_request",
    "message": "avatar_id is required"
  }
}

Rate Limits

Rate limit headers are included in responses:

X-RateLimit-Limit: 60
X-RateLimit-Remaining: 58
X-RateLimit-Reset: 1705312800

Endpoints