Turn a sentence into a filter

Settings module

POST/aurora/filteraurora.filter

Builds a filter on one collection from a sentence, shows it as an ADR 0003 query string and proposes a saved view (`savedViews.create`) for confirmation. Requires `Idempotency-Key`; a replay returns the original response. A rule that refuses the request returns 422 with `refusal` and `reason`.

Requires the capability home.dashboard.read.
OAuth scopes: home.
Send an Idempotency-Key header. A replay with the same key returns the original response.
Error statuses: 400, 401, 409, 422, 429. Errors are RFC 9457 problem details.

Request body: AuroraFilterRequest

aurora.filter: AuroraFilterRequest
Field	Type	Required	Description
sentence	string	Yes	The sentence to turn into a filter.Constraints: length 1 to 500
collections	array of string	Yes	Collections the filter may target.
time_zone	string	Yes	Time zone the caller works in. Relative dates such as this month or overdue resolve on the org's calendar (its locale.time_zone setting), never on UTC.Constraints: pattern ^[A-Za-z_]+(\/[A-Za-z0-9_+-]+)*$
fields	array of object	No	A page's own filters, offered instead of the API fields of the first collection: names, types, values and operators only, never record data. Restricted columns are never offered.

{
  "sentence": "blocked permits for Miami shows this month",
  "collections": [
    "permits"
  ],
  "time_zone": "America/New_York",
  "fields": [
    {
      "name": "overdue",
      "type": "boolean",
      "ops": [
        "eq"
      ]
    }
  ]
}

Response 200: AuroraResult

aurora.filter: AuroraResult
Field	Type	Required	Description
outcome	"answer" \| "no_answer" \| "failed"	Yes	answer, no_answer (the data does not support an answer; `missing` says why) or failed (the model call failed and was logged).
ai_generated	true	Yes	Always true: the content is AI-generated and is labeled so (EU AI Act Article 50).
request_id	string (uuid) \| null	Yes	Identifier of the logged AI request; null when no model was called.
model	string \| null	Yes	Model that answered.Constraints: length 1 to 100
missing	string \| null	Yes	What the data lacks, for no_answer.Constraints: length 1 to 500
failure_code	string \| null	Yes	Why the request failed.Constraints: length 1 to 64
answer	object	No	The feature's answer for outcome answer, shaped per operation; null otherwise.
suggestions	array of AuroraProposal	Yes	Changes stored for confirmation.

{
  "outcome": "answer",
  "ai_generated": true,
  "request_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "model": "claude-sonnet-5-5",
  "missing": "No budget lines exist yet.",
  "failure_code": "model_error",
  "answer": {
    "text": "One permit is blocked: Fire Marshal Permit.",
    "citations": []
  },
  "suggestions": [
    {
      "suggestion_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
      "operation_id": "savedViews.create",
      "summary": "Save the view Blocked Miami Permits."
    }
  ]
}

Code samples

curl -X POST "$XOS_BASE_URL/aurora/filter" \
  -H "Authorization: Bearer $XOS_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"sentence":"blocked permits for Miami shows this month","collections":["permits"],"time_zone":"America/New_York","fields":[{"name":"overdue","type":"boolean","ops":["eq"]}]}'

const { data } = await xos.aurora.filter({
    "sentence": "blocked permits for Miami shows this month",
    "collections": [
      "permits"
    ],
    "time_zone": "America/New_York",
    "fields": [
      {
        "name": "overdue",
        "type": "boolean",
        "ops": [
          "eq"
        ]
      }
    ]
  });

response = xos.aurora.filter({"sentence": "blocked permits for Miami shows this month", "collections": ["permits"], "time_zone": "America/New_York", "fields": [{"name": "overdue", "type": "boolean", "ops": ["eq"]}]})

xos aurora filter --data '{"sentence":"blocked permits for Miami shows this month","collections":["permits"],"time_zone":"America/New_York","fields":[{"name":"overdue","type":"boolean","ops":["eq"]}]}'