Read what Aurora can do now

Settings module

GET/aurora/statusaurora.status

Features the caller may use (turned on by an Admin and included in the plan) and this month's use of the org's allowance. A rule that refuses the request returns 422 with `refusal` and `reason`.

Requires the capability home.dashboard.read.
OAuth scopes: home.
Error statuses: 400, 401, 422, 429. Errors are RFC 9457 problem details.

Response 200: AuroraStatus

aurora.status: AuroraStatus
Field	Type	Required	Description
enabled_features	array of AiFeature	Yes	Features the caller may use now.
used	integer	Yes	Requests the org made this UTC month.Constraints: range 0 to any
allowance	integer \| null	Yes	Monthly allowance; null when the plan sets no limit.Constraints: range 0 to any
plan_includes_aurora	boolean	Yes	Whether the plan includes Aurora AI.

{
  "enabled_features": [
    "assistant",
    "extraction"
  ],
  "used": 12,
  "allowance": 500,
  "plan_includes_aurora": true
}

Code samples

curl -X GET "$XOS_BASE_URL/aurora/status" \
  -H "Authorization: Bearer $XOS_API_KEY"

const { data } = await xos.aurora.status();

response = xos.aurora.status()

xos aurora status