Sign in

v1

latestOpenAPI 3.0.1MIT2026-07-2638658.5 KB
Avatar

Get Public Avatar List

Retrieve list of public avatars with filtering options. Supports pagination and various filters including aspect ratio, style, gender, age, scene, and ethnicity.

get/v2/avatars/public

Query parameters

pageinteger
Example:1

Page number for pagination

page_sizeinteger
Example:10

Number of items per page

aspect_ratio'portrait' | 'landscape' | 'square'
Example:portrait

Filter by aspect ratio

style'professional' | 'social'

Filter by avatar style

gender'female' | 'male'

Filter by avatar gender

age'adult' | 'senior' | 'young_adult'

Filter by age group

scene'lifestyle' | 'outdoors' | 'business' | 'studio' | 'health_fitness' | 'education' | 'news'

Filter by scene type

ethnicity'european' | 'african' | 'south_asian' | 'east_asian' | 'middle_eastern' | 'south_american' | 'north_american'

Filter by ethnicity

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": "Professional Female",
        "video_url": "https://example.com/video.mp4",
        "cover_url": "https://example.com/cover.jpg",
        "aspect_ratio": 1,
        "style": "professional",
        "gender": "female",
        "age": "adult"
      }
    ]
  }
}