Assets

Assets are individual 3D components (heads, hair, clothing) that make up an avatar. Each asset has a unique asset_id.

Asset Entity Properties

PropertyTypeStatusDescription
gender"male" | "female"RequiredDetermines the base skeleton and model set.
faceShapeasset_idRequiredID of the base head mesh.
eyeShapeasset_idRequiredID of the eye socket and surrounding structure.
noseShapeasset_idRequiredID of the nose structure.
lipShapeasset_idRequiredID of the mouth and lip structure.
skinColorindexOptionalIndex mapped to the skin color palette (0-indexed).
hairStyleasset_idOptionalID of the hair 3D model.
hairColorindexOptionalIndex mapped to the hair color palette.
eyebrowStyleasset_idOptionalID of the eyebrow mesh.
eyebrowColorindexOptionalIndex mapped to the eyebrow color palette (usually matches hair).
beardStyleasset_idOptionalID of the facial hair model.
beardColorindexOptionalIndex mapped to the beard color palette.
eyeColorasset_idOptionalID of the iris/eye color asset.
shirtasset_idOptionalID of the upper-body clothing item. In assetData.json, refer to shirt_male or shirt_female.
outfitasset_idOptionalID of the full-body outfit (overrides shirt if present). In assetData.json, refer to outfitmale or outfitfemale.
glassesasset_idOptionalID of the eyewear accessory.
faceMaskasset_idOptionalID of the face mask or covering accessory.
faceWearasset_idOptionalID of face-specific accessories (piercings, etc.).
headWearasset_idOptionalID of head accessories (hats, helmets, etc.).
bottomasset_idOptionalID of the lower-body clothing item (pants, shorts, etc.).
footWearasset_idOptionalID of the footwear items (shoes, boots, etc.).
topasset_idOptionalID of the outer-layer or additional upper-body clothing item (jackets, etc.).

For a complete list of available assets and their IDs, refer to the assetData.json bundle provided with your integration package, or browse the Asset Library section.