v4

latestOpenAPI 3.1.02026-08-086635375.7 KB
Avatars

list avatars

Returns a list of all avatars

get/v1/avatars

Query parameters

pageinteger

Page number for pagination

perPageinteger

Number of avatars per page (max 100)

searchstring

Search term to filter avatars by display name or generated description

renderStyle'all' | 'realistic' | 'animated_3d' | 'illustrated' | 'unknown'

Filter avatars by render style. unknown includes avatars whose style has not been determined (all custom avatars, and any avatar whose metadata generation has not completed).

tagsstring[]

Comma-separated list of tags to filter by (e.g. tags=professional,studio). Matches avatars with ANY of the given tags. Tags are generated alongside description/displayTags and are lowercase.

onlyOneShotboolean

Only return one-shot avatars

Response

Successfully retrieved avatars