ARargildotai

Create a new Avatar

Changed on

Creates a new avatar.

post/avatars

Request

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

Request body

type'IMAGE' required

Avatar creation type - must be 'IMAGE' for image-based avatars

namestring required

Name of the avatar

voiceIdstring uuid

Optional voice ID to use for this avatar. If not provided, a voice design will be automatically created from the image.

callbackUrlstring uri

Optional HTTPS URL that receives a one-shot POST notification when avatar training completes or fails. On success, sends { "event": "AVATAR_TRAINING_SUCCESS", "data": { "avatarId", "avatarName", "voiceId", "message" } }. On failure (after all retries), sends { "event": "AVATAR_TRAINING_FAILED", "data": { "avatarId", "avatarName", "message" } }.

extrasobject

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

Response

Successfully created Avatar. The training process will start automatically.

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

  • 025ac5a8b5dfRevision changes
    • info

      added the new optional request property

  • 8deefa349e1dRevision changes
    • breaking

      added the new required request property

    • breaking

      added the new required request property

    • warning

      removed the request property

    • warning

      removed the request property

    • warning

      removed the optional property from the response with the status

    • info

      added the new optional request property

    • info

      added the optional property to the response with the status