TRANXACT.AI Help

Agentic AI · Limits & Oversight

Guardrails

The limits that are not the agent's own. Checked before every tool call and again against what it would move. A new deployment with agents and no limits is one bad prompt away from a thousand purchase orders.

Type REST6 operationsBase path /api/agentic/guardrailsPublished as /api/v1/guardrails

Download specification (OpenAPI 3.1) Screen: Guardrails

Overview

PackageAgentic AI
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 Agentic AI › Guardrails 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.
Tableagent.guardrails · kept per company (and organisational unit where it has one)
RecordCreated, changed and (where the screen allows) deleted; key id
RulesThe same as the screen: validation, numbering, approvals, posting, the company the caller belongs to, and the audit trail.

API reference

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

GET/api/agentic/guardrailsList guardrails

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": [
    {
      "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "code": "COD-000001",
      "name": "Example",
      "name_local": "Example",
      "description": "text",
      "scope_kind": "org",
      "agent_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "workflow_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "tool_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "connection_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "target_module": "text",
      "rule_kind": "text",
      "limit_amount": "1250.00"
    }
  ],
  "count": 1
}

Sample request

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

Path parameters

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

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "code": "COD-000001",
  "name": "Example",
  "name_local": "Example",
  "description": "text",
  "scope_kind": "org",
  "agent_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "workflow_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "tool_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "connection_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "target_module": "text",
  "rule_kind": "text",
  "limit_amount": "1250.00"
}

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

Sample request

curl "https://demo.tranxact.ai/api/agentic/guardrails/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/agentic/guardrailsCreate a guardrails

Request body

The record as JSON. Fields marked Yes are required.

FieldTypeRequiredDescription
codetextYesCode
nametextYesName
name_localtextNoLocal name
descriptiontextNoWhat it is for
scope_kindtextNoApplies to — What it covers: the whole company (org), one module, or one agent, workflow, tool or connection — named below.
Allowed: org module agent workflow tool connection
agent_iduuidNoAgent
workflow_iduuidNoWorkflow
tool_iduuidNoTool
connection_iduuidNoConnection
target_moduletextNoModule — For Applies to module: which one, e.g. scm.
rule_kindtextYesRule — What is checked: an amount, a count, an expression, or a list of allowed or refused values.
limit_amountnumericNoAmount limit — In the company currency: the most that may be moved or spent in each Per window.
limit_countintegerNoCount limit — The most calls or records in each Per window.
limit_windowtextNoPer — The window the limit is counted over.
Allowed: run hour day week month
currencytextNoCurrency
expressiontextNoFires when — For an expression rule: the condition that breaks it, e.g. amount > 50000 and supplier.is_new.
allowed_values_textNoOnly these — Comma separated.
denied_values_textNoNever these — Comma separated values that are always refused.
on_breachtextNoWhen broken — What happens: refuse the call, ask a person, stop the run, or only record it.
severitytextNoSeverity — How serious the incident raised on a breach is.
Allowed: low medium high critical
messagetextNoWhat to say — Read by the person who has to act on it, and by the model, which will try something else if it is told why.
is_activebooleanNoActive

Sample body

{
  "code": "COD-000001",
  "name": "Example",
  "rule_kind": "text",
  "name_local": "Example",
  "description": "text",
  "scope_kind": "org",
  "agent_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}

Response 201

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "code": "COD-000001",
  "name": "Example",
  "name_local": "Example",
  "description": "text",
  "scope_kind": "org",
  "agent_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "workflow_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "tool_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "connection_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "target_module": "text",
  "rule_kind": "text",
  "limit_amount": "1250.00"
}

Sample request

curl -X POST "https://demo.tranxact.ai/api/agentic/guardrails" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"code":"COD-000001","name":"Example","rule_kind":"text","name_local":"Example","description":"text","scope_kind":"org","agent_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"}'
PUT/api/agentic/guardrails/{id}Change a guardrails

Path parameters

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

Request body

Only the fields to change; fields left out keep their value.

FieldTypeRequiredDescription
codetextYesCode
nametextYesName
name_localtextNoLocal name
descriptiontextNoWhat it is for
scope_kindtextNoApplies to — What it covers: the whole company (org), one module, or one agent, workflow, tool or connection — named below.
Allowed: org module agent workflow tool connection
agent_iduuidNoAgent
workflow_iduuidNoWorkflow
tool_iduuidNoTool
connection_iduuidNoConnection
target_moduletextNoModule — For Applies to module: which one, e.g. scm.
rule_kindtextYesRule — What is checked: an amount, a count, an expression, or a list of allowed or refused values.
limit_amountnumericNoAmount limit — In the company currency: the most that may be moved or spent in each Per window.
limit_countintegerNoCount limit — The most calls or records in each Per window.
limit_windowtextNoPer — The window the limit is counted over.
Allowed: run hour day week month
currencytextNoCurrency
expressiontextNoFires when — For an expression rule: the condition that breaks it, e.g. amount > 50000 and supplier.is_new.
allowed_values_textNoOnly these — Comma separated.
denied_values_textNoNever these — Comma separated values that are always refused.
on_breachtextNoWhen broken — What happens: refuse the call, ask a person, stop the run, or only record it.
severitytextNoSeverity — How serious the incident raised on a breach is.
Allowed: low medium high critical
messagetextNoWhat to say — Read by the person who has to act on it, and by the model, which will try something else if it is told why.
is_activebooleanNoActive

Sample body

{
  "code": "COD-000001",
  "name": "Example"
}

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "code": "COD-000001",
  "name": "Example",
  "name_local": "Example",
  "description": "text",
  "scope_kind": "org",
  "agent_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "workflow_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "tool_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "connection_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "target_module": "text",
  "rule_kind": "text",
  "limit_amount": "1250.00"
}

Sample request

curl -X PUT "https://demo.tranxact.ai/api/agentic/guardrails/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"code":"COD-000001","name":"Example"}'
DELETE/api/agentic/guardrails/{id}Delete a guardrails

Path parameters

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

Response 200

{ "deleted": true }

Many documents are cancelled or reversed instead; the API refuses a delete the screen would refuse.

Sample request

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

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):

overrides, preview, withLines

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/agentic/guardrails/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/copy" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"overrides":"value","preview":"value","withLines":"value"}'

Data model

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

FieldTypeAccessDescription
iduuidread onlyId
org_iduuidread onlyOrg id
org_unit_iduuidread onlyOrg unit id
codetextread, writeCode
nametextread, writeName
name_localtextread, writeLocal name
descriptiontextread, writeWhat it is for
scope_kindtextread, writeApplies to — What it covers: the whole company (org), one module, or one agent, workflow, tool or connection — named below.
Allowed: org module agent workflow tool connection
agent_iduuidread, writeAgent
workflow_iduuidread, writeWorkflow
tool_iduuidread, writeTool
connection_iduuidread, writeConnection
target_moduletextread, writeModule — For Applies to module: which one, e.g. scm.
rule_kindtextread, writeRule — What is checked: an amount, a count, an expression, or a list of allowed or refused values.
limit_amountnumericread, writeAmount limit — In the company currency: the most that may be moved or spent in each Per window.
limit_countintegerread, writeCount limit — The most calls or records in each Per window.
limit_windowtextread, writePer — The window the limit is counted over.
Allowed: run hour day week month
currencytextread, writeCurrency
expressiontextread, writeFires when — For an expression rule: the condition that breaks it, e.g. amount > 50000 and supplier.is_new.
allowed_values_textread, writeOnly these — Comma separated.
denied_values_textread, writeNever these — Comma separated values that are always refused.
on_breachtextread, writeWhen broken — What happens: refuse the call, ask a person, stop the run, or only record it.
severitytextread, writeSeverity — How serious the incident raised on a breach is.
Allowed: low medium high critical
messagetextread, writeWhat to say — Read by the person who has to act on it, and by the model, which will try something else if it is told why.
breach_countbigintread onlyBreach count
last_breach_attimestamp with time zoneread onlyLast breach at
is_activebooleanread, writeActive
created_attimestamp with time zoneread onlyCreated at
created_byuuidread onlyCreated by
name_artextread onlyName ar
name_bntextread onlyName bn
name_detextread onlyName de
name_estextread onlyName es
name_frtextread onlyName fr
name_hitextread onlyName hi
name_ittextread onlyName it
name_jatextread onlyName ja
name_kntextread onlyName kn
name_kotextread onlyName ko
name_mrtextread onlyName mr
name_pttextread onlyName pt
name_rutextread onlyName ru
name_tatextread onlyName ta
name_urtextread onlyName ur
name_zhtextread onlyName zh
description_artextread onlyDescription ar
description_bntextread onlyDescription bn
description_detextread onlyDescription de
description_estextread onlyDescription es
description_frtextread onlyDescription fr
description_hitextread onlyDescription hi
description_ittextread onlyDescription it
description_jatextread onlyDescription ja
description_kntextread onlyDescription kn
description_kotextread onlyDescription ko
description_mrtextread onlyDescription mr
description_pttextread onlyDescription pt
description_rutextread onlyDescription ru
description_tatextread onlyDescription ta
description_urtextread onlyDescription ur
description_zhtextread onlyDescription zh
message_artextread onlyMessage ar
message_bntextread onlyMessage bn
message_detextread onlyMessage de
message_estextread onlyMessage es
message_frtextread onlyMessage fr
message_hitextread onlyMessage hi
message_ittextread onlyMessage it
message_jatextread onlyMessage ja
message_kntextread onlyMessage kn
message_kotextread onlyMessage ko
message_mrtextread onlyMessage mr
message_pttextread onlyMessage pt
message_rutextread onlyMessage ru
message_tatextread onlyMessage ta
message_urtextread onlyMessage ur
message_zhtextread onlyMessage zh
updated_attimestamp with time zoneread onlyUpdated at
updated_byuuidread onlyUpdated 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 Agentic AI › Guardrails 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.