Skip to main content
GET
List the avatar catalog

Authorizations

Authorization
string
header
required

API key from waterr.ai/settings?tab=api-keys. Send as Authorization: Bearer wai_<your_key>.

Query Parameters

category
string

Filter by category, e.g. professional, recruiter, sales, coach, executive, casual, illustrated.

gender
enum<string>
Available options:
male,
female,
neutral
source
enum<string>
Available options:
curated,
generated,
uploaded
orientation
enum<string>

Filter by shape. portrait is the side-by-side tile; landscape fills the meeting stage with the participant in a picture-in-picture tile. Omit to get both.

Available options:
portrait,
landscape
identity_key
string

Every shape and room of the same face, e.g. F-3.

Response

A list of avatars

status
string
Example:

"success"

data
object[]