Skip to main content
POST
/
v1
/
sessions
Create Speech-to-Video Session
curl --request POST \
  --url https://api.example.com/v1/sessions \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "avatar_id": "<string>",
  "url": "<string>",
  "token": "<string>",
  "transport": "livekit"
}
'
{
  "id": "<string>",
  "avatar_id": "<string>",
  "url": "<string>",
  "started_at": "<string>",
  "transport": "livekit"
}

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

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"

​
url
string
required

URL of LiveKit server the avatar worker should connect to.

Example:

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

​
started_at
string
required

Start time in ISO 8601 format.

Example:

"2022-01-01T00:00:00Z"

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