Retrieve Agent
curl --request GET \
--url https://api.bey.dev/v1/agents/{id} \
--header 'x-api-key: <api-key>'import requests
url = "https://api.bey.dev/v1/agents/{id}"
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/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"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>"
]
}Agents
Retrieve Agent
Retrieve a single agent by ID.
GET
/
v1
/
agents
/
{id}
Retrieve Agent
curl --request GET \
--url https://api.bey.dev/v1/agents/{id} \
--header 'x-api-key: <api-key>'import requests
url = "https://api.bey.dev/v1/agents/{id}"
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/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"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>"
]
}Response
Requested Agent
Response model for an agent.
Language to use.
Available options:
ar, ar-SA, bn, bg, zh, hr, cs, da, nl, en, en-AU, en-GB, en-US, fi, fr, fr-CA, fr-FR, ka, de, el, gu, he, hi, hu, id, it, ja, kn, kk, ko, ms, mr, no, pl, pt, pt-BR, pt-PT, pa, ro, ru, sk, es, sv, tl, ta, te, th, tr, uk, ur, vi Example:
"en"
Extra capabilities to manage calls.
Agent capability to see user camera feed.
- WebcamVisionAgentCapability
- WakeupModeAgentCapability
Show child attributes
Show child attributes
Example:
[
{ "type": "webcam_vision" },
{
"triggers": ["hey agent", "hi pal"],
"type": "wakeup_mode"
}
]
Was this page helpful?