v1

latestOpenAPI 3.1.02026-07-2665164286.3 KB

Avatars

List Avatar Groups

Returns a paginated list of avatar groups (characters). Each group contains one or more looks. Filterable by ownership.

get/v3/avatars

Query parameters

ownership'public' | 'private'

Filter by ownership: 'public' for preset avatars, or 'private' for your own. Omit for all.

limitinteger

Maximum number of items to return per page (1-50).

tokenstring

Opaque cursor token for the next page.

Response

Successful response

has_moreboolean

Whether more pages are available

next_tokenstring nullable

Opaque cursor for the next page

Example response

{
  "data": [
    {
      "id": "ag_abc123",
      "name": "Anna",
      "preview_image_url": "https://files.heygen.ai/avatar/anna_preview.jpg",
      "preview_video_url": "https://files.heygen.ai/avatar/anna_preview.mp4",
      "gender": "female",
      "created_at": 1711929600,
      "looks_count": 3,
      "default_voice_id": "1bd001e7e50f421d891986aad5c8bbd2",
      "consent_status": "approved",
      "error": {
        "code": "training_failed",
        "message": "Footage duration must be between 15s and 600s"
      }
    }
  ]
}