Saltar al contenido

Save the AI feature switches

Módulo Settings

POST/ai-settings/saveaiSettings.save

Creates or updates the caller's org switches in one call (org.ai.write). Turning a feature on while the plan lacks aurora_ai is a 422 refusal, aurora_not_in_plan. Requires `Idempotency-Key`; a replay returns the original response. A rule that refuses the request returns 422 with `refusal` and `reason`.

  • Requiere la capacidad org.ai.write.
  • Alcances de OAuth: org.
  • Envía el encabezado Idempotency-Key. Una repetición con la misma clave devuelve la respuesta original.
  • Estados de error: 400, 401, 409, 422, 429. Los errores son detalles de problema RFC 9457.

Cuerpo de la solicitud: AiSettingsSaveRequest

aiSettings.save: AiSettingsSaveRequest
CampoTipoObligatorioDescripción
assistant_enabledbooleanSíassistant switch.
plain_language_enabledbooleanSíplain_language switch.
extraction_enabledbooleanSíextraction switch.
drafting_enabledbooleanSídrafting switch.
summaries_enabledbooleanSísummaries switch.
mapping_enabledbooleanSímapping switch.
{
  "assistant_enabled": false,
  "plain_language_enabled": false,
  "extraction_enabled": false,
  "drafting_enabled": false,
  "summaries_enabled": false,
  "mapping_enabled": false
}

Respuesta 200: AiSettings

aiSettings.save: AiSettings
CampoTipoObligatorioDescripción
idstring (uuid)SíIdentifier of the ai settings.
org_idstring (uuid)SíIdentifier of the owning organization, derived from the parent row and never accepted from the caller.
created_atstring (date-time)SíWhen the row was created.
created_bystring (uuid) | nullSíIdentifier of the person who created the row; null when a seed, platform or system process created it.
updated_atstring (date-time)SíWhen the row was last updated.
updated_bystring (uuid) | nullSíIdentifier of the person who last updated the row; null when a seed, platform or system process updated it.
assistant_enabledbooleanSíAssistant.
extraction_enabledbooleanSíDocument extraction.
drafting_enabledbooleanSíDrafting.
plain_language_enabledbooleanSíAsk in plain language.
summaries_enabledbooleanSíSummaries.
mapping_enabledbooleanSí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
}

Ejemplos de código

curl -X POST "$XOS_BASE_URL/ai-settings/save" \
  -H "Authorization: Bearer $XOS_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"assistant_enabled":false,"plain_language_enabled":false,"extraction_enabled":false,"drafting_enabled":false,"summaries_enabled":false,"mapping_enabled":false}'
const { data } = await xos.aiSettings.save({
    "assistant_enabled": false,
    "plain_language_enabled": false,
    "extraction_enabled": false,
    "drafting_enabled": false,
    "summaries_enabled": false,
    "mapping_enabled": false
  });
response = xos.ai_settings.save({"assistant_enabled": False, "plain_language_enabled": False, "extraction_enabled": False, "drafting_enabled": False, "summaries_enabled": False, "mapping_enabled": False})
xos ai-settings save --data '{"assistant_enabled":false,"plain_language_enabled":false,"extraction_enabled":false,"drafting_enabled":false,"summaries_enabled":false,"mapping_enabled":false}'