List Agents
curl --request GET \
--url https://api.bey.dev/v1/agents \
--header 'x-api-key: <api-key>'import requests
url = "https://api.bey.dev/v1/agents"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://api.bey.dev/v1/agents', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"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"
},
{
"triggers": [
"hey agent",
"hi pal"
],
"type": "wakeup_mode"
}
],
"llm": {
"type": "openai"
},
"tts": {
"type": "elevenlabs",
"voice": "21m00Tcm4TlvDq8ikWAM"
},
"knowledge_file_ids": [
"<string>"
]
}
],
"next_cursor": "<string>",
"has_more": true
}Agents
List Agents
List your agents.
Returns a cursor-paginated list of the agents you own, most recent first.
GET
/
v1
/
agents
List Agents
curl --request GET \
--url https://api.bey.dev/v1/agents \
--header 'x-api-key: <api-key>'import requests
url = "https://api.bey.dev/v1/agents"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://api.bey.dev/v1/agents', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"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"
},
{
"triggers": [
"hey agent",
"hi pal"
],
"type": "wakeup_mode"
}
],
"llm": {
"type": "openai"
},
"tts": {
"type": "elevenlabs",
"voice": "21m00Tcm4TlvDq8ikWAM"
},
"knowledge_file_ids": [
"<string>"
]
}
],
"next_cursor": "<string>",
"has_more": true
}Authorizations
Your Beyond Presence API Key.
Query Parameters
Maximum number of objects to return.
Required range:
x <= 50Cursor for pagination.
Was this page helpful?