Avatar API Overview
Complete guide to avatar components, profiles, and customization system
Avatar System API
Create and manage customizable user avatars with components, profiles, and skill sets
System Overview
The Avatar system enables rich user customization through components (accessories), profiles (component combinations), and avatar sets (grouped components). Each element can be styled, priced, and managed independently.
Core Concepts
Individual avatar accessories like hats or facial features. Each has a groupId (category) and compId (unique ID).
Complete avatar built from multiple components, including skills, facts, and personal details.
Collection of components grouped together with groupId and compId references.
Category identifier for components (e.g., "hats", "hairColor", "accessories").
Access Control
Core Types
AvatarComponent
type AvatarComponent {
groupId: String!
compId: Int!
tierLevel: Int
price: Float
limited: Int
purchased: Int
svg: String
width: Int
top: Int
left: Int
}groupId - Component categorycompId - Unique identifiertierLevel - Required tierprice - Token costlimited - Max availablepurchased - Already soldsvg - SVG contentwidth, top, left - PositioningAvatarProfile
type AvatarProfile {
id: Int!
regDate: Float
updateDate: Float
deleted: Int
fname: String!
surname: String
skillSet: [SkillSet]
avatarSet: [AvatarSet]
hairColor: String
factsSet: [AvatarFacts]
details: String
}SkillSet
type SkillSet {
id: Int
name: String!
rate: Int
}Represents skills associated with avatar profiles. rate indicates skill level (star rating).
AvatarSet
type AvatarSet {
id: Int!
regDate: Float
updateDate: Float
deleted: Int
groupId: String
compId: Int
}AvatarFacts
type AvatarFacts {
id: Int!
regDate: Float
updateDate: Float
deleted: Int
topic: String
detail: String
}Stores interesting facts and trivia associated with avatar profiles. Each fact has a topic and detailed detail content.
Input Types
input AvatarSetInput {
groupId: String
compId: Int
}Used when creating or updating avatar component sets
input FactsInput {
topic: String
detail: String
}Used when adding facts to avatar profiles
Key Features
Components can be restricted by user tier levels and pricing
Control scarcity with purchase limits and inventory tracking
Scalable vector graphics ensure crisp rendering at any size
Precise control over component placement and dimensions