{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"actorName": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"gestures": [
{
"label": "<string>",
"slug": "<string>",
"startFrame": 123
}
],
"status": "NOT_TRAINED",
"width": 123,
"height": 123,
"thumbnailUrl": "<string>",
"coverImageUrl": "<string>",
"extras": {},
"orientation": "ASPECT_RATIO_16_9",
"model": "ARGIL_V1"
}{
"code": 123,
"message": "<string>"
}Create a new Avatar
Creates a new avatar.
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"actorName": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"gestures": [
{
"label": "<string>",
"slug": "<string>",
"startFrame": 123
}
],
"status": "NOT_TRAINED",
"width": 123,
"height": 123,
"thumbnailUrl": "<string>",
"coverImageUrl": "<string>",
"extras": {},
"orientation": "ASPECT_RATIO_16_9",
"model": "ARGIL_V1"
}{
"code": 123,
"message": "<string>"
}Overview
Create a new avatar from a video. This method requires both a dataset video and a consent video.Video Requirements
Dataset Video:- Duration: 1-5 minutes
- Format: MP4 or MOV
- Resolution: Between 720p and 4K
- Max size: 1.5GB
- Protocol: HTTPS only
- Duration: 30 seconds or less
- Format: MP4 or MOV
- Max size: 100MB
- Protocol: HTTPS only
Optional Fields
extras: Custom metadata dictionary (max 10 key-value pairs, 256 characters each)
Authorizations
API key to be included in the x-api-key header
Body
Avatar creation type - must be 'IMAGE' for image-based avatars
IMAGE Name of the avatar
1 - 256Image source for avatar creation. Either 'url' or 'base64' must be provided.
- Image URL
- Base64 Image
Show child attributes
Show child attributes
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" } }.
^https://.*Optional dictionary of custom key-value pairs to extend the avatar metadata. Maximum of 10 key-value pairs of 256 characters allowed
Show child attributes
Show child attributes
Response
Successfully created Avatar. The training process will start automatically.
A list of labelized gestures available for your avatar.
Show child attributes
Show child attributes
- 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
NOT_TRAINED, TRAINING, TRAINING_FAILED, IDLE, REFUSED 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.
Show child attributes
Show child attributes
ASPECT_RATIO_16_9, ASPECT_RATIO_9_16 ARGIL_V1, ARGIL_ATOM Was this page helpful?