Agentic AI · Operate
Agent Runs
Every run, with what it did, what it cost and what stopped it. A run is not a record somebody edits — it is the account of what happened.
/api/agentic/runsPublished as /api/v1/runsOverview
| 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 › Agent Runs 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.runs · 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
10 operations. Open one for its parameters, bodies, responses and a sample request.
GET/api/agentic/runsList agent runs
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_no": "RUN-000001",
"workflow_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"workflow_version": 10,
"agent_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"agent_version": 10,
"trigger_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"parent_run_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"started_by": "text",
"started_by_user_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"subject_module": "text",
"subject_resource": "text",
"subject_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}
],
"count": 1
}Sample request
curl "https://demo.tranxact.ai/api/agentic/runs?limit=20" \
-H "Authorization: Bearer $TOKEN"GET/api/agentic/runs/{id}Read one runs
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_no": "RUN-000001",
"workflow_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"workflow_version": 10,
"agent_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"agent_version": 10,
"trigger_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"parent_run_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"started_by": "text",
"started_by_user_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"subject_module": "text",
"subject_resource": "text",
"subject_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}404 when no record with that id is visible to the caller.
Sample request
curl "https://demo.tranxact.ai/api/agentic/runs/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"GET/api/agentic/runs/{id}/traceTrace
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Response
200 with the data as JSON.
Sample request
curl "https://demo.tranxact.ai/api/agentic/runs/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/trace" \
-H "Authorization: Bearer $TOKEN"POST/api/agentic/runsPost agent runs
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/runs" \
-H "Authorization: Bearer $TOKEN"POST/api/agentic/runs/{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/runs/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/runs/{id}Put agent runs
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/runs/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"DELETE/api/agentic/runs/{id}Delete agent runs
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/runs/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/agentic/runs/{id}/advanceAdvance
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 POST "https://demo.tranxact.ai/api/agentic/runs/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/advance" \
-H "Authorization: Bearer $TOKEN"POST/api/agentic/runs/{id}/cancelCancel
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):
reasonResponse
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/runs/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/cancel" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"reason":"value"}'POST/api/agentic/runs/{id}/retryRetry
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 POST "https://demo.tranxact.ai/api/agentic/runs/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/retry" \
-H "Authorization: Bearer $TOKEN"Data model
Every field of a runs, 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_no | text | read only | Run no |
workflow_id | uuid | read only | Workflow id |
workflow_version | integer | read only | Workflow version |
agent_id | uuid | read only | Agent id |
agent_version | integer | read only | Agent version |
trigger_id | uuid | read only | Trigger id |
parent_run_id | uuid | read only | Parent run id |
started_by | text | read only | Started by |
started_by_user_id | uuid | read only | Started by user id |
subject_module | text | read only | Subject module |
subject_resource | text | read only | Subject resource |
subject_id | uuid | read only | Subject id |
input | jsonb | read only | Input |
state | jsonb | read only | State |
output | jsonb | read only | Output |
status | text | read only | Status |
current_node | text | read only | Current node |
step_count | integer | read only | Step count |
tool_call_count | integer | read only | Tool call count |
approval_count | integer | read only | Approval count |
input_tokens | bigint | read only | Input tokens |
output_tokens | bigint | read only | Output tokens |
cached_tokens | bigint | read only | Cached tokens |
cost | numeric | read only | Cost |
currency | text | read only | Currency |
records_created | integer | read only | Records created |
records_updated | integer | read only | Records updated |
messages_sent | integer | read only | Messages sent |
value_amount | numeric | read only | Value amount |
started_at | timestamp with time zone | read only | Started at |
finished_at | timestamp with time zone | read only | Finished at |
duration_ms | integer | read only | Duration ms |
error_code | text | read only | Error code |
error_message | text | read only | Error message |
stopped_by | text | read only | Stopped by |
guardrail_id | uuid | read only | Guardrail id |
summary | text | read only | Summary |
summary_local | text | read only | Summary local |
created_at | timestamp with time zone | read only | Created at |
created_by | uuid | read only | Created by |
updated_at | timestamp with time zone | read only | Updated at |
updated_by | uuid | read only | Updated by |
run_as_user_id | uuid | read only | Run as user id |
source_event_id | bigint | read only | Source event id |
provider | text | read only | Provider |
model | text | read only | Model |
cost_status | text | read only | Cost status |
partial_reason | text | read only | Partial reason |
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 › Agent Runs 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.