Agentic AI · Connect
Tool Catalog
Everything an agent may be granted, of every origin, in one list — because the model is given one list and the person granting authority should be reading the same one. A resource tool is the platform own endpoint, so it inherits the module grant, the org scope, the numbering, the editability rule and the audit trail unchanged.
/api/agentic/toolsPublished as /api/v1/toolsOverview
| 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 › Tool Catalog 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.tools · 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/toolsList tool catalog
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",
"description_local": "text",
"kind": "text",
"category": "text",
"target_module": "text",
"target_resource": "text",
"operation": "list",
"action_path": "text",
"report_key": "text"
}
],
"count": 1
}Sample request
curl "https://demo.tranxact.ai/api/agentic/tools?limit=20" \
-H "Authorization: Bearer $TOKEN"GET/api/agentic/tools/{id}Read one tools
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",
"description_local": "text",
"kind": "text",
"category": "text",
"target_module": "text",
"target_resource": "text",
"operation": "list",
"action_path": "text",
"report_key": "text"
}404 when no record with that id is visible to the caller.
Sample request
curl "https://demo.tranxact.ai/api/agentic/tools/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/agentic/toolsCreate a tools
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 does — This is what the model reads. A vague description produces a tool nobody calls correctly. |
description_local | text | No | Description local |
kind | text | No | Origin |
category | text | No | Category |
target_module | text | No | Module |
target_resource | text | No | Resource |
operation | text | No | Operation Allowed: list get create update delete action |
action_path | text | No | Action path |
report_key | text | No | Report key |
cube_key | text | No | Cube key |
connection_id | uuid | No | Connection |
connection_tool_id | uuid | No | Connection tool id |
builtin_key | text | No | Builtin key |
workflow_id | uuid | No | Workflow id |
input_schema | jsonb | No | Arguments |
is_write | boolean | No | Changes data |
is_destructive | boolean | No | Destructive |
is_external | boolean | No | Reaches outside this company |
moves_money | boolean | No | Moves money |
touches_pii | boolean | No | Touches personal data |
requires_approval | boolean | No | Always ask a person |
required_module | text | No | Module a caller must hold — What stops a grant widening somebody reach past their role. |
max_calls_per_run | integer | No | Calls per run |
is_active | boolean | No | Active |
notes | text | No | Notes |
delegate_brief | text | No | What the worker is told — The brief, with {{task}} where the agent's request goes. {{agent}}, {{title}} and {{run}} are filled in too. |
delegate_review | boolean | No | A person reviews the result first |
delegate_expiry_minutes | integer | No | Expires after (minutes) — A task nobody finishes by then expires, the worker token ends, and the run is told. |
delegate_worker_kind | text | No | For which worker |
Sample body
{
"code": "COD-000001",
"name": "Example",
"name_local": "Example",
"description": "text",
"description_local": "text",
"kind": "text"
}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",
"description_local": "text",
"kind": "text",
"category": "text",
"target_module": "text",
"target_resource": "text",
"operation": "list",
"action_path": "text",
"report_key": "text"
}Sample request
curl -X POST "https://demo.tranxact.ai/api/agentic/tools" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"code":"COD-000001","name":"Example","name_local":"Example","description":"text","description_local":"text","kind":"text"}'PUT/api/agentic/tools/{id}Change a tools
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 does — This is what the model reads. A vague description produces a tool nobody calls correctly. |
description_local | text | No | Description local |
kind | text | No | Origin |
category | text | No | Category |
target_module | text | No | Module |
target_resource | text | No | Resource |
operation | text | No | Operation Allowed: list get create update delete action |
action_path | text | No | Action path |
report_key | text | No | Report key |
cube_key | text | No | Cube key |
connection_id | uuid | No | Connection |
connection_tool_id | uuid | No | Connection tool id |
builtin_key | text | No | Builtin key |
workflow_id | uuid | No | Workflow id |
input_schema | jsonb | No | Arguments |
is_write | boolean | No | Changes data |
is_destructive | boolean | No | Destructive |
is_external | boolean | No | Reaches outside this company |
moves_money | boolean | No | Moves money |
touches_pii | boolean | No | Touches personal data |
requires_approval | boolean | No | Always ask a person |
required_module | text | No | Module a caller must hold — What stops a grant widening somebody reach past their role. |
max_calls_per_run | integer | No | Calls per run |
is_active | boolean | No | Active |
notes | text | No | Notes |
delegate_brief | text | No | What the worker is told — The brief, with {{task}} where the agent's request goes. {{agent}}, {{title}} and {{run}} are filled in too. |
delegate_review | boolean | No | A person reviews the result first |
delegate_expiry_minutes | integer | No | Expires after (minutes) — A task nobody finishes by then expires, the worker token ends, and the run is told. |
delegate_worker_kind | text | No | For which worker |
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",
"description_local": "text",
"kind": "text",
"category": "text",
"target_module": "text",
"target_resource": "text",
"operation": "list",
"action_path": "text",
"report_key": "text"
}Sample request
curl -X PUT "https://demo.tranxact.ai/api/agentic/tools/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"code":"COD-000001","name":"Example"}'DELETE/api/agentic/tools/{id}Delete a tools
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/tools/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/agentic/tools/{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/tools/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 tools, 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 does — This is what the model reads. A vague description produces a tool nobody calls correctly. |
description_local | text | read, write | Description local |
kind | text | read, write | Origin |
category | text | read, write | Category |
target_module | text | read, write | Module |
target_resource | text | read, write | Resource |
operation | text | read, write | Operation Allowed: list get create update delete action |
action_path | text | read, write | Action path |
report_key | text | read, write | Report key |
cube_key | text | read, write | Cube key |
connection_id | uuid | read, write | Connection |
connection_tool_id | uuid | read, write | Connection tool id |
builtin_key | text | read, write | Builtin key |
workflow_id | uuid | read, write | Workflow id |
input_schema | jsonb | read, write | Arguments |
is_write | boolean | read, write | Changes data |
is_destructive | boolean | read, write | Destructive |
is_external | boolean | read, write | Reaches outside this company |
moves_money | boolean | read, write | Moves money |
touches_pii | boolean | read, write | Touches personal data |
requires_approval | boolean | read, write | Always ask a person |
required_module | text | read, write | Module a caller must hold — What stops a grant widening somebody reach past their role. |
max_calls_per_run | integer | read, write | Calls per run |
is_system | boolean | read only | Is system |
is_active | boolean | read, write | Active |
notes | text | read, write | Notes |
created_at | timestamp with time zone | read only | Created at |
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 |
created_by | uuid | read only | Created by |
updated_at | timestamp with time zone | read only | Updated at |
updated_by | uuid | read only | Updated by |
delegate_brief | text | read, write | What the worker is told — The brief, with {{task}} where the agent's request goes. {{agent}}, {{title}} and {{run}} are filled in too. |
delegate_review | boolean | read, write | A person reviews the result first |
delegate_expiry_minutes | integer | read, write | Expires after (minutes) — A task nobody finishes by then expires, the worker token ends, and the run is told. |
delegate_worker_kind | text | read, write | For which worker |
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 › Tool Catalog 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.