Skip to main content
POST

Overview

Makes one of your team’s own avatars (an Actor under My Actors in the dashboard) from a photo, the same way Upload a photo does. Send the photo as a public https URL (imageUrl) or as an image of your media library (mediaId). The photo is copied, tagged (age group, skin tone, setting, expression, and gender unless you set it), and the avatar is ready at once: the answer is 201 with status: "COMPLETED". Use its id as avatarId in the create endpoints.
JPEG, PNG or WEBP, up to 20 MB. The type is read from the file itself. Managed teams pay 200 credits, the dashboard’s custom actor price. BYOK teams pay no credits; the tagging runs on the team’s own OpenRouter key.
The avatar keeps its own copy of the photo, so deleting the avatar never touches your library image, and deleting the library image never breaks the avatar.

Errors

No photo? Generate Avatar makes one from a description.

Authorizations

x-api-key
string
header
required

Headers

Idempotency-Key
string

Makes the request safe to retry. 1-255 printable ASCII characters, one per operation (your job id, or a UUID you store), reused on every retry. Within 24 hours the same key with the same body answers with the first response and the header Idempotent-Replayed: true, without running or charging again. Keys are scoped to your team and the endpoint. 5xx answers and refusals before anything ran (401, 402, 403, 409, 429) are not kept. See Idempotency.

Required string length: 1 - 255
Pattern: ^[\x20-\x7E]+$

Body

application/json
name
string
required

The avatar's name (1-60 characters).

Maximum string length: 60
imageUrl
string<uri>

Public https URL of a JPEG, PNG or WEBP photo, up to 20 MB. Required unless mediaId is given; send one of the two.

mediaId
string

Id of a COMPLETED image of your media library. Required unless imageUrl is given.

gender
enum<string>

Leave it out to read it from the photo.

Available options:
Female,
Male

Response

Avatar created and ready

success
boolean
required
data
object
required

One of your team's own avatars (an Actor under My Actors in the dashboard).

message
string