TRANXACT.AI Help

Agentic AI · Build

Tool Grants

Which agent may call what, and on what terms. The same tool is a different risk in two agents' hands, which is why the limits live on the grant rather than on the tool.

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

Download specification (OpenAPI 3.1) Screen: Tool Grants

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 Grants 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.agent_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/agent-toolsList tool grants

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",
      "agent_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "tool_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "bound_args": {},
      "precondition": "text",
      "max_calls_per_run": 10,
      "requires_approval": true,
      "is_enabled": true,
      "granted_at": "2026-10-30T09:00:00Z",
      "granted_by": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "created_at": "2026-10-30T09:00:00Z",
      "created_by": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "updated_at": "2026-10-30T09:00:00Z"
    }
  ],
  "count": 1
}

Sample request

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

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",
  "agent_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "tool_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "bound_args": {},
  "precondition": "text",
  "max_calls_per_run": 10,
  "requires_approval": true,
  "is_enabled": true,
  "granted_at": "2026-10-30T09:00:00Z",
  "granted_by": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "created_at": "2026-10-30T09:00:00Z",
  "created_by": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "updated_at": "2026-10-30T09:00:00Z"
}

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

Sample request

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

Request body

The record as JSON. Fields marked Yes are required.

FieldTypeRequiredDescription
agent_iduuidYesAgent
tool_iduuidYesTool
bound_argsjsonbNoFixed arguments — Values this agent must always use with this tool, written as JSON: names and values in braces, like the example in the box. They replace anything the agent chooses for the same name, so {"business_unit_id": "BU-01"} keeps it working in that business unit only. Leave empty for none.
preconditiontextNoOnly when — A condition every call must meet, written on what the call sends: the name of one of the tool's inputs, a comparison (=, <>, <, <=, >, >=) and a value, joined with and / or -- for example amount <= 5000, or status = 'draft'. A call that does not meet it, or does not send what it names, is refused and the agent is told why. Checked when you save. Leave empty to allow every call.
max_calls_per_runintegerNoCalls per run — The most times the agent may use this tool in one run, as a whole number. Further calls are refused and counted as Refused calls on the run. Empty: no limit of its own (the agent's own tool-call limit still applies). 0: the tool cannot be called at all.
requires_approvalbooleanNoAlways ask a person — If ticked, every call to this tool waits until a person approves it. The request appears in Agentic AI › Agent Approvals, where anyone whose role may act on Agent Approvals approves or declines it; the agent's run waits until then.
is_enabledbooleanNoEnabled — Untick to withdraw the grant without deleting it. It stops at once, without a Publish.

Sample body

{
  "agent_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "tool_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "bound_args": {},
  "precondition": "text",
  "max_calls_per_run": 10,
  "requires_approval": true
}

Response 201

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "agent_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "tool_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "bound_args": {},
  "precondition": "text",
  "max_calls_per_run": 10,
  "requires_approval": true,
  "is_enabled": true,
  "granted_at": "2026-10-30T09:00:00Z",
  "granted_by": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "created_at": "2026-10-30T09:00:00Z",
  "created_by": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "updated_at": "2026-10-30T09:00:00Z"
}

Sample request

curl -X POST "https://demo.tranxact.ai/api/agentic/agent-tools" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"agent_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","tool_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","bound_args":{},"precondition":"text","max_calls_per_run":10,"requires_approval":true}'
PUT/api/agentic/agent-tools/{id}Change a tool grant

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
agent_iduuidYesAgent
tool_iduuidYesTool
bound_argsjsonbNoFixed arguments — Values this agent must always use with this tool, written as JSON: names and values in braces, like the example in the box. They replace anything the agent chooses for the same name, so {"business_unit_id": "BU-01"} keeps it working in that business unit only. Leave empty for none.
preconditiontextNoOnly when — A condition every call must meet, written on what the call sends: the name of one of the tool's inputs, a comparison (=, <>, <, <=, >, >=) and a value, joined with and / or -- for example amount <= 5000, or status = 'draft'. A call that does not meet it, or does not send what it names, is refused and the agent is told why. Checked when you save. Leave empty to allow every call.
max_calls_per_runintegerNoCalls per run — The most times the agent may use this tool in one run, as a whole number. Further calls are refused and counted as Refused calls on the run. Empty: no limit of its own (the agent's own tool-call limit still applies). 0: the tool cannot be called at all.
requires_approvalbooleanNoAlways ask a person — If ticked, every call to this tool waits until a person approves it. The request appears in Agentic AI › Agent Approvals, where anyone whose role may act on Agent Approvals approves or declines it; the agent's run waits until then.
is_enabledbooleanNoEnabled — Untick to withdraw the grant without deleting it. It stops at once, without a Publish.

Sample body

{
  "agent_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "tool_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "agent_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "tool_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "bound_args": {},
  "precondition": "text",
  "max_calls_per_run": 10,
  "requires_approval": true,
  "is_enabled": true,
  "granted_at": "2026-10-30T09:00:00Z",
  "granted_by": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "created_at": "2026-10-30T09:00:00Z",
  "created_by": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "updated_at": "2026-10-30T09:00:00Z"
}

Sample request

curl -X PUT "https://demo.tranxact.ai/api/agentic/agent-tools/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"agent_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","tool_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"}'
DELETE/api/agentic/agent-tools/{id}Delete a tool grant

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/agent-tools/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/agentic/agent-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/agent-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 tool grant, 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 onlyOrganizational unit — Which business unit or department this record belongs to. Defaults to the unit selected in the top bar.
agent_iduuidread, writeAgent
tool_iduuidread, writeTool
bound_argsjsonbread, writeFixed arguments — Values this agent must always use with this tool, written as JSON: names and values in braces, like the example in the box. They replace anything the agent chooses for the same name, so {"business_unit_id": "BU-01"} keeps it working in that business unit only. Leave empty for none.
preconditiontextread, writeOnly when — A condition every call must meet, written on what the call sends: the name of one of the tool's inputs, a comparison (=, <>, <, <=, >, >=) and a value, joined with and / or -- for example amount <= 5000, or status = 'draft'. A call that does not meet it, or does not send what it names, is refused and the agent is told why. Checked when you save. Leave empty to allow every call.
max_calls_per_runintegerread, writeCalls per run — The most times the agent may use this tool in one run, as a whole number. Further calls are refused and counted as Refused calls on the run. Empty: no limit of its own (the agent's own tool-call limit still applies). 0: the tool cannot be called at all.
requires_approvalbooleanread, writeAlways ask a person — If ticked, every call to this tool waits until a person approves it. The request appears in Agentic AI › Agent Approvals, where anyone whose role may act on Agent Approvals approves or declines it; the agent's run waits until then.
is_enabledbooleanread, writeEnabled — Untick to withdraw the grant without deleting it. It stops at once, without a Publish.
granted_attimestamp with time zoneread onlyGranted at
granted_byuuidread onlyGranted by
created_attimestamp with time zoneread onlyCreated at
created_byuuidread onlyCreated by
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 › Tool Grants 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.