TRANXACT.AI Help

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.

Type REST6 operationsBase path /api/agentic/toolsPublished as /api/v1/tools

Download specification (OpenAPI 3.1) Screen: Tool Catalog

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 › 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.
Tableagent.tools · 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/toolsList tool catalog

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",
      "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

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",
  "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.

FieldTypeRequiredDescription
codetextYesCode
nametextYesName
name_localtextNoLocal name
descriptiontextNoWhat it does — This is what the model reads. A vague description produces a tool nobody calls correctly.
description_localtextNoDescription local
kindtextNoOrigin
categorytextNoCategory
target_moduletextNoModule
target_resourcetextNoResource
operationtextNoOperation
Allowed: list get create update delete action
action_pathtextNoAction path
report_keytextNoReport key
cube_keytextNoCube key
connection_iduuidNoConnection
connection_tool_iduuidNoConnection tool id
builtin_keytextNoBuiltin key
workflow_iduuidNoWorkflow id
input_schemajsonbNoArguments
is_writebooleanNoChanges data
is_destructivebooleanNoDestructive
is_externalbooleanNoReaches outside this company
moves_moneybooleanNoMoves money
touches_piibooleanNoTouches personal data
requires_approvalbooleanNoAlways ask a person
required_moduletextNoModule a caller must hold — What stops a grant widening somebody reach past their role.
max_calls_per_runintegerNoCalls per run
is_activebooleanNoActive
notestextNoNotes
delegate_brieftextNoWhat the worker is told — The brief, with {{task}} where the agent's request goes. {{agent}}, {{title}} and {{run}} are filled in too.
delegate_reviewbooleanNoA person reviews the result first
delegate_expiry_minutesintegerNoExpires after (minutes) — A task nobody finishes by then expires, the worker token ends, and the run is told.
delegate_worker_kindtextNoFor 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

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 does — This is what the model reads. A vague description produces a tool nobody calls correctly.
description_localtextNoDescription local
kindtextNoOrigin
categorytextNoCategory
target_moduletextNoModule
target_resourcetextNoResource
operationtextNoOperation
Allowed: list get create update delete action
action_pathtextNoAction path
report_keytextNoReport key
cube_keytextNoCube key
connection_iduuidNoConnection
connection_tool_iduuidNoConnection tool id
builtin_keytextNoBuiltin key
workflow_iduuidNoWorkflow id
input_schemajsonbNoArguments
is_writebooleanNoChanges data
is_destructivebooleanNoDestructive
is_externalbooleanNoReaches outside this company
moves_moneybooleanNoMoves money
touches_piibooleanNoTouches personal data
requires_approvalbooleanNoAlways ask a person
required_moduletextNoModule a caller must hold — What stops a grant widening somebody reach past their role.
max_calls_per_runintegerNoCalls per run
is_activebooleanNoActive
notestextNoNotes
delegate_brieftextNoWhat the worker is told — The brief, with {{task}} where the agent's request goes. {{agent}}, {{title}} and {{run}} are filled in too.
delegate_reviewbooleanNoA person reviews the result first
delegate_expiry_minutesintegerNoExpires after (minutes) — A task nobody finishes by then expires, the worker token ends, and the run is told.
delegate_worker_kindtextNoFor 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

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/tools/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/agentic/tools/{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/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.

FieldTypeAccessDescription
iduuidread onlyId
org_iduuidread onlyOrg id
org_unit_iduuidread onlyOrg unit id
codetextread, writeCode
nametextread, writeName
name_localtextread, writeLocal name
descriptiontextread, writeWhat it does — This is what the model reads. A vague description produces a tool nobody calls correctly.
description_localtextread, writeDescription local
kindtextread, writeOrigin
categorytextread, writeCategory
target_moduletextread, writeModule
target_resourcetextread, writeResource
operationtextread, writeOperation
Allowed: list get create update delete action
action_pathtextread, writeAction path
report_keytextread, writeReport key
cube_keytextread, writeCube key
connection_iduuidread, writeConnection
connection_tool_iduuidread, writeConnection tool id
builtin_keytextread, writeBuiltin key
workflow_iduuidread, writeWorkflow id
input_schemajsonbread, writeArguments
is_writebooleanread, writeChanges data
is_destructivebooleanread, writeDestructive
is_externalbooleanread, writeReaches outside this company
moves_moneybooleanread, writeMoves money
touches_piibooleanread, writeTouches personal data
requires_approvalbooleanread, writeAlways ask a person
required_moduletextread, writeModule a caller must hold — What stops a grant widening somebody reach past their role.
max_calls_per_runintegerread, writeCalls per run
is_systembooleanread onlyIs system
is_activebooleanread, writeActive
notestextread, writeNotes
created_attimestamp with time zoneread onlyCreated at
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
created_byuuidread onlyCreated by
updated_attimestamp with time zoneread onlyUpdated at
updated_byuuidread onlyUpdated by
delegate_brieftextread, writeWhat the worker is told — The brief, with {{task}} where the agent's request goes. {{agent}}, {{title}} and {{run}} are filled in too.
delegate_reviewbooleanread, writeA person reviews the result first
delegate_expiry_minutesintegerread, writeExpires after (minutes) — A task nobody finishes by then expires, the worker token ends, and the run is told.
delegate_worker_kindtextread, writeFor which worker
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 › Tool Catalog 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.