---
title: "Get Instant Avatar List"
method: GET
path: "/v2/avatars/custom"
tags: ["Avatar"]
---

# Get Instant Avatar List

`GET /v2/avatars/custom`

Retrieve list of user's instant avatars.
Returns user's custom instant avatar collection with filtering options.

## Query parameters

- `page` integer
- `page_size` integer
- `name` string
- `status` 'processing' | 'completed' | 'failed'

## Response `200`

Success

- object
  - `code` integer, required — Business status code: * 0 - Success * 10104 - Record not found * 10105 - Invalid API key * 18020 - Insufficient credit * 18025 - No permission to call APIs * 40000 - Parameter error * 50000 - System error
  - `msg` string, required — Response message
  - `data` object
    - `avatars` object[] — List of instant avatars
      - `id` integer — Avatar ID
      - `name` string — Avatar name
      - `video_url` string, uri — Video URL
      - `cover_url` string, uri — Cover URL
      - `api_only` boolean — API only flag
      - `avatar_status` 'processing' | 'completed' | 'failed' — Avatar status
      - `fail_msg` string — Failure message (if failed)
      - `avatar_url` string, uri — Avatar URL

---

[API](https://skmtc.net/jogg/apis/joggai-openapi-v2.md) · [All operations](https://skmtc.net/jogg/apis/joggai-openapi-v2/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/jogg/joggai-openapi-v2/versions/ec8807ce9c12/schema)