cURL
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 }
List agents.
Your Beyond Presence API Key.
Maximum number of objects to return.
x <= 50
Cursor for pagination.
Paginated List of Agents
List of objects.
Show child attributes
Unique identifier of the object in the database.
Display name to use. Also used when addressed in conversations.
1 - 100
ID of avatar to use.
System prompt to use.
1 - 10000
Language to use.
ar
bn
bg
zh
cs
da
nl
en
en-AU
en-GB
en-US
fi
fr
fr-CA
fr-FR
de
el
hi
hu
id
it
ja
kk
ko
ms
no
pl
pt
pt-BR
pt-PT
ro
ru
sk
es
sv
tr
uk
ur
vi
"en"
What to say when a call starts.
1 - 1000
"Hello!"
Maximum session length in minutes.
0 < x <= 90
30
Extra capabilities to manage calls.
Agent capability to see user camera feed.
"webcam_vision"
Configuration for LLM to use.
"openai"
{ "type": "openai" }
The cursor for the next page of objects.
Whether there are more objects to fetch.