Sign in

v1

latestOpenAPI 3.0.1MIT2026-07-2638658.5 KB
Avatar

Get Instant Avatar List

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

get/v2/avatars/custom

Query parameters

pageinteger
Example:1

Page number for pagination

page_sizeinteger
Example:10

Number of items per page

namestring

Avatar name filter - search avatars by name

status'processing' | 'completed' | 'failed'

Status filter

Response

Success

codeinteger 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
msgstring required

Response message

Example response

{
  "msg": "Success",
  "data": {
    "avatars": [
      {
        "id": 123,
        "name": "My Instant Avatar",
        "video_url": "https://example.com/video.mp4",
        "cover_url": "https://example.com/cover.jpg",
        "api_only": true,
        "avatar_status": "completed",
        "avatar_url": "https://example.com/avatar.mp4"
      }
    ]
  }
}