1. Documentation
Xentree Docs
  • Documentation
    • Introduction
    • Quickstart
    • Authentication
    • Conversations
    • Knowledge Base
    • Xentree Live
    • Organizations and Teams
    • Xentree English
    • Errors and Limits
  • API Reference
    • Authentication
      • Register a new user
      • Log in and get an access token
      • Refresh an access token
      • Log out the current user
      • Get the current authenticated user
      • Update the current authenticated user
    • Conversations
      • List available AI providers
      • Generate an AI response
      • List conversations for the current user
      • Create a conversation
      • Get messages for a conversation
      • Search indexed user content
    • Knowledge Base
      • Search the knowledge base
    • Xentree Live
      • Get remaining Xentree Live quota
      • Start a live session
      • Update an active live session heartbeat
      • End a live session
      • Update the user nickname used in Xentree Live
      • List live transcripts for the current user
      • Save live session transcripts
      • Get a single live transcript
    • Organizations
      • List organizations for the current user
      • Create an organization
      • Get organization details
      • Update organization details
      • Delete an organization
      • List organization members
      • Add a member to an organization
    • Integrations
      • List active integrations for the current user
      • Start the Google Calendar OAuth flow
    • Xentree English
      • List XEL modules with user progress
      • Get XEL module details
      • Submit a learning task response
      • Run AI evaluation for speaking or writing
      • Get the XEL dashboard overview
  • Schemas
    • Error
    • TokenResponse
    • UserProfile
    • ChatRequest
    • ChatResponse
    • ConversationCreateRequest
    • ConversationResponse
    • KnowledgeSearchRequest
    • LiveStartSessionRequest
    • LiveSessionResponse
    • LiveQuotaResponse
    • TranscriptTurn
    • SaveLiveTranscriptsRequest
    • OrganizationCreateRequest
    • OrganizationResponse
    • MemberResponse
    • XELModuleSummary
    • XELTaskSubmissionRequest
  1. Documentation

Xentree Live

Xentree Live brings real-time voice and avatar interaction to the Xentree platform.
It is designed for immersive AI sessions with usage controls, transcript persistence, and personalization.

Core capabilities#

start and end voice or avatar sessions
monitor remaining monthly live quota
update a user nickname for more natural interactions
store full transcript history
connect to realtime audio and avatar infrastructure

REST endpoints#

Quota and profile#

GET /api/live/quota
PATCH /api/live/nickname

Session lifecycle#

POST /api/live/session/start
POST /api/live/session/heartbeat
POST /api/live/session/end

Transcript storage#

POST /api/live/transcripts
GET /api/live/transcripts
GET /api/live/transcripts/{transcript_id}

Realtime architecture#

For browser-based realtime interactions, Xentree Live uses a dedicated socket endpoint:
Socket endpoint: wss://orchstr.xentree.com
Representative event types include:
start-session
end-session
audio-input
audio-response
session-started
session-ended
avatar-expression

Example start request#

{
  "session_type": "voice"
}

Example transcript payload#

{
  "session_started_at": "2026-04-16T10:00:00Z",
  "session_ended_at": "2026-04-16T10:05:00Z",
  "transcripts": [
    {
      "role": "user",
      "text": "Hello Xentree",
      "timestamp": "2026-04-16T10:00:03Z"
    },
    {
      "role": "ai",
      "text": "Hi, how can I help you today?",
      "timestamp": "2026-04-16T10:00:05Z"
    }
  ]
}

Quota behavior#

Live usage is tracked in seconds and is evaluated against the user’s plan entitlements. If the quota is exceeded, the API can return a limit-related error and the client should gracefully end the session.
Modified at 2026-04-17 06:32:06
Previous
Knowledge Base
Next
Organizations and Teams
Built with