Skip to main content
POST
Create an avatar

Authorizations

Authorization
string
header
required

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

Body

application/json
url
string<uri>
required

Public https URL of the image (jpeg, png, or webp; max 10MB; min 128×128px). Fetched once at creation and re-hosted — the original is kept in tags.source_url for reference but never loaded again.

Example:

"https://your-cdn.com/avatars/alex.jpg"

category
string

Defaults to professional.

gender
enum<string>

Drives voice pairing when assigned to a persona.

Available options:
male,
female,
neutral
default_voice_id
string<uuid>

Voice to pair when assigning with sync_voice: true.

tags
object

Response

Avatar created — data.url is the re-hosted WaterrAI URL; width/height are measured from the actual image

status
string
Example:

"success"

data
object

A catalog avatar — the visual identity a persona presents in prejoin cards and meetings. Global curated avatars have owner_membership_id: null; avatars you generate or upload are owned by your account and visible only to you.