BOboson
Avatar Realtime

Release a session

Changed on

End the session and remove the avatar participant from the room. The returned status is terminated once the end is confirmed, or releasing if the confirmation is still pending; poll GET /v1/avatar/sessions/{session_id} until it is terminated if you need that certainty. Releasing an already-ended session is harmless and returns terminated. Ended sessions stay retrievable until a few minutes after expires_at, then 404.

delete/v1/avatar/sessions/{session_id}

Request

  • Base URL
    https://api.boson.ai
  • URL
    https://api.boson.ai/v1/avatar/sessions/{session_id}
  • Auth
    HTTP bearer

Path parameters

session_idstring required

The session ID returned by POST /v1/avatar/sessions.

Response

The session object, status terminated or releasing.

idstring

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

object'avatar.realtime.session'
status'active' | 'releasing' | 'terminated'

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).

modelstring
avatar_idstring
avatar_identitystring

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

created_atstring date-time

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

expires_atstring date-time

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

ended_atstring date-time nullable

When the session ended; null while it is active.

Example response

{
  "id": "avrt_3f9c2a7e8b1d4c6f",
  "model": "higgs-avatar",
  "avatar_id": "builtin_claire_v1",
  "avatar_identity": "boson-avatar-agent"
}

Changes