Skip to main content
GET
List avatars
Returns a JSON array (not wrapped) of avatar records. Platform DEFAULT avatars come first, then your CUSTOM avatars newest-first. Each record includes isOwned, idle_video_status, image_url, image_version, isActive, and config.
Pass an avatar’s id as avatarId when creating a session. Only isActive avatars can start sessions.

Authorizations

x-api-key
string
header
required

FaceMode API key (fm_...).

Response

Array of avatars.

id
string<uuid>
userId
string<uuid> | null

Owner account ID; null for platform defaults.

name
string
source
enum<string>

DEFAULT for platform avatars, CUSTOM for uploads.

Available options:
DEFAULT,
CUSTOM
style
enum<string> | null
Available options:
REALISM,
SEMI_REALISM,
THREE_D_CARTOON,
ANIME_MANGA,
FLAT_VECTOR
image_url
string | null

Source image URL used for avatar rendering and downloads.

image_version
integer

Increments each time the image is replaced.

idle_video_status
string

Idle clip render state, for example PENDING, READY, or FAILED.

config
object

Avatar configuration metadata.

isActive
boolean

Only active avatars can start sessions.

isOwned
boolean

Present on list/get responses: true when the avatar belongs to the caller.

createdAt
string<date-time>
updatedAt
string<date-time>