ARargildotai

List all avatars

Changed on

Returns an array of Avatar objects available for the user

get/avatars

Request

  • Base URL
    https://api.argil.ai/v1
  • Auth
    API key in header x-api-key

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

visibility'public' | 'private'

Filter by visibility. 'public' returns only Argil's public avatars, 'private' returns only your workspace's custom avatars. Omit to return both.

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 - Legacy status from removed VIDEO mode creation. New avatars are not created from a video.
  • TRAINING - Avatar is being prepared from an image. This is the initial status after image 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

  • c4aa97f4077eRevision changes
    • info

      added the new optional query request parameter visibility

  • 8deefa349e1dRevision changes
    • warning

      removed the optional property / from the response with the status

    • info

      added the optional property / to the response with the status