Xentree Docs
StatusMy Xentree
StatusMy Xentree
  1. Documentation
  • Documentation
    • Introduction
    • Quickstart
    • Authentication
    • Conversations
    • Knowledge Base
    • Organizations
    • Profile & Analytics
    • Xentree English
    • Xentree Live
    • Skills Connector
    • Integration Tokens
    • API Keys
    • 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
      • Delete a conversation
      • Get messages for a conversation
      • Start a conversation session
      • Update session activity
      • End a conversation session
      • Get current session status
      • Search indexed user content
      • Search infrastructure status
      • Rebuild search index
      • List notes
      • Create a note
      • Update a note
      • Delete a note
    • Knowledge Base
      • Search the knowledge base
      • List documents
      • Upload document
      • Query knowledge
    • 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
      • Update a member's role
      • Comprehensive member update (role, organization, team)
      • Remove a member from an organization
    • Profile & Analytics
      • Get my XP profile
      • Get a user's public profile
      • Get streak status
      • Get weekly XP activity
      • Get learning pulse (365-day heatmap)
      • Get daily quests
      • Get learning time analytics
    • Xentree English
      • Start an XEL module
      • Complete an XEL module
      • Regenerate a task variant
      • Get current XPI breakdown
      • Get XPI history
      • Start a learning session
      • End a learning session
      • Save a transcript entry
      • List XEL modules with user progress
      • Get transcripts for a session
      • Get XEL module details
      • Submit a learning task response
      • Run AI evaluation for speaking or writing
      • Get the XEL dashboard overview
    • 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
    • Skills Connector
      • List active integrations for the current user
      • Start the Google Calendar OAuth flow
    • Integration Tokens
      • Issue tenant-scoped RS256 integration grant token
      • Verify tenant integration token signature and claims
      • Revoke integration token by token or jti
      • Rotate integration grant and optionally revoke previous token
      • Get tenant active JWKS material for verification
      • Get tenant active integration key fingerprints
      • Admin observability for integration token revocations
    • API Keys
      • List API keys
      • Create an API key
      • Delete an API key
      • List tenants
    • Health
      • Health check
      • Detailed health check
  • Schemas
    • Error
    • TokenResponse
    • SimpleDetailResponse
    • UserProfile
    • SimpleMessageResponse
    • ChatRequest
    • LogoutResponse
    • ChatResponse
    • ConversationCreateRequest
    • ConversationResponse
    • KnowledgeSearchRequest
    • RagDocument
    • LiveStartSessionRequest
    • LiveSessionResponse
    • RagUploadResponse
    • CoreSearchConversationResult
    • LiveQuotaResponse
    • RagQueryRequest
    • CoreSearchMessageResult
    • RagQueryResponse
    • TranscriptTurn
    • CoreSearchResponse
    • SaveLiveTranscriptsRequest
    • TypesenseReindexRequest
    • IntegrationOut
    • OrganizationCreateRequest
    • OrganizationResponse
    • TypesenseStatusResponse
    • KnowledgeSearchResultItem
    • MemberResponse
    • NoteCreate
    • NoteUpdate
    • KnowledgeSearchResponse
    • XELModuleSummary
    • NoteResponse
    • XELTaskSubmissionRequest
    • CoreConversationSessionStartResponse
    • XPProfileResponse
    • CoreConversationSessionActivityResponse
    • PublicXPProfileResponse
    • CoreConversationSessionEndResponse
    • StreakStatusResponse
    • WeeklyActivityResponse
    • CoreConversationSessionStatusResponse
    • TenantResponse
    • LearningPulseDayEntry
    • LearningPulseResponse
    • QuestItem
    • QuestsResponse
    • LearningTimeAnalyticsResponse
    • APIKeyCreateRequest
    • APIKeyResponse
    • IntegrationGrantRequest
    • IntegrationGrantResponse
    • XELModuleDetail
    • IntegrationVerifyRequest
    • IntegrationVerifyResponse
    • XELTaskSubmissionResponse
    • XELEvaluationResponse
    • IntegrationRevokeRequest
    • XELDashboardResponse
    • IntegrationRevokeResponse
    • IntegrationRotateRequest
    • LiveSessionEndResponse
    • IntegrationRotateResponse
    • LiveSessionHeartbeatResponse
    • IntegrationJWKSResponse
    • LiveNicknameResponse
    • IntegrationFingerprintResponse
    • LiveTranscriptSaveResponse
    • LiveTranscriptListItem
    • IntegrationTokenRevocationItem
    • LiveTranscriptListResponse
    • LiveTranscriptDetailResponse
    • XELModuleStartResponse
    • XELModuleCompleteResponse
    • XELTaskRegenerateRequest
    • XELTaskRegenerateResponse
    • XELXpiResponse
    • XELXpiHistoryItem
    • XELSessionStartRequest
    • XELSessionStartResponse
    • XELSessionEndRequest
    • XELSessionEndResponse
    • XELTranscriptSaveRequest
    • XELTranscriptSaveResponse
    • XELTranscriptItem
  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

Authentication and scopes#

Most Live REST endpoints support both bearer and API key auth.
Recommended API key scopes:
live:read for quota and transcript reads
live:write for session start/end/heartbeat and nickname updates

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}
POST /api/live/transcripts is intended for bearer (and internal service-key flow). For general server-to-server access, prefer documented hybrid endpoints first.

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

Secure integration token lifecycle#

For enterprise embeds, use tenant-scoped integration grants via the Integration Tokens endpoints (for example POST /api/integration/grant).
Recommended flow:
1.
Call POST /api/integration/grant with short TTL (for example 90-120 seconds).
2.
Attach the returned token as integration_token in embed bootstrapping.
3.
Validate using POST /api/integration/verify in backend middleware/gateway.
4.
Use POST /api/integration/rotate to issue a new token and revoke old token in one call.
5.
Use POST /api/integration/revoke for immediate emergency invalidation.
Operational notes:
Revocation is persisted by jti in database for immediate invalidation.
Public verification material is available at GET /api/integration/jwks and GET /api/integration/fingerprint (query param: tenantId).
Endpoint-level rate limit headers are returned on grant/verify/rotate responses.

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-29 23:54:20
Previous
Xentree English
Next
Skills Connector
Built with