GET
/
v1
/
avatars
curl --request GET \
  --url https://api.anam.ai/v1/avatars \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "<string>",
      "displayName": "<string>",
      "variantName": "<string>",
      "imageUrl": "<string>",
      "createdAt": "<string>",
      "updatedAt": "<string>"
    }
  ],
  "meta": {
    "total": 123,
    "lastPage": 123,
    "currentPage": 123,
    "perPage": 123,
    "prev": 123,
    "next": 123
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
page
integer
default:1

Page number for pagination

Required range: x >= 1
​
perPage
integer
default:10

Number of avatars per page (max 100)

Required range: 1 <= x <= 100
​
search
string

Search term to filter avatars by display name

Response

200
application/json

Successfully retrieved avatars

The response is of type object.