List Avatars

Get public avatars and your own uploaded avatars in one request

GET /v1/avatars

List Avatars

cURL

curl --request GET \
  --url https://api.agenthuman.com/v1/avatars \
  --header 'x-api-key: <api-key>'

200 - Success

{
  "success": true,
  "public_avatars": [
    {
      "avatar_id": "PUBLIC/Avatars/sara-office",
      "tags": ["female", "professional"],
      "preview_url": "https://cdn.agenthuman.com/avatars/sara-office/preview",
      "image_url": "https://cdn.agenthuman.com/avatars/sara-office/image"
    }
  ],
  "my_avatars": [
    {
      "avatar_id": "avat_01J8ZK4R2N5M6P7Q8W4T",
      "tags": ["user_exclusive", "user_42"],
      "preview_url": "https://cdn.agenthuman.com/avatars/avat_01J8ZK4R2N5M6P7Q8W4T/preview",
      "image_url": "https://cdn.agenthuman.com/avatars/avat_01J8ZK4R2N5M6P7Q8W4T/image"
    }
  ]
}

Returns the full library of pre-built public avatars alongside any avatars you have uploaded yourself.

Use image_url from either list as the avatar_image_url when creating sessions or agents or pass the avatar_id to Preview Avatar.

Response

success · boolean

Whether the request was successful.

public_avatars · array

Array of Avatar objects available to all users.

my_avatars · array

Array of Avatar objects you have uploaded or generated.

200 - Success

{
  "success": true,
  "public_avatars": [
    {
      "avatar_id": "PUBLIC/Avatars/sara-office",
      "tags": ["female", "professional"],
      "preview_url": "https://cdn.agenthuman.com/avatars/sara-office/preview",
      "image_url": "https://cdn.agenthuman.com/avatars/sara-office/image"
    }
  ],
  "my_avatars": [
    {
      "avatar_id": "avat_01J8ZK4R2N5M6P7Q8W4T",
      "tags": ["user_exclusive", "user_42"],
      "preview_url": "https://cdn.agenthuman.com/avatars/avat_01J8ZK4R2N5M6P7Q8W4T/preview",
      "image_url": "https://cdn.agenthuman.com/avatars/avat_01J8ZK4R2N5M6P7Q8W4T/image"
    }
  ]
}