Create Call
curl --request POST \
--url https://api.bey.dev/v1/calls \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"agent_id": "<string>",
"user_name": "<string>",
"user_email": "<string>",
"tags": {}
}
'import requests
url = "https://api.bey.dev/v1/calls"
payload = {
"agent_id": "<string>",
"user_name": "<string>",
"user_email": "<string>",
"tags": {}
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({agent_id: '<string>', user_name: '<string>', user_email: '<string>', tags: {}})
};
fetch('https://api.bey.dev/v1/calls', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"id": "01234567-89ab-cdef-0123-456789abcdef",
"agent_id": "<string>",
"status": {
"type": "to_start"
},
"livekit_url": "<string>",
"livekit_token": "<string>",
"user_name": "<string>",
"user_email": "<string>",
"tags": {}
}Calls
Create Call
Start a new call with one of your agents.
Returns the created call together with the LiveKit connection details (room URL and access token) needed for a client to join.
POST
/
v1
/
calls
Create Call
curl --request POST \
--url https://api.bey.dev/v1/calls \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"agent_id": "<string>",
"user_name": "<string>",
"user_email": "<string>",
"tags": {}
}
'import requests
url = "https://api.bey.dev/v1/calls"
payload = {
"agent_id": "<string>",
"user_name": "<string>",
"user_email": "<string>",
"tags": {}
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({agent_id: '<string>', user_name: '<string>', user_email: '<string>', tags: {}})
};
fetch('https://api.bey.dev/v1/calls', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"id": "01234567-89ab-cdef-0123-456789abcdef",
"agent_id": "<string>",
"status": {
"type": "to_start"
},
"livekit_url": "<string>",
"livekit_token": "<string>",
"user_name": "<string>",
"user_email": "<string>",
"tags": {}
}Authorizations
Your Beyond Presence API Key.
Body
application/json
Response
Created Call with ID and LiveKit connection details.
Response model for a call including LiveKit connection details.
Unique identifier of the object in the database.
Example:
"01234567-89ab-cdef-0123-456789abcdef"
ID of agent managing the call.
Status for call that has not yet started.
- ToStartCallStatus
- OngoingCallStatus
- CompletedCallStatus
Show child attributes
Show child attributes
LiveKit server URL to connect to.
JWT for joining the LiveKit room.
Name of the user.
Email of the user.
Tags for the call
Show child attributes
Show child attributes
Was this page helpful?