Create a new Avatar
Creates a new avatar.
Request body
Avatar creation type - must be 'IMAGE' for image-based avatars
Name of the avatar
Optional voice ID to use for this avatar. If not provided, a voice design will be automatically created from the image.
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" } }.
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.
- 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
The url of the thumbnail of the avatar (low resolution).
The url of the cover image of the avatar (high resolution).
A dictionary of custom key-value pairs to extend the Avatar metadata. Maximum of 5 key-value pairs of 256 characters allowed.