TRANXACT.AI Help

Platform · AI Governance

AI Settings

AI features are allowed by default for this company; an administrator can turn any area off. Per area, whether AI and automated decision tools may act here: off (they do not run, and ASK and agents cannot read or change these records), suggest (they may propose, a person decides — every AI output about a person opens a review, and an agent's change waits for approval) or allowed (as the product behaves today). Enforced where each tool runs, not on a screen. Company data is not used to train AI models.

Type REST7 operationsBase path /api/platform/ai-settingsPublished as /api/v1/ai-settings

Download specification (OpenAPI 3.1) Screen: AI Settings

Overview

PackagePlatform
AuthenticationBearer token: a service account's token (POST /api/auth/service-token) or, for the published path, an API key
AuthorizationThe caller's roles must hold Platform › AI Settings on the Roles screen: display for GET, add for POST, change for PUT, delete for DELETE; an action needs the grant of the button that runs it on the screen.
Tablegov.ai_area_settings · kept per company (and organisational unit where it has one)
RecordRead only; key id
RulesThe same as the screen: validation, numbering, approvals, posting, the company the caller belongs to, and the audit trail.

API reference

7 operations. Open one for its parameters, bodies, responses and a sample request.

GET/api/platform/ai-settingsList ai settings

Query parameters

NameDescriptionExample
limitRows per page (50 by default, at most 200)limit=100
offsetRows to skipoffset=200
qFree-text search over the search columnsq=acme
sortcolumn:asc or column:desc, several separated by commassort=created_at:desc
filterA JSON condition or group (see the filter language), URL-encoded; any field below can be filtered and sortedfilter={"col":"status","op":"eq","value":"open"}
<field>=<value>Shorthand for "field is value" 

Response 200

{
  "rows": [
    {
      "area": "text",
      "mode": "text",
      "note": "text",
      "updated_by": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "updated_at": "2026-10-30T09:00:00Z",
      "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "created_at": "2026-10-30T09:00:00Z",
      "created_by": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "xf_text_1": "text",
      "xf_text_2": "text",
      "xf_text_3": "text",
      "xf_text_4": "text",
      "xf_text_5": "text",
      "xf_num_1": "1250.00"
    }
  ],
  "count": 1
}

Sample request

curl "https://demo.tranxact.ai/api/platform/ai-settings?limit=20" \
  -H "Authorization: Bearer $TOKEN"
GET/api/platform/ai-settings/{id}Read one ai settings

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Response 200

{
  "area": "text",
  "mode": "text",
  "note": "text",
  "updated_by": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "updated_at": "2026-10-30T09:00:00Z",
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "created_at": "2026-10-30T09:00:00Z",
  "created_by": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "xf_text_1": "text",
  "xf_text_2": "text",
  "xf_text_3": "text",
  "xf_text_4": "text",
  "xf_text_5": "text",
  "xf_num_1": "1250.00"
}

404 when no record with that id is visible to the caller.

Sample request

curl "https://demo.tranxact.ai/api/platform/ai-settings/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
GET/api/platform/ai-settings/commitmentCommitment

Response

200 with the data as JSON.

Sample request

curl "https://demo.tranxact.ai/api/platform/ai-settings/commitment" \
  -H "Authorization: Bearer $TOKEN"
POST/api/platform/ai-settingsPost ai settings

No body is required.

Response

200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.

Sample request

curl -X POST "https://demo.tranxact.ai/api/platform/ai-settings" \
  -H "Authorization: Bearer $TOKEN"
DELETE/api/platform/ai-settings/{id}Delete ai settings

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

No body is required.

Response

200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.

Sample request

curl -X DELETE "https://demo.tranxact.ai/api/platform/ai-settings/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/platform/ai-settings/{id}/setSet

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Request body

The keys this action reads (* = required; "one of" lists the only values):

mode, note; mode one of off|suggest|allowed

Response

200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.

Sample request

curl -X POST "https://demo.tranxact.ai/api/platform/ai-settings/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/set" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"mode":"value","note;":"value"}'
PUT/api/platform/ai-settings/{id}Put ai settings

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

No body is required.

Response

200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.

Sample request

curl -X PUT "https://demo.tranxact.ai/api/platform/ai-settings/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"

Data model

Every field of a ai settings, as the API returns it. Field names are the JSON keys; any of them can be filtered and sorted on a list.

FieldTypeAccessDescription
org_iduuidread onlyOrg id
areatextread onlyArea
modetextread onlyMode
notetextread onlyNote
updated_byuuidread onlyUpdated by
updated_attimestamp with time zoneread onlyUpdated at
iduuidread onlyId
created_attimestamp with time zoneread onlyCreated at
created_byuuidread onlyCreated by
xf_text_1textread onlyXf text 1
xf_text_2textread onlyXf text 2
xf_text_3textread onlyXf text 3
xf_text_4textread onlyXf text 4
xf_text_5textread onlyXf text 5
xf_num_1numericread onlyXf num 1
xf_num_2numericread onlyXf num 2
xf_num_3numericread onlyXf num 3
xf_date_1dateread onlyXf date 1
xf_date_2dateread onlyXf date 2

Errors

StatusMeaning
400The request could not be read: a filter that is not JSON, a bad parameter
401No credential, or it is wrong, revoked or expired
403The caller's roles do not hold Platform › AI Settings for this verb, or the address or origin is not allowed
404No record with that id is visible to the caller
409A conflict: a duplicate number, a document in a state that does not allow it, or a record changed or locked by someone else
422Refused by the same validation as the screen; the error names the field and why

Every error is JSON: {"error": "a sentence saying what was wrong"}, with field where it applies.