Sign in

List all avatars

Returns an array of Avatar objects available for the user

get/avatars

Query parameters

orientation'ASPECT_RATIO_16_9' | 'ASPECT_RATIO_9_16'

Filter avatars by orientation

model'ARGIL_V1' | 'ARGIL_ATOM'

Filter avatars by model type

Response

An array of avatars

idstring uuid
namestring
actorNamestring
createdAtstring date-time
updatedAtstring date-time
status'NOT_TRAINED' | 'TRAINING' | 'TRAINING_FAILED' | 'IDLE' | 'REFUSED'
  • NOT_TRAINED - Initial state after VIDEO mode avatar creation (before training starts)
  • TRAINING - Avatar is currently training. For IMAGE mode avatars, this is the initial status after creation.
  • TRAINING_FAILED - Training process failed
  • IDLE - Avatar is ready to use
  • REFUSED - Avatar was refused by moderation
widthinteger
heightinteger
thumbnailUrlstring

The url of the thumbnail of the avatar (low resolution).

coverImageUrlstring

The url of the cover image of the avatar (high resolution).

extrasobject

A dictionary of custom key-value pairs to extend the Avatar metadata. Maximum of 5 key-value pairs of 256 characters allowed.

orientation'ASPECT_RATIO_16_9' | 'ASPECT_RATIO_9_16'
model'ARGIL_V1' | 'ARGIL_ATOM'

Changes