List Avatar Looks

cURL

curl --request GET \
  --url 'https://api.heygen.com/v3/avatars/looks?limit=20' \
  --header 'x-api-key: <api-key>'

Response Codes

  • 200
  • 400
  • 401
  • 429
{
  "data": [
    {
      "id": "<string>",
      "name": "<string>",
      "avatar_type": "studio_avatar",
      "group_id": "ag_abc123",
      "preview_image_url": "https://files.heygen.ai/look/business_preview.jpg",
      "preview_video_url": "https://files.heygen.ai/look/business_preview.mp4",
      "gender": "female",
      "tags": [
        "<string>"
      ],
      "default_voice_id": "1bd001e7e50f421d891986aad5c8bbd2",
      "supported_api_engines": [
        "<string>"
      ],
      "image_width": 1920,
      "image_height": 1080,
      "preferred_orientation": "portrait",
      "status": "completed",
      "error": {
        "code": "<string>",
        "message": "<string>"
      }
    }
  ],
  "has_more": true,
  "next_token": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://heygen-1fa696a7.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

  • ApiKeyAuthBearerAuth

Header: x-api-key
Type: string
Required: yes

HeyGen API key. Obtain from your HeyGen dashboard.

Query Parameters

  • group_id
    Type: string
    Filter looks to a specific avatar group. Returns only looks belonging to this group.

  • avatar_type
    Type: enum<string>
    Filter by avatar type: 'studio_avatar', 'digital_twin', or 'photo_avatar'.
    Available options:

    • studio_avatar
    • digital_twin
    • photo_avatar
  • ownership
    Type: enum<string>
    Filter by ownership: 'public' for preset avatars, or 'private' for your own. Omit for all.
    Available options:

    • public
    • private
  • limit
    Type: integer
    Default: 20
    Maximum number of items to return per page (1-50).
    Required range: 1 <= x <= 50

  • token
    Type: string
    Opaque cursor token for the next page.

Response

200

  • application/json
    Successful response

  • data
    Type: AvatarLookItem ยท object[]

  • has_more
    Type: boolean
    Whether more pages are available

  • next_token
    Type: string | null
    Opaque cursor for the next page.