Skip to main content
GET
/
v1
/
agents
List Agents
curl --request GET \
  --url https://api.example.com/v1/agents \
  --header 'x-api-key: <api-key>'
{
  "data": [
    {
      "id": "<string>",
      "name": "<string>",
      "avatar_id": "<string>",
      "system_prompt": "<string>",
      "language": "en",
      "greeting": "Hello!",
      "max_session_length_minutes": 30,
      "capabilities": [
        {
          "type": "webcam_vision"
        }
      ],
      "llm": {
        "type": "openai"
      }
    }
  ],
  "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 Agents

data
AgentResponse · 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.