Skip to main content
GET
Retrieve an avatar

Authorizations

Authorization
string
header
required

Your Boson API key, sent as Authorization: Bearer $BOSON_API_KEY.

Path Parameters

avatar_id
string
required

The avatar ID, e.g. avatar_9f3c... or builtin_claire_v1.

Response

The avatar.

avatar_id
string

Pass this as avatar_id when creating a session.

Example:

"builtin_claire_v1"

object
enum<string>
default:avatar
Available options:
avatar
name
string
Example:

"Claire"

width
integer

Reference image width in pixels.

height
integer

Reference image height in pixels.

is_public
boolean

true for a Boson preset, false for one of your account's avatars.

created_at
string<date-time> | null