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

# List avatars

> Returns the avatars you can use in a video.

Pass an avatar's `model_config_id` as `configId` to [Create a video](https://docs.olimi.ai/api-reference/endpoint/speech/create-stv.md). If you have no preference, use `default_config_id`.

* **Up to 100 avatars are returned.** `total` counts all available avatars, so it can be larger than the list.
* **`default_config_id` may not be in the list,** but it works as a `configId`.

> [!NOTE]
>
> The avatars are nested one level deeper than usual: they're at `data.data`, alongside `data.total` and `data.default_config_id`.

Each avatar also carries internal fields. Rely only on `model_config_id` and `title`.


## OpenAPI

````yaml get /api/v2/stv/avatars
openapi: 3.0.1
info:
  title: Customer Management API
  description: API for managing customer lists and customers within those lists
  license:
    name: MIT
  version: 1.0.0
servers:
  - url: https://api-eg.olimi.ai
security:
  - bearerAuth: []
paths:
  /api/v2/stv/avatars:
    get:
      tags:
        - Speech to Video
      summary: List avatars
      description: Returns the avatars you can use in a video.
      responses:
        '200':
          description: The avatars, at `data.data`.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StvAvatarsResponse'
        '400':
          description: The avatar list couldn't be loaded. Try again later.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NestBadRequest'
        '401':
          description: The `X-API-KEY` header is missing or the key isn't valid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
      security:
        - apiKeyAuth: []
components:
  schemas:
    StvAvatarsResponse:
      type: object
      properties:
        message:
          type: string
          example: Avatars retrieved successfully
        data:
          type: object
          description: The avatars are one level deeper, at `data.data`.
          properties:
            data:
              type: array
              items:
                $ref: '#/components/schemas/StvAvatar'
            total:
              type: integer
              description: >-
                How many avatars exist. The list returns at most 100, so this
                can be larger.
              example: 12
            default_config_id:
              type: string
              format: uuid
              description: >-
                The avatar to use if you don't have a preference. Works as a
                `configId` even when it isn't in the returned list.
              example: 4f0cda01-bd22-410c-8b2e-026ce07691da
    NestBadRequest:
      type: object
      properties:
        statusCode:
          type: integer
          example: 400
        message:
          type: string
          example: No audio files provided
        error:
          type: string
          example: Bad Request
    ApiError:
      type: object
      properties:
        statusCode:
          type: integer
          example: 404
        errorCode:
          type: string
          description: Machine-readable error code.
          example: agent_not_found
        message:
          type: string
          description: Human-readable text. May change; don't match on it.
          example: Agent not found
    StvAvatar:
      type: object
      properties:
        model_config_id:
          type: string
          format: uuid
          description: Send this as `configId` when creating a video.
          example: 4f0cda01-bd22-410c-8b2e-026ce07691da
        title:
          type: string
          description: The avatar's name.
          example: Hazem 2
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
    apiKeyAuth:
      type: apiKey
      in: header
      name: X-API-KEY

````

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