Get an AI request
Módulo Settings
GET/ai-requests/{id}aiRequests.get
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 one AI request with its `ETag`. A AI request the caller may not see returns 404.
- Requiere la capacidad audit.log.read.
- Alcances de OAuth: audit.
- Estados de error: 400, 401, 404, 429. Los errores son detalles de problema RFC 9457.
Parámetros de ruta y de consulta
| Campo | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| id | string (uuid) | Sí | Identifier of the ai request. |
| fields | Fields | No | Sparse fieldset: a comma-separated list of top-level fields to return. `id` is always returned.Restricciones: pattern ^[a-z_][a-z0-9_]*(,[a-z_][a-z0-9_]*)*$ |
Respuesta 200: AiRequest
| Campo | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| id | string (uuid) | Sí | Identifier of the ai request. |
| org_id | string (uuid) | Sí | Identifier of the owning organization, derived from the parent row and never accepted from the caller. |
| created_at | string (date-time) | Sí | When the row was created. |
| created_by | string (uuid) | null | Sí | Identifier of the person who created the row. |
| updated_at | string (date-time) | Sí | When the row was last updated. |
| updated_by | string (uuid) | null | Sí | Identifier of the person who last updated the row. |
| person_id | string (uuid) | Sí | Identifier of the person who asked. |
| feature | AiFeature | Sí | An Aurora AI feature (Section 4.7).Restricciones: one of "assistant", "plain_language", "extraction", "drafting", "summaries", "mapping" |
| model | string | Sí | Model identifier from configuration.Restricciones: length 1 to 100 |
| subject_table | string | null | Sí | Table of the record the request was about.Restricciones: length 1 to 100 |
| subject_id | string (uuid) | null | Sí | Identifier of the record the request was about. |
| outcome | AiRequestOutcome | Sí | How a model call ended. No Answer is the silence rule (Section 3.7).Restricciones: one of "Pending", "Answered", "No Answer", "Failed" |
| prompt_redacted | string | null | Sí | Prompt as sent, redacted.Restricciones: length 1 to 20000 |
| output_redacted | string | null | Sí | Model output, redacted.Restricciones: length 1 to 20000 |
| failure_code | string | null | Sí | Why a Failed request failed.Restricciones: length 1 to 64 |
| completed_at | string (date-time) | null | Sí | When the request finished. |
{
"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"
}Ejemplos de código
curl -X GET "$XOS_BASE_URL/ai-requests/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f" \
-H "Authorization: Bearer $XOS_API_KEY"const { data, etag } = await xos.aiRequests.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f");response = xos.ai_requests.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f")xos ai-requests get 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f