POST
/
avatars
Create a new Avatar
curl --request POST \
  --url https://api.argil.ai/v1/avatars \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "name": "My Avatar",
  "datasetVideo": {
    "url": "https://example.com/source-video.mp4"
  },
  "consentVideo": {
    "url": "https://example.com/consent-video.mp4"
  }
}'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "createAt": "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": {}
}

Authorizations

x-api-key
string
header
required

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
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

Successfully created Avatar. The training process will start automatically.

id
string<uuid>
name
string
createAt
string<date-time>
updatedAt
string<date-time>
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

The url of the thumbnail of the avatar (low resolution).

coverImageUrl
string

The url of the cover image of the avatar (high resolution).

extras
object

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