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

Organizations

Xentree supports multi-tenant organization management for collaborative workspaces.

What you can do#

create and manage organizations
assign roles to members
invite or remove users
structure collaboration across teams

Authentication and scopes#

Organizations endpoints support both bearer and API key auth.
Recommended API key scopes:
organizations:read for listing organizations and members
organizations:write for create/update/delete and membership changes

Main endpoints#

Organizations#

POST /api/organizations
GET /api/organizations
GET /api/organizations/{org_id}
PATCH /api/organizations/{org_id}
DELETE /api/organizations/{org_id}

Members#

GET /api/organizations/{org_id}/members
POST /api/organizations/{org_id}/members
PATCH /api/organizations/{org_id}/members/{target_user_id}
PUT /api/organizations/{org_id}/members/{target_user_id}
DELETE /api/organizations/{org_id}/members/{target_user_id}

Tenants (admin)#

GET /api/admin/tenants

Role model#

Representative roles include:
administrator
billing_manager
team_manager
member

Example create organization request#

{
  "name": "Acme Learning",
  "slug": "acme-learning",
  "description": "Workspace for team learning and collaboration"
}

Access model#

Most organization endpoints require an authenticated user, and privileged actions require the appropriate organization role.
When using API keys, role and tenancy checks still apply after scope checks.
Modified at 2026-04-29 23:54:39
Previous
Knowledge Base
Next
Profile & Analytics
Built with