Get an AI settings
Settings module
GET/ai-settings/{id}aiSettings.get
AI feature switches. Every feature is off until an Admin turns it on. Returns one AI settings with its `ETag`. A AI settings the caller may not see returns 404.
- Requires the capability org.settings.read.
- OAuth scopes: org.
- Error statuses: 400, 401, 404, 429. Errors are RFC 9457 problem details.
Path and query parameters
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | Identifier of the ai settings. |
| fields | Fields | No | Sparse 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_]*)*$ |
Response 200: AiSettings
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | Identifier of the ai settings. |
| org_id | string (uuid) | Yes | Identifier of the owning organization, derived from the parent row and never accepted from the caller. |
| created_at | string (date-time) | Yes | When the row was created. |
| created_by | string (uuid) | null | Yes | Identifier of the person who created the row; null when a seed, platform or system process created it. |
| updated_at | string (date-time) | Yes | When the row was last updated. |
| updated_by | string (uuid) | null | Yes | Identifier of the person who last updated the row; null when a seed, platform or system process updated it. |
| assistant_enabled | boolean | Yes | Assistant. |
| extraction_enabled | boolean | Yes | Document extraction. |
| drafting_enabled | boolean | Yes | Drafting. |
| plain_language_enabled | boolean | Yes | Ask in plain language. |
| summaries_enabled | boolean | Yes | Summaries. |
| mapping_enabled | boolean | Yes | Mapping help. |
{
"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",
"assistant_enabled": false,
"extraction_enabled": false,
"drafting_enabled": false,
"plain_language_enabled": false,
"summaries_enabled": false,
"mapping_enabled": false
}Code samples
curl -X GET "$XOS_BASE_URL/ai-settings/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f" \
-H "Authorization: Bearer $XOS_API_KEY"const { data, etag } = await xos.aiSettings.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f");response = xos.ai_settings.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f")xos ai-settings get 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f