---
title: "List avatars (catalogue + your own)"
method: GET
path: "/v1/avatars"
tags: ["Avatars"]
---

# List avatars (catalogue + your own)

`GET /v1/avatars`

## Request

- Base URL: `https://api.vivideo.ai`
- URL: `https://api.vivideo.ai/v1/avatars`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/vivideo/apis/vivideo-api/docs/v1/avatars/get.ts> (a function with typed inputs; its response is checked against the schema)

## Query parameters

- `view` 'characters' | 'catalogue'
- `search` string
- `gender` 'female' | 'male' | 'unspecified'
- `limit` integer

## Response `200`

Avatar characters or catalogue entries; `owned` lists your generated avatars.

- object
  - `object` string
  - `data` Avatar[]
    - `id` string: avatar_ref (av_...) for your avatars, or the catalogue avatar_id.
    - `object` string
    - `name` string
    - `kind` 'prompt' | 'photo'
    - `status` string
    - `ready` boolean
    - `gender` string
    - `preview_image_url` string
    - `preview_video_url` string
    - `looks` object[]
  - `owned` Avatar[]
    - `id` string: avatar_ref (av_...) for your avatars, or the catalogue avatar_id.
    - `object` string
    - `name` string
    - `kind` 'prompt' | 'photo'
    - `status` string
    - `ready` boolean
    - `gender` string
    - `preview_image_url` string
    - `preview_video_url` string
    - `looks` object[]

## Other responses

- `401`: Missing, malformed or revoked API key (`missing_api_key`, `invalid_api_key`, `api_key_revoked`).
- `429`: Rate limit hit (`rate_limited`). Honor the `Retry-After` header / `retry_after_seconds` field.

---

[API](https://skmtc.dev/vivideo/apis/vivideo-api.md) - [All operations](https://skmtc.dev/vivideo/apis/vivideo-api/llms.txt) - [OpenAPI document](https://skmtc.dev/vivideo/apis/vivideo-api/revisions/6e8a47e72b46?raw)