curl --request POST \
--url https://api.bey.dev/v1/livekit-rooms \
--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/livekit-rooms"
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/livekit-rooms', 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": {}
}Create LiveKit Room
Create a LiveKit room for one of your agents and return the credentials a LiveKit client needs to join it.
Use this only when you are embedding a conversation in your own application via the LiveKit client SDK. Most integrations do not need it: Interacting with Managed Agents through the UI starts a conversation with no API call required.
The room is created together with its conversation, whose status and
transcript you can then read from /v1/conversations/{id}.
curl --request POST \
--url https://api.bey.dev/v1/livekit-rooms \
--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/livekit-rooms"
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/livekit-rooms', 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
Response
Created LiveKit room with its conversation ID and connection details.
Response model for a conversation including LiveKit connection details.
Unique identifier of the object in the database.
"01234567-89ab-cdef-0123-456789abcdef"
ID of agent managing the conversation.
Status for conversation that has not yet started.
- ToStartConversationStatus
- OngoingConversationStatus
- CompletedConversationStatus
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 conversation.
Show child attributes
Show child attributes
Was this page helpful?