Skip to main content
GET
/
v1
/
avatars
List Avatars
curl --request GET \
  --url https://api.example.com/v1/avatars \
  --header 'x-api-key: <api-key>'
{
  "data": [
    {
      "visibility": "public",
      "id": "<string>",
      "name": "<string>",
      "status": "to-train"
    }
  ],
  "next_cursor": "<string>",
  "has_more": true
}

Authorizations

​
x-api-key
string
header
required

Your Beyond Presence API Key.

Query Parameters

​
limit
integer
default:10

Maximum number of objects to return.

Required range: x <= 50
​
cursor
string | null

Cursor for pagination.

Response

Paginated List of Avatars

​
data
AvatarResponse · object[]
required

List of objects.

​
next_cursor
string
required

The cursor for the next page of objects.

​
has_more
boolean
default:true

Whether there are more objects to fetch.