List Avatars

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

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://api.bey.dev/v1/avatars', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "data": [
    {
      "visibility": "public",
      "id": "01234567-89ab-cdef-0123-456789abcdef",
      "name": "John Doe",
      "status": "to-train"
    }
  ],
  "next_cursor": "<string>",
  "has_more": true
}

GET

avatars

List Avatars

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

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://api.bey.dev/v1/avatars', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "data": [
    {
      "visibility": "public",
      "id": "01234567-89ab-cdef-0123-456789abcdef",
      "name": "John Doe",
      "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

HasMorePage[AvatarResponse]
NoMorePage[AvatarResponse]

data

AvatarResponse · object[]

required

List of objects.

Show child attributes

next_cursor

string

required

The cursor for the next page of objects.

has_more

boolean

default:true

Whether there are more objects to fetch.

Agents

Authentication

Avatars

Calls

External APIs

Knowledge Files

Sessions

List Avatars

Authorizations

Query Parameters

Response