Skip to main content
GET
/
v1
/
sessions
/
{id}
Retrieve LiveKit Audio-to-Video Sessions
curl --request GET \
  --url https://api.bey.dev/v1/sessions/{id} \
  --header 'x-api-key: <api-key>'
{
  "id": "<string>",
  "avatar_id": "<string>",
  "status": {
    "type": "to_start"
  },
  "url": "<string>",
  "transport": "livekit"
}

Authorizations

​
x-api-key
string
header
required

Your Beyond Presence API Key.

Path Parameters

​
id
string
required

LiveKit speech-to-video session ID.

Response

Successful Response

Response body for a LiveKit speech-to-video session.

​
id
string
required

Unique identifier of the object in the database.

Example:

"01234567-89ab-cdef-0123-456789abcdef"

​
avatar_id
string
required

ID of avatar to use.

Example:

"01234567-89ab-cdef-0123-456789abcdef"

​
status
SessionStatusToStart · object
required

Session that has not yet started.

​
url
string
required

URL of LiveKit server the avatar worker should connect to.

Example:

"wss://<your-domain>.livekit.cloud"

​
transport
string
default:livekit
Allowed value: "livekit"