POST
/
avatars

Authorizations

​
x-api-key
string
headerrequired

API key to be included in the x-api-key header

Body

application/json
​
name
string
required

Name of the avatar

Required string length: 1 - 256
​
datasetVideo
object
required
​
consentVideo
object
required
​
extras
object

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

Response

201 - application/json
​
id
string
​
name
string
​
createAt
string
​
updatedAt
string
​
gestures
object[]

A list of labelized gestures available for your avatar.

​
status
enum<string>
  • 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
Available options:
NOT_TRAINED,
TRAINING,
TRAINING_FAILED,
IDLE,
REFUSED
​
width
integer
​
height
integer
​
thumbnailUrl
string
​
extras
object

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

Was this page helpful?

/avatars/voices