Update an AI settings
Settings module
PATCH/ai-settings/{id}aiSettings.update
AI feature switches. Every feature is off until an Admin turns it on. Updates the fields sent; omitted fields are unchanged. Requires `If-Match` with the current `ETag`: a stale tag returns 412 and a missing tag returns 428.
- Requires the capability org.ai.write.
- OAuth scopes: org.
- Send If-Match with the ETag you read. A stale tag returns 412; a missing tag returns 428.
- Error statuses: 400, 401, 404, 412, 422, 428, 429. Errors are RFC 9457 problem details.
Path and query parameters
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | Identifier of the ai settings. |
Request body: AiSettingsUpdate
| Field | Type | Required | Description |
|---|---|---|---|
| assistant_enabled | boolean | No | Assistant. |
| extraction_enabled | boolean | No | Document extraction. |
| drafting_enabled | boolean | No | Drafting. |
| plain_language_enabled | boolean | No | Ask in plain language. |
| summaries_enabled | boolean | No | Summaries. |
| mapping_enabled | boolean | No | Mapping help. |
{
"assistant_enabled": false,
"extraction_enabled": false,
"drafting_enabled": false,
"plain_language_enabled": false,
"summaries_enabled": false,
"mapping_enabled": false
}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 PATCH "$XOS_BASE_URL/ai-settings/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f" \
-H "Authorization: Bearer $XOS_API_KEY" \
-H 'If-Match: W/"etag-from-your-last-read"' \
-H "Content-Type: application/json" \
-d '{"assistant_enabled":false,"extraction_enabled":false,"drafting_enabled":false,"plain_language_enabled":false,"summaries_enabled":false,"mapping_enabled":false}'const { data, etag } = await xos.aiSettings.update("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {
"assistant_enabled": false,
"extraction_enabled": false,
"drafting_enabled": false,
"plain_language_enabled": false,
"summaries_enabled": false,
"mapping_enabled": false
}, { ifMatch: etag });response = xos.ai_settings.update("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {"assistant_enabled": False, "extraction_enabled": False, "drafting_enabled": False, "plain_language_enabled": False, "summaries_enabled": False, "mapping_enabled": False}, if_match=etag)xos ai-settings update 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f --data '{"assistant_enabled":false,"extraction_enabled":false,"drafting_enabled":false,"plain_language_enabled":false,"summaries_enabled":false,"mapping_enabled":false}' --if-match auto