ARargildotai

Get an Avatar by id

Changed on

Returns a single Avatar identified by its id

get/avatars/{id}

Request

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

Path parameters

idstring required

The id of the Avatar to retrieve

Response

Detailed information about the Avatar

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

  • 8deefa349e1dRevision changes
    • warning

      removed the optional property from the response with the status

    • info

      added the optional property to the response with the status

  • 9346a335d8ceRevision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status