TRANXACT.AI Help

Agentic AI · Operate

Tool Calls

Every call an agent made and what let it through. This column — grant, approval or guardrail — is what turns this table from a log into evidence.

Type REST6 operationsBase path /api/agentic/tool-callsPublished as /api/v1/tool-calls

Download specification (OpenAPI 3.1) Screen: Tool Calls

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 Calls 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.tool_calls · kept per company (and organisational unit where it has one)
RecordRead only; 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/tool-callsList tool calls

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",
      "run_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "step_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "agent_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "tool_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "connection_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "tool_code": "TOO-000001",
      "call_ref": "text",
      "arguments": {},
      "result": {},
      "result_summary": "text",
      "status": "draft",
      "authorized_by": "text"
    }
  ],
  "count": 1
}

Sample request

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

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",
  "run_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "step_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "agent_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "tool_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "connection_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "tool_code": "TOO-000001",
  "call_ref": "text",
  "arguments": {},
  "result": {},
  "result_summary": "text",
  "status": "draft",
  "authorized_by": "text"
}

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

Sample request

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

No body is required.

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

Path parameters

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

No body is required.

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 PUT "https://demo.tranxact.ai/api/agentic/tool-calls/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
DELETE/api/agentic/tool-calls/{id}Delete tool calls

Path parameters

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

No body is required.

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 DELETE "https://demo.tranxact.ai/api/agentic/tool-calls/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"

Data model

Every field of a tool call, 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
run_iduuidread onlyRun id
step_iduuidread onlyStep id
agent_iduuidread onlyAgent id
tool_iduuidread onlyTool id
connection_iduuidread onlyConnection id
tool_codetextread onlyTool code
call_reftextread onlyCall ref
argumentsjsonbread onlyArguments
resultjsonbread onlyResult
result_summarytextread onlyResult summary
statustextread onlyStatus
authorized_bytextread onlyAuthorized by
approval_iduuidread onlyApproval id
denied_reasontextread onlyDenied reason
http_statusintegerread onlyHttp status
duration_msintegerread onlyDuration ms
costnumericread onlyCost
result_moduletextread onlyResult module
result_resourcetextread onlyResult resource
result_iduuidread onlyResult id
called_attimestamp with time zoneread onlyCalled at

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 Calls 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.