Get Avatar Group

cURL

curl --request GET \
  --url https://api.heygen.com/v3/avatars/{group_id} \
  --header 'x-api-key: <api-key>'

Response Codes

  • 200
  • 400
  • 401
  • 404
  • 429
{
  "data": {
    "id": "<string>",
    "name": "<string>",
    "created_at": 123,
    "looks_count": 123,
    "preview_image_url": "https://files.heygen.ai/avatar/anna_preview.jpg",
    "preview_video_url": "https://files.heygen.ai/avatar/anna_preview.mp4",
    "gender": "female",
    "default_voice_id": "1bd001e7e50f421d891986aad5c8bbd2",
    "consent_status": "approved",
    "status": "completed",
    "error": {
      "code": "<string>",
      "message": "<string>"
    }
  }
}

Authorizations

  • **ApiKeyAuthBearerAuth **

Header Parameter

  • x-api-key
    • Type: string
    • Required: Yes
    • Description: HeyGen API key. Obtain from your HeyGen dashboard.

Path Parameters

  • group_id
    • Type: string
    • Required: Yes
    • Description: Unique avatar group identifier.

Response

  • 200
    • Content Type: application/json
    • Description: Successful response.

Data Structure

  • data: AvatarGroupItem ยท object
    • Description: A single avatar group in the list response. Groups are containers for looks (outfits/styles). To determine avatar type and engine compatibility, fetch the looks via GET /v3/avatars/looks.