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.
/api/agentic/guardrailsPublished as /api/v1/guardrailsOverview
| Package | Agentic AI |
|---|---|
| Authentication | Bearer token: a service account's token (POST /api/auth/service-token) or, for the published path, an API key |
| Authorization | The 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. |
| Table | agent.guardrails · kept per company (and organisational unit where it has one) |
| Record | Created, changed and (where the screen allows) deleted; key id |
| Rules | The 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
| Name | Description | Example |
|---|---|---|
limit | Rows per page (50 by default, at most 200) | limit=100 |
offset | Rows to skip | offset=200 |
q | Free-text search over the search columns | q=acme |
sort | column:asc or column:desc, several separated by commas | sort=created_at:desc |
filter | A JSON condition or group (see the filter language), URL-encoded; any field below can be filtered and sorted | filter={"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
| Name | Type | Description |
|---|---|---|
id | string (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.
| Field | Type | Required | Description |
|---|---|---|---|
code | text | Yes | Code |
name | text | Yes | Name |
name_local | text | No | Local name |
description | text | No | What it is for |
scope_kind | text | No | Applies 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_id | uuid | No | Agent |
workflow_id | uuid | No | Workflow |
tool_id | uuid | No | Tool |
connection_id | uuid | No | Connection |
target_module | text | No | Module — For Applies to module: which one, e.g. scm. |
rule_kind | text | Yes | Rule — What is checked: an amount, a count, an expression, or a list of allowed or refused values. |
limit_amount | numeric | No | Amount limit — In the company currency: the most that may be moved or spent in each Per window. |
limit_count | integer | No | Count limit — The most calls or records in each Per window. |
limit_window | text | No | Per — The window the limit is counted over. Allowed: run hour day week month |
currency | text | No | Currency |
expression | text | No | Fires when — For an expression rule: the condition that breaks it, e.g. amount > 50000 and supplier.is_new. |
allowed_values | _text | No | Only these — Comma separated. |
denied_values | _text | No | Never these — Comma separated values that are always refused. |
on_breach | text | No | When broken — What happens: refuse the call, ask a person, stop the run, or only record it. |
severity | text | No | Severity — How serious the incident raised on a breach is. Allowed: low medium high critical |
message | text | No | What 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_active | boolean | No | Active |
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
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Request body
Only the fields to change; fields left out keep their value.
| Field | Type | Required | Description |
|---|---|---|---|
code | text | Yes | Code |
name | text | Yes | Name |
name_local | text | No | Local name |
description | text | No | What it is for |
scope_kind | text | No | Applies 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_id | uuid | No | Agent |
workflow_id | uuid | No | Workflow |
tool_id | uuid | No | Tool |
connection_id | uuid | No | Connection |
target_module | text | No | Module — For Applies to module: which one, e.g. scm. |
rule_kind | text | Yes | Rule — What is checked: an amount, a count, an expression, or a list of allowed or refused values. |
limit_amount | numeric | No | Amount limit — In the company currency: the most that may be moved or spent in each Per window. |
limit_count | integer | No | Count limit — The most calls or records in each Per window. |
limit_window | text | No | Per — The window the limit is counted over. Allowed: run hour day week month |
currency | text | No | Currency |
expression | text | No | Fires when — For an expression rule: the condition that breaks it, e.g. amount > 50000 and supplier.is_new. |
allowed_values | _text | No | Only these — Comma separated. |
denied_values | _text | No | Never these — Comma separated values that are always refused. |
on_breach | text | No | When broken — What happens: refuse the call, ask a person, stop the run, or only record it. |
severity | text | No | Severity — How serious the incident raised on a breach is. Allowed: low medium high critical |
message | text | No | What 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_active | boolean | No | Active |
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
| Name | Type | Description |
|---|---|---|
id | string (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
| Name | Type | Description |
|---|---|---|
id | string (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, withLinesResponse
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.
| Field | Type | Access | Description |
|---|---|---|---|
id | uuid | read only | Id |
org_id | uuid | read only | Org id |
org_unit_id | uuid | read only | Org unit id |
code | text | read, write | Code |
name | text | read, write | Name |
name_local | text | read, write | Local name |
description | text | read, write | What it is for |
scope_kind | text | read, write | Applies 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_id | uuid | read, write | Agent |
workflow_id | uuid | read, write | Workflow |
tool_id | uuid | read, write | Tool |
connection_id | uuid | read, write | Connection |
target_module | text | read, write | Module — For Applies to module: which one, e.g. scm. |
rule_kind | text | read, write | Rule — What is checked: an amount, a count, an expression, or a list of allowed or refused values. |
limit_amount | numeric | read, write | Amount limit — In the company currency: the most that may be moved or spent in each Per window. |
limit_count | integer | read, write | Count limit — The most calls or records in each Per window. |
limit_window | text | read, write | Per — The window the limit is counted over. Allowed: run hour day week month |
currency | text | read, write | Currency |
expression | text | read, write | Fires when — For an expression rule: the condition that breaks it, e.g. amount > 50000 and supplier.is_new. |
allowed_values | _text | read, write | Only these — Comma separated. |
denied_values | _text | read, write | Never these — Comma separated values that are always refused. |
on_breach | text | read, write | When broken — What happens: refuse the call, ask a person, stop the run, or only record it. |
severity | text | read, write | Severity — How serious the incident raised on a breach is. Allowed: low medium high critical |
message | text | read, write | What 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_count | bigint | read only | Breach count |
last_breach_at | timestamp with time zone | read only | Last breach at |
is_active | boolean | read, write | Active |
created_at | timestamp with time zone | read only | Created at |
created_by | uuid | read only | Created by |
name_ar | text | read only | Name ar |
name_bn | text | read only | Name bn |
name_de | text | read only | Name de |
name_es | text | read only | Name es |
name_fr | text | read only | Name fr |
name_hi | text | read only | Name hi |
name_it | text | read only | Name it |
name_ja | text | read only | Name ja |
name_kn | text | read only | Name kn |
name_ko | text | read only | Name ko |
name_mr | text | read only | Name mr |
name_pt | text | read only | Name pt |
name_ru | text | read only | Name ru |
name_ta | text | read only | Name ta |
name_ur | text | read only | Name ur |
name_zh | text | read only | Name zh |
description_ar | text | read only | Description ar |
description_bn | text | read only | Description bn |
description_de | text | read only | Description de |
description_es | text | read only | Description es |
description_fr | text | read only | Description fr |
description_hi | text | read only | Description hi |
description_it | text | read only | Description it |
description_ja | text | read only | Description ja |
description_kn | text | read only | Description kn |
description_ko | text | read only | Description ko |
description_mr | text | read only | Description mr |
description_pt | text | read only | Description pt |
description_ru | text | read only | Description ru |
description_ta | text | read only | Description ta |
description_ur | text | read only | Description ur |
description_zh | text | read only | Description zh |
message_ar | text | read only | Message ar |
message_bn | text | read only | Message bn |
message_de | text | read only | Message de |
message_es | text | read only | Message es |
message_fr | text | read only | Message fr |
message_hi | text | read only | Message hi |
message_it | text | read only | Message it |
message_ja | text | read only | Message ja |
message_kn | text | read only | Message kn |
message_ko | text | read only | Message ko |
message_mr | text | read only | Message mr |
message_pt | text | read only | Message pt |
message_ru | text | read only | Message ru |
message_ta | text | read only | Message ta |
message_ur | text | read only | Message ur |
message_zh | text | read only | Message zh |
updated_at | timestamp with time zone | read only | Updated at |
updated_by | uuid | read only | Updated by |
xf_text_1 | text | read only | Xf text 1 |
xf_text_2 | text | read only | Xf text 2 |
xf_text_3 | text | read only | Xf text 3 |
xf_text_4 | text | read only | Xf text 4 |
xf_text_5 | text | read only | Xf text 5 |
xf_num_1 | numeric | read only | Xf num 1 |
xf_num_2 | numeric | read only | Xf num 2 |
xf_num_3 | numeric | read only | Xf num 3 |
xf_date_1 | date | read only | Xf date 1 |
xf_date_2 | date | read only | Xf date 2 |
Errors
| Status | Meaning |
|---|---|
| 400 | The request could not be read: a filter that is not JSON, a bad parameter |
| 401 | No credential, or it is wrong, revoked or expired |
| 403 | The caller's roles do not hold Agentic AI › Guardrails for this verb, or the address or origin is not allowed |
| 404 | No record with that id is visible to the caller |
| 409 | A conflict: a duplicate number, a document in a state that does not allow it, or a record changed or locked by someone else |
| 422 | Refused 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.