Sign in

Create a new Avatar

Creates a new Avatar by uploading source videos and launches training. The process is asynchronous - the avatar will initially be created with 'NOT_TRAINED' status and will transition to 'TRAINING' then 'IDLE' once ready.

post/avatars

Request body

namestring required

Name of the avatar

extrasobject

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

Example request

{
  "name": "My Avatar",
  "datasetVideo": {
    "url": "https://example.com/source-video.mp4"
  },
  "consentVideo": {
    "url": "https://example.com/consent-video.mp4"
  }
}

Response

Successfully created Avatar. The training process will start automatically.

idstring uuid
namestring
actorNamestring
createAtstring date-time
updatedAtstring date-time
status'NOT_TRAINED' | 'TRAINING' | 'TRAINING_FAILED' | 'IDLE' | 'REFUSED'
  • NOT_TRAINED - Initial state after creation
  • TRAINING - Avatar is currently training
  • 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