Sign in

v1

latestOpenAPI 3.1.0raw.githubusercontent.com2025-06-20101018.4 KB
session

Create and start a Real-Time API Session

With the Beyond Presence Real-Time API you are able to turn audio and text into hyper-realistic avatars in real-time.

Once a session is created, the selected avatar will automatically join the WebRTC room and will start streaming audio and video to the user.

post/v1/session

Request body

avatar_idstring required

The ID of the avatar to use in the session.

livekit_urlstring required

The LiveKit URL you chose when creating your LiveKit project.

livekit_tokenstring required

The LiveKit token used to join your LiveKit room.

Example request

{
  "avatar_id": "01234567-89ab-cdef-0123-456789abcdef",
  "livekit_url": "wss://<your-domain>.livekit.cloud",
  "livekit_token": "<your-livekit-token>"
}

Response

Successful Response

idstring required

The unique identifier (ID) of the session.

created_atstring date-time required

The timestamp of when the session was created.

avatar_idstring required

The ID of the avatar used in the session.

livekit_urlstring required

The LiveKit URL you chose when creating your LiveKit project.

livekit_tokenstring required

The LiveKit token used to join your LiveKit room.

Example response

{
  "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>"
}