Skip to main content
GET
Retrieve a session

Authorizations

Authorization
string
header
required

Your Boson API key, sent as Authorization: Bearer $BOSON_API_KEY.

Path Parameters

session_id
string
required

The session ID returned by POST /v1/avatar/sessions, e.g. avrt_....

Response

The session object.

A realtime avatar session (the create / retrieve / release response).

id
string

Session ID, e.g. avrt_....

Example:

"avrt_3f9c2a7e8b1d4c6f"

object
enum<string>
default:avatar.realtime.session
Available options:
avatar.realtime.session
status
enum<string>

active: the avatar is in the room. releasing: a release was requested and is not confirmed yet. terminated: the session has ended (released, expired, room emptied, or ended by Boson for another reason).

Available options:
active,
releasing,
terminated
model
string
Example:

"higgs-avatar"

avatar_id
string
Example:

"builtin_claire_v1"

avatar_identity
string

The LiveKit identity the avatar joined as (transport.participant_identity).

Example:

"boson-avatar-agent"

created_at
string<date-time>

When the avatar joined the room (ISO 8601, UTC).

expires_at
string<date-time>

Latest end time: the session ends at this time if it is still running (created_at + max_duration_seconds).

ended_at
string<date-time> | null

When the session ended; null while it is active.