Skip to content

List AI request rows

Settings module

GET/ai-requestsaiRequests.list

One Aurora model call: who asked, for which feature, with which configured model, and the prompt and output with personal data redacted. Restricted fields and medical records are never in it. Returns a cursor page of AI request rows the caller may see. The default order is `created_at` ascending. Supports sparse fieldsets and the filter grammar.

  • Requires the capability audit.log.read.
  • OAuth scopes: audit.
  • Cursor-paginated: limit, cursor, fields, sort and filter apply.
  • Error statuses: 400, 401, 429. Errors are RFC 9457 problem details.

Path and query parameters

aiRequests.list: Path and query parameters
FieldTypeRequiredDescription
limitLimitNoPage size. Default 50, maximum 200.Constraints: range 1 to 200
cursorCursorNoOpaque cursor from `next_cursor` of the previous page.Constraints: length 1 to any
fieldsFieldsNoSparse fieldset: a comma-separated list of top-level fields to return. `id` is always returned.Constraints: pattern ^[a-z_][a-z0-9_]*(,[a-z_][a-z0-9_]*)*$
sortSortNoSort keys, comma-separated; a leading `-` sorts descending. Without `sort`, the documented default order applies (coded lists sort in numeric code order).Constraints: pattern ^-?[a-z_][a-z0-9_]*(,-?[a-z_][a-z0-9_]*)*$
filterFilterNoFilter grammar `filter[field][op]=value`. Operators: eq, ne, lt, lte, gt, gte, in (comma-separated values), is_null (true or false) and contains. Conditions combine with AND.

Response 200: a page of AiRequest

aiRequests.list: AiRequest
FieldTypeRequiredDescription
idstring (uuid)YesIdentifier of the ai request.
org_idstring (uuid)YesIdentifier of the owning organization, derived from the parent row and never accepted from the caller.
created_atstring (date-time)YesWhen the row was created.
created_bystring (uuid) | nullYesIdentifier of the person who created the row.
updated_atstring (date-time)YesWhen the row was last updated.
updated_bystring (uuid) | nullYesIdentifier of the person who last updated the row.
person_idstring (uuid)YesIdentifier of the person who asked.
featureAiFeatureYesAn Aurora AI feature (Section 4.7).Constraints: one of "assistant", "plain_language", "extraction", "drafting", "summaries", "mapping"
modelstringYesModel identifier from configuration.Constraints: length 1 to 100
subject_tablestring | nullYesTable of the record the request was about.Constraints: length 1 to 100
subject_idstring (uuid) | nullYesIdentifier of the record the request was about.
outcomeAiRequestOutcomeYesHow a model call ended. No Answer is the silence rule (Section 3.7).Constraints: one of "Pending", "Answered", "No Answer", "Failed"
prompt_redactedstring | nullYesPrompt as sent, redacted.Constraints: length 1 to 20000
output_redactedstring | nullYesModel output, redacted.Constraints: length 1 to 20000
failure_codestring | nullYesWhy a Failed request failed.Constraints: length 1 to 64
completed_atstring (date-time) | nullYesWhen the request finished.
{
  "data": [
    {
      "id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
      "org_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
      "created_at": "2026-10-08T14:30:00Z",
      "created_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
      "updated_at": "2026-10-08T14:30:00Z",
      "updated_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
      "person_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
      "feature": "assistant",
      "model": "claude-sonnet-5-5",
      "subject_table": "app.documents",
      "subject_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
      "outcome": "Answered",
      "prompt_redacted": "Who is the vendor contact?",
      "output_redacted": "Ivy Chen, [phone].",
      "failure_code": "model_error",
      "completed_at": "2026-10-08T14:30:00Z"
    }
  ],
  "next_cursor": null
}

Code samples

curl -X GET "$XOS_BASE_URL/ai-requests" \
  -H "Authorization: Bearer $XOS_API_KEY"
for await (const row of xos.aiRequests.listAll()) {
  console.log(row);
}
for row in xos.ai_requests.list_all():
    print(row)
xos ai-requests list --all