> ## Documentation Index
> Fetch the complete documentation index at: https://docs.akool.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get Streaming Avatar List

> Retrieve a list of all streaming avatars



## OpenAPI

````yaml GET /api/open/v4/liveAvatar/avatar/list
openapi: 3.0.3
info:
  title: Live Avatar API
  description: API for managing streaming avatars and sessions
  version: 1.0.0
servers:
  - url: https://openapi.akool.com
    description: Production server
security:
  - ApiKeyAuth: []
  - BearerAuth: []
paths:
  /api/open/v4/liveAvatar/avatar/list:
    get:
      tags:
        - Avatar Management
      summary: Get Streaming Avatar List
      description: Retrieve a list of available streaming avatars
      parameters:
        - name: platform
          in: query
          schema:
            type: string
            default: open
            enum:
              - open
              - aigc
          description: Platform type - open for openapi, aigc for akool web app
        - name: page
          in: query
          schema:
            type: integer
            default: 1
            minimum: 1
          description: Page number for pagination
        - name: size
          in: query
          schema:
            type: integer
            default: 100
            maximum: 100
            minimum: 1
          description: Number of items per page (max 100)
      responses:
        '200':
          description: List of streaming avatars
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/ApiResponse'
                  - type: object
                    properties:
                      data:
                        $ref: '#/components/schemas/AvatarListResponse'
components:
  schemas:
    ApiResponse:
      type: object
      required:
        - code
        - msg
      properties:
        code:
          type: integer
          description: 'Interface returns business status code (1000: success)'
          example: 1000
        msg:
          type: string
          description: Interface returns status information
          example: OK
    AvatarListResponse:
      type: object
      properties:
        count:
          type: integer
          description: Total number of streaming avatars
        result:
          type: array
          items:
            $ref: '#/components/schemas/Avatar'
    Avatar:
      type: object
      properties:
        _id:
          type: string
          description: Internal ID
        uid:
          type: integer
          description: User ID
        type:
          type: integer
          description: Avatar type identifier (2 for streaming avatars)
        from:
          type: integer
          description: >-
            Source identifier for the avatar, 2 for official and 3 for user
            created
        avatar_id:
          type: string
          description: Unique identifier for the streaming avatar
        voice_id:
          type: string
          description: Associated voice model identifier
        name:
          type: string
          description: Display name of the avatar
        url:
          type: string
          description: URL to access the streaming avatar
        thumbnailUrl:
          type: string
          description: URL for the avatar's preview thumbnail
        gender:
          type: string
          description: Avatar's gender designation
        available:
          type: boolean
          description: Indicates if the avatar is currently available for use
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: >-
        Your API Key used for request authorization. If both Authorization and
        x-api-key have values, Authorization will be used first and x-api-key
        will be discarded.
    BearerAuth:
      type: http
      scheme: bearer
      description: >-
        Your API Key used for request authorization. Get Token from
        authentication/usage#get-the-token

````