Create a new Avatar
Creates a new avatar.
post/avatars
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.
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 - 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'