Skip to main content
List avatars

Authorizations

Authorization
string
header
required

Live API key minted in the dashboard. Pass as Authorization: Bearer sk_live_…. Keys are scoped to a single environment (staging / prod).

Query Parameters

limit
integer
default:20

Page size. Default 20, max 100.

Required range: 1 <= x <= 100
starting_after
string | null

Pagination cursor — an av_… id from a previous page.

scope
enum<string>
default:all

Which avatars to return: all (default — platform stock plus your org's), platform (only built-in stock), or org (only your custom).

Available options:
all,
platform,
org
q
string | null

Case-insensitive substring filter on avatar name or id.

Response

Successful Response

Cursor-paginated list of avatars.

data
Avatar · object[]
required
has_more
boolean
required
next_cursor
string | null

Pass as starting_after on the next request to continue.

object
string
default:list
Allowed value: "list"