Saltar al contenido

Read what Aurora can do now

Módulo Settings

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`.

  • Requiere la capacidad home.dashboard.read.
  • Alcances de OAuth: home.
  • Estados de error: 400, 401, 422, 429. Los errores son detalles de problema RFC 9457.

Respuesta 200: AuroraStatus

aurora.status: AuroraStatus
CampoTipoObligatorioDescripción
enabled_featuresarray of AiFeatureSíFeatures the caller may use now.
usedintegerSíRequests the org made this UTC month.Restricciones: range 0 to any
allowanceinteger | nullSíMonthly allowance; null when the plan sets no limit.Restricciones: range 0 to any
plan_includes_aurorabooleanSíWhether the plan includes Aurora AI.
{
  "enabled_features": [
    "assistant",
    "extraction"
  ],
  "used": 12,
  "allowance": 500,
  "plan_includes_aurora": true
}

Ejemplos de código

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