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

Errors and Limits

This page describes the most common API error patterns across Xentree.

Standard status codes#

200 OK#

The request completed successfully.

201 Created#

A new resource was created successfully.

204 No Content#

The request succeeded and there is no response body.

400 Bad Request#

The request body or parameters were invalid.

401 Unauthorized#

Authentication is missing or invalid.

403 Forbidden#

The user is authenticated but does not have permission.

404 Not Found#

The resource does not exist or is not visible to the requester.

429 Too Many Requests#

Returned when a limit, throttle, or quota condition is reached.

500 Internal Server Error#

An unexpected platform error occurred.

Xentree Live quota errors#

Live endpoints can return a quota-related error when a user exceeds the monthly allowance defined by the user’s plan.
Example:
{
  "detail": {
    "error": "live_quota_exceeded",
    "message": "Monthly Live session quota exceeded"
  }
}

Best practices#

validate request payloads before sending them
retry only on safe, transient failures
handle 401 by refreshing or re-authenticating
handle 429 with graceful backoff
always log response IDs and error payloads in client applications
Modified at 2026-04-17 06:32:30
Previous
Xentree English
Next
Register a new user
Built with