> ## Documentation Index
> Fetch the complete documentation index at: https://heygen-1fa696a7.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# List Avatar Groups

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



## OpenAPI

````yaml /openapi/external-api.json get /v3/avatars
openapi: 3.1.0
info:
  title: HeyGen External API
  version: 1.0.0
  description: >-
    HeyGen's external API for programmatic AI video creation. See
    https://docs.heygen.com for full documentation.
  contact:
    name: HeyGen Product Infra
    url: https://heygen.com
servers:
  - url: https://api.heygen.com
    description: Production
security:
  - ApiKeyAuth: []
  - BearerAuth: []
tags:
  - name: Video
    description: >-
      Create videos from a prompt or an avatar, then list, fetch, deliver and
      delete them
  - name: Avatar
    description: >-
      Create avatars and looks, record consent, and generate with the Avatar 6
      model
  - name: Voice
    description: Text to speech, speech to speech, and voice cloning
  - name: Audio
    description: Music, sound effects, transcription, stem separation and audio analysis
  - name: Image
    description: Generate images
  - name: Video editing
    description: >-
      Translate, lipsync, clip, analyze and remove filler words or backgrounds
      from existing videos
  - name: Video Agent
    description: Create videos from a prompt with an agent that plans, writes and edits
  - name: Templates
    description: Generate videos from reusable templates by replacing their variables
  - name: HyperFrames
    description: Render HyperFrames compositions into video
  - name: Brand
    description: >-
      Brand kits (colors, fonts, logos) and brand glossaries (term translations
      and pronunciations)
  - name: Assets and folders
    description: Upload files and organize them in folders
  - name: Batches
    description: Submit and track videos, translations, lipsyncs and uploads in bulk
  - name: Webhooks
    description: Manage webhook endpoints and events
  - name: Feedback
    description: Tell HeyGen how a generated result turned out
  - name: Account and usage
    description: Your account, the current API key, request logs and usage
paths:
  /v3/avatars:
    get:
      tags:
        - Avatar
      summary: List Avatar Groups
      description: >-
        Returns a paginated list of avatar groups (characters). Each group
        contains one or more looks. Filterable by ownership.
      operationId: listAvatarGroups
      parameters:
        - name: ownership
          in: query
          required: false
          description: >-
            Filter by ownership: 'public' for preset avatars, or 'private' for
            your own. Omit for all.
          schema:
            type: string
            enum:
              - public
              - private
        - name: limit
          in: query
          required: false
          description: Maximum number of items to return per page (1-50).
          schema:
            type: integer
            minimum: 1
            maximum: 50
            default: 20
        - name: token
          in: query
          required: false
          description: Opaque cursor token for the next page.
          schema:
            type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/AvatarGroupItem'
                  has_more:
                    type: boolean
                    description: Whether more pages are available
                  next_token:
                    type:
                      - string
                      - 'null'
                    description: Opaque cursor for the next page
        '400':
          description: Invalid request parameters
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    $ref: '#/components/schemas/StandardAPIError'
              example:
                error:
                  code: invalid_parameter
                  message: '''limit'' must be between 1 and 50.'
                  param: limit
                  doc_url: null
        '401':
          description: Authentication failed
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    $ref: '#/components/schemas/StandardAPIError'
              example:
                error:
                  code: unauthorized
                  message: Invalid or expired API key. Verify your x-api-key header.
                  param: null
                  doc_url: null
        '429':
          description: Rate limit exceeded
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    $ref: '#/components/schemas/StandardAPIError'
              example:
                error:
                  code: rate_limit_exceeded
                  message: >-
                    Too many requests. Retry after the duration specified in the
                    Retry-After header.
                  param: null
                  doc_url: null
          headers:
            Retry-After:
              description: Seconds to wait before retrying
              schema:
                type: integer
      security:
        - ApiKeyAuth: []
        - BearerAuth: []
components:
  schemas:
    AvatarGroupItem:
      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.
      properties:
        id:
          description: Unique avatar group identifier.
          examples:
            - ag_abc123
          title: Id
          type: string
        name:
          description: Display name of the avatar.
          examples:
            - Anna
          title: Name
          type: string
        preview_image_url:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          description: URL to the avatar preview image.
          examples:
            - https://files.heygen.ai/avatar/anna_preview.jpg
          title: Preview Image Url
        preview_video_url:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          description: URL to the avatar preview video.
          examples:
            - https://files.heygen.ai/avatar/anna_preview.mp4
          title: Preview Video Url
        gender:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          description: Gender of the avatar.
          examples:
            - female
          title: Gender
        created_at:
          description: Unix timestamp (seconds) when the avatar was created.
          examples:
            - 1711929600
          title: Created At
          type: integer
        looks_count:
          description: Number of looks (outfits/styles) available for this avatar.
          examples:
            - 3
          title: Looks Count
          type: integer
        default_voice_id:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          description: Default voice ID for this avatar.
          examples:
            - 1bd001e7e50f421d891986aad5c8bbd2
          title: Default Voice Id
        consent_status:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          description: >-
            The consent status for the group. When null or omitted, no status is
            recorded; consent may still be required before video generation.
          examples:
            - accepted
          title: Consent Status
        status:
          anyOf:
            - $ref: '#/components/schemas/AvatarStatus'
            - type: 'null'
          default: null
          description: >-
            Training status of the avatar group. Only present for private
            avatars.
          examples:
            - completed
        error:
          anyOf:
            - $ref: '#/components/schemas/AvatarError'
            - type: 'null'
          default: null
          description: Error details. Only present when status is 'failed'.
      required:
        - id
        - name
        - created_at
        - looks_count
      title: AvatarGroupItem
      type: object
    StandardAPIError:
      type: object
      properties:
        code:
          type: string
          description: Machine-readable error code
          example: invalid_parameter
        message:
          type: string
          description: Human-readable error message
          example: Video not found
        param:
          type:
            - string
            - 'null'
          description: Which request field caused the error
        doc_url:
          type:
            - string
            - 'null'
          description: Link to error documentation
        errors:
          type: array
          description: >-
            Per-item error details for batch/multi-node failures (e.g. graph
            compilation errors by node).
          items:
            $ref: '#/components/schemas/StandardAPIErrorDetail'
        request_id:
          type: string
          description: >-
            Request identifier, also returned in the X-HeyGen-Request-Id
            response header. Include it when contacting support.
          example: 8c4f0b9e1d2a4f6b9e3c7a1d5f2b8e40
      required:
        - code
        - message
    AvatarStatus:
      description: Training/creation status of an avatar group or look.
      enum:
        - processing
        - pending_consent
        - failed
        - completed
      title: AvatarStatus
      type: string
    AvatarError:
      description: Error details for a failed avatar creation.
      properties:
        code:
          description: Machine-readable error code.
          examples:
            - training_failed
          title: Code
          type: string
        message:
          description: Human-readable error description.
          examples:
            - Footage duration must be between 15s and 600s
          title: Message
          type: string
      required:
        - code
        - message
      title: AvatarError
      type: object
    StandardAPIErrorDetail:
      type: object
      properties:
        code:
          type: string
          description: Machine-readable error code
          example: unknown_node_type
        message:
          type: string
          description: Human-readable error message
          example: Unknown node type
        node_id:
          type: string
          description: Graph node id this error pertains to, if applicable
        port:
          type: string
          description: Port name on the node this error pertains to, if applicable
        path:
          type: string
          description: Field path within the item this error pertains to, if applicable
      required:
        - code
        - message
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: HeyGen API key. Obtain from your HeyGen dashboard.
    BearerAuth:
      type: http
      scheme: bearer
      description: OAuth2 bearer token.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.