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.For API key requests, 403 can also indicate insufficient scope.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.{
"detail": {
"error": "live_quota_exceeded",
"message": "Monthly Live session quota exceeded"
}
}
API key scope errors#
Example insufficient scope payload:{
"detail": {
"error": "INSUFFICIENT_API_KEY_SCOPE",
"message": "API key lacks required scope for this endpoint",
"required_scope": "organizations:write",
"granted_scopes": ["organizations:read"]
}
}
Best practices#
validate request payloads before sending them
retry only on safe, transient failures
handle 401 by refreshing or re-authenticating
handle 403 by checking role/tenant and API key scopes
handle 429 with graceful backoff
always log response IDs and error payloads in client applications
Modified at 2026-04-22 17:38:03
