Skip to main content
POST
Create LiveKit Audio-to-Video Session

Authorizations

x-api-key
string
header
required

Your Beyond Presence API Key.

Body

application/json

Request body to create a LiveKit speech-to-video session.

avatar_id
string
required

ID of avatar to use.

Example:

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

url
string
required

URL of LiveKit server the avatar worker should connect to.

Example:

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

token
string<password>
required
write-only

The token used to join your LiveKit room.

Example:

"<your-livekit-token>"

transport
string
default:livekit
Allowed value: "livekit"

Response

Created LiveKit Audio-to-Video Session with ID

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"