Skip to main content
GET
/
avatars
List all avatars
curl --request GET \
  --url https://api.argil.ai/v1/avatars \
  --header 'x-api-key: <api-key>'
[
  {
    "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"
  }
]

Authorizations

​
x-api-key
string
header
required

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

Query Parameters

​
orientation
enum<string>

Filter avatars by orientation

Available options:
ASPECT_RATIO_16_9,
ASPECT_RATIO_9_16
​
model
enum<string>

Filter avatars by model type

Available options:
ARGIL_V1,
ARGIL_ATOM

Response

An array of avatars

​
id
string<uuid>
​
name
string
​
actorName
string
​
createdAt
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 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
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.

​
orientation
enum<string>
Available options:
ASPECT_RATIO_16_9,
ASPECT_RATIO_9_16
​
model
enum<string>
Available options:
ARGIL_V1,
ARGIL_ATOM