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.
/api/agentic/tool-callsPublished as /api/v1/tool-callsOverview
| 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 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. |
| Table | agent.tool_calls · kept per company (and organisational unit where it has one) |
| Record | Read only; 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/tool-callsList tool calls
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",
"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
| 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",
"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
| 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/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
| Name | Type | Description |
|---|---|---|
id | string (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
| Name | Type | Description |
|---|---|---|
id | string (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.
| 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 |
run_id | uuid | read only | Run id |
step_id | uuid | read only | Step id |
agent_id | uuid | read only | Agent id |
tool_id | uuid | read only | Tool id |
connection_id | uuid | read only | Connection id |
tool_code | text | read only | Tool code |
call_ref | text | read only | Call ref |
arguments | jsonb | read only | Arguments |
result | jsonb | read only | Result |
result_summary | text | read only | Result summary |
status | text | read only | Status |
authorized_by | text | read only | Authorized by |
approval_id | uuid | read only | Approval id |
denied_reason | text | read only | Denied reason |
http_status | integer | read only | Http status |
duration_ms | integer | read only | Duration ms |
cost | numeric | read only | Cost |
result_module | text | read only | Result module |
result_resource | text | read only | Result resource |
result_id | uuid | read only | Result id |
called_at | timestamp with time zone | read only | Called at |
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 Calls 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.