Retrieve Speech-to-Video Session
curl --request GET \
--url https://api.bey.dev/v1/sessions/{id} \
--header 'x-api-key: <api-key>'import requests
url = "https://api.bey.dev/v1/sessions/{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/sessions/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"id": "01234567-89ab-cdef-0123-456789abcdef",
"avatar_id": "01234567-89ab-cdef-0123-456789abcdef",
"status": {
"type": "to_start"
},
"url": "wss://<your-domain>.livekit.cloud",
"transport": "livekit"
}Speech-to-Video Sessions
Retrieve Speech-to-Video Session
Retrieve a single speech-to-video session by ID.
GET
/
v1
/
sessions
/
{id}
Retrieve Speech-to-Video Session
curl --request GET \
--url https://api.bey.dev/v1/sessions/{id} \
--header 'x-api-key: <api-key>'import requests
url = "https://api.bey.dev/v1/sessions/{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/sessions/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"id": "01234567-89ab-cdef-0123-456789abcdef",
"avatar_id": "01234567-89ab-cdef-0123-456789abcdef",
"status": {
"type": "to_start"
},
"url": "wss://<your-domain>.livekit.cloud",
"transport": "livekit"
}Authorizations
Your Beyond Presence API Key.
Path Parameters
Speech-to-video session ID.
Response
Successful Response
- LivekitSessionResponse
- PipecatSessionResponse
Response body for a LiveKit speech-to-video session.
Unique identifier of the object in the database.
Example:
"01234567-89ab-cdef-0123-456789abcdef"
ID of avatar to use.
Example:
"01234567-89ab-cdef-0123-456789abcdef"
Session that has not yet started.
- SessionStatusToStart
- SessionStatusOngoing
- SessionStatusCompleted
Show child attributes
Show child attributes
URL of LiveKit server the avatar worker should connect to.
Example:
"wss://<your-domain>.livekit.cloud"
Allowed value:
"livekit"Was this page helpful?