Avatars

Assistants can have avatars to personalize their appearance.

Endpoints

Manage assistant avatars with these REST endpoints.

Avatar type

ParameterTypeDescription
typeAvatarTypeAvatar type (ICON or IMAGE)
imageAvatar{ url: string } or nullImage avatar details when type is IMAGE
iconAvatar{ name: IconAvatarName } or nullIcon avatar details when type is ICON

Icon avatar names

The following IconAvatarName values are supported:
BACKPACK
ROCKET
MAGIC_WAND
CUBE
TARGET
DISC
GLOBE
STAR
LIGHTNING_BOLT
FACE
PERSON
HEART

Example avatars

Icon avatar

const avatar = { type: 'ICON', imageAvatar: null, iconAvatar: { name: 'LIGHTNING_BOLT' }, }

Image avatar

const avatar = { type: 'IMAGE', imageAvatar: { url: 'https://example.com/avatar.png' }, iconAvatar: null, }