v1

latestOpenAPI 3.1.02026-07-2665164286.3 KB

Avatars

Get Avatar Group

Returns details for a specific avatar group including name, gender, preview URLs, looks count, and training status.

get/v3/avatars/{group_id}

Path parameters

group_idstring required

Unique avatar group identifier

Response

Successful response

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"
    }
  }
}