Create an avatar
POST /api/avatars - upload a source image (multipart, max 5 MB) or reference image_url to create a custom avatar.
201 with the avatar record. image_url identifies its source image. idle_video_status starts as PENDING while the idle clip renders. This endpoint is limited to 5 requests per minute per key.Authorizations
FaceMode API key (fm_...).
Body
Source image file (image/*, max 5 MB). A clear front-facing headshot works best.
Alternative to image: reference an already hosted image URL.
Display name.
Avatar source; custom uploads are stored as CUSTOM.
CUSTOM Optional JSON-encoded configuration object.
Whether the avatar can be used for sessions (default true).
true, false Response
Avatar created.
Avatar record with its source image and render readiness.
Owner account ID; null for platform defaults.
DEFAULT for platform avatars, CUSTOM for uploads.
DEFAULT, CUSTOM REALISM, SEMI_REALISM, THREE_D_CARTOON, ANIME_MANGA, FLAT_VECTOR Source image URL used for avatar rendering and downloads.
Increments each time the image is replaced.
Idle clip render state, for example PENDING, READY, or FAILED.
Avatar configuration metadata.
Only active avatars can start sessions.
Present on list/get responses: true when the avatar belongs to the caller.