Skip to main content

Overview

An Avatar represents a pre-built or user-uploaded avatar image available for use in sessions and agents. Each avatar exposes both a square preview URL and a full-resolution image URL.

Fields

string
Unique identifier for the avatar (e.g. PUBLIC/Avatars/sara-office). Pass this as avatar_id to Preview Avatar or as avatar_image_url in sessions and agents.
array
Array of tags associated with the avatar.
string
Signed URL at 500×500 px, suitable for display in a picker UI.
string
Signed URL of the full-resolution avatar (capped at 1200 px wide). Use this as avatar_image_url in sessions or agents.

Example