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

Introduction

Welcome to Xentree Docs.
Xentree is an AI learning and productivity platform built for intelligent conversations, knowledge retrieval, collaborative organization management, and immersive live interactions. In addition to the main product, Xentree Live enables real-time voice and avatar experiences, while Xentree English delivers structured AI-assisted English learning.

What you can build with Xentree#

With Xentree APIs, you can:
authenticate users and manage their profile
integrate server-to-server flows using scoped API keys
create and continue AI-powered conversations
search and retrieve knowledge across conversation context
manage organizations, memberships, and integrations
meter and store Xentree Live sessions and transcripts
support Xentree English learning flows and evaluation

Product areas#

Xentree Core#

The main platform for conversational AI, knowledge-aware chat, and user workflows.

Xentree Live#

A real-time voice and avatar experience for human-like interaction, including session quota tracking, transcripts, and nickname personalization.

Xentree English#

A structured English-learning module with modules, scoring, task submissions, evaluations, and dashboard analytics.

Environments#

Documentation#

Production docs: https://docs.xentree.com

Application#

Main app: https://my.xentree.com
Live app: https://live.xentree.com

Health checks#

GET /api/health
GET /api/health/detailed

How this documentation is organized#

Documentation explains concepts, onboarding, auth, and workflows.
API Reference lists endpoints, parameters, examples, and expected responses.

Authentication model#

Xentree exposes two authentication modes:
Bearer token for user-session requests
X-API-Key for server-to-server requests
Most API Reference areas now support both modes. API keys are scope-based, so each key should only be granted the minimum scopes required by your integration.
If you are new to the platform, start with Quickstart and Authentication.
For enterprise embed and server-to-server token exchange, see Authentication for the RS256 tenant-scoped integration token lifecycle (grant, verify, revoke, rotate) and rate-limit response headers.
Modified at 2026-04-29 23:54:59
Next
Quickstart
Built with