POST
/
v1
/
session
{
  "id": "01234567-89ab-cdef-0123-456789abcdef",
  "created_at": "2022-01-01T00:00:00Z",
  "avatar_id": "01234567-89ab-cdef-0123-456789abcdef",
  "livekit_url": "wss://<your-domain>.livekit.cloud",
  "livekit_token": "<your-livekit-token>"
}

Authorizations

​
x-api-key
string
header
required

Your Beyond Presence API Key.

Body

application/json

Represents a request to create a Beyond Presence Real-Time API session.

​
avatar_id
string
required

The ID of the avatar to use in the session.

Example:

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

​
livekit_url
string
required

The LiveKit URL you chose when creating your LiveKit project.

Example:

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

​
livekit_token
string
required

The LiveKit token used to join your LiveKit room.

Example:

"<your-livekit-token>"

Response

201
application/json
Successful Response

Represents a Beyond Presence Real-Time API session.

​
id
string
required

The unique identifier (ID) of the session.

Example:

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

​
created_at
string
required

The timestamp of when the session was created.

Example:

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

​
avatar_id
string
required

The ID of the avatar used in the session.

Example:

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

​
livekit_url
string
required

The LiveKit URL you chose when creating your LiveKit project.

Example:

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

​
livekit_token
string
required

The LiveKit token used to join your LiveKit room.

Example:

"<your-livekit-token>"