Skip to main content
GET
/
v1
/
agents
{
  "data": [
    {
      "id": "01234567-89ab-cdef-0123-456789abcdef",
      "name": "Jarvis",
      "avatar_id": "01234567-89ab-cdef-0123-456789abcdef",
      "system_prompt": "You are a helpful assistant.",
      "language": "en",
      "greeting": "Hello!",
      "max_session_length_minutes": 30,
      "capabilities": [
        {
          "type": "webcam_vision"
        },
        {
          "type": "wakeup_mode",
          "triggers": [
            "hey agent",
            "hi pal"
          ]
        }
      ],
      "llm": {
        "type": "openai"
      }
    }
  ],
  "has_more": true,
  "next_cursor": "<string>"
}

Authorizations

x-api-key
string
header
required

Your Beyond Presence API Key.

Query Parameters

limit
integer
default:100

Maximum number of objects to return.

Required range: 0 < x <= 1000
cursor
string | null

Cursor for pagination.

Response

Paginated List of Agents

  • HasMorePage[AgentResponse]
  • NoMorePage[AgentResponse]
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.