Agentic AI · Reachable by link
Steps
Every node execution across every run. The trace on a run is the way to read these; this is for searching across runs.
/api/agentic/run-stepsPublished as /api/v1/run-stepsOverview
| 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 › Steps 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.run_steps · 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/run-stepsList steps
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_no": 10,
"node_key": "text",
"node_kind": "text",
"label": "text",
"agent_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"tool_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"reasoning": "text",
"input": {},
"output": {},
"status": "draft",
"attempt": 10
}
],
"count": 1
}Sample request
curl "https://demo.tranxact.ai/api/agentic/run-steps?limit=20" \
-H "Authorization: Bearer $TOKEN"GET/api/agentic/run-steps/{id}Read one step
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_no": 10,
"node_key": "text",
"node_kind": "text",
"label": "text",
"agent_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"tool_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"reasoning": "text",
"input": {},
"output": {},
"status": "draft",
"attempt": 10
}404 when no record with that id is visible to the caller.
Sample request
curl "https://demo.tranxact.ai/api/agentic/run-steps/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/agentic/run-stepsPost steps
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/run-steps" \
-H "Authorization: Bearer $TOKEN"POST/api/agentic/run-steps/{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/run-steps/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/run-steps/{id}Put steps
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/run-steps/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"DELETE/api/agentic/run-steps/{id}Delete steps
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/run-steps/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"Data model
Every field of a step, 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_no | integer | read only | Step no |
node_key | text | read only | Node key |
node_kind | text | read only | Node kind |
label | text | read only | Label |
agent_id | uuid | read only | Agent id |
tool_id | uuid | read only | Tool id |
reasoning | text | read only | Reasoning |
input | jsonb | read only | Input |
output | jsonb | read only | Output |
status | text | read only | Status |
attempt | integer | read only | Attempt |
input_tokens | integer | read only | Input tokens |
output_tokens | integer | read only | Output tokens |
cost | numeric | read only | Cost |
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_message | text | read only | Error message |
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 › Steps 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.