Agentic AI · Reachable by link
Nodes
Every node of every graph, as a list. The canvas is the way to work on these; this is here for searching across workflows and for a saved view.
/api/agentic/workflow-nodesPublished as /api/v1/workflow-nodesOverview
| 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 › Nodes 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.workflow_nodes · kept per company (and organisational unit where it has one) |
| Record | Created, changed and (where the screen allows) deleted; 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/workflow-nodesList nodes
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",
"workflow_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"node_key": "text",
"label": "text",
"label_local": "text",
"node_kind": "text",
"description": "text",
"agent_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"tool_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"subflow_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"prompt": "text",
"arguments": {},
"output_key": "text"
}
],
"count": 1
}Sample request
curl "https://demo.tranxact.ai/api/agentic/workflow-nodes?limit=20" \
-H "Authorization: Bearer $TOKEN"GET/api/agentic/workflow-nodes/{id}Read one node
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",
"workflow_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"node_key": "text",
"label": "text",
"label_local": "text",
"node_kind": "text",
"description": "text",
"agent_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"tool_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"subflow_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"prompt": "text",
"arguments": {},
"output_key": "text"
}404 when no record with that id is visible to the caller.
Sample request
curl "https://demo.tranxact.ai/api/agentic/workflow-nodes/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/agentic/workflow-nodesCreate a node
Request body
The record as JSON. Fields marked Yes are required.
| Field | Type | Required | Description |
|---|---|---|---|
workflow_id | uuid | Yes | Workflow |
node_key | text | Yes | Key — A short name for this step, unique in the workflow, e.g. check_stock. Edges and later steps refer to it. |
label | text | Yes | Label — What the step is called on the canvas. |
label_local | text | No | Label local |
node_kind | text | Yes | Kind — What the step does. agent: an agent thinks and acts; tool: one tool call; decision: choose a path; loop: repeat over a list; human: a person approves; subflow: run another workflow. |
description | text | No | Description |
agent_id | uuid | No | Agent — The agent that does this step. |
tool_id | uuid | No | Tool — The tool called at this step. |
subflow_id | uuid | No | Sub-workflow — The workflow run as this step; it finishes before the next step starts. |
prompt | text | No | Instruction — What the agent is told to do at this step, or the question put to the approver. |
arguments | jsonb | No | Arguments — JSON passed to the tool or sub-workflow, e.g. {"employee_id": "{{input.employee_id}}"}. Checked when you save. |
output_key | text | No | Write result to — A name for this step's result, e.g. stock; later steps read it as {{stock}}. |
condition | text | No | Expression — The condition that decides the path, e.g. amount > 10000. Edges from this step say which way true and false go. |
loop_over | text | No | Loop over — The list to repeat for, from an earlier result, e.g. result.employees. |
loop_max | integer | No | Most iterations — The loop stops after this many items, however long the list is. |
approver_role | text | No | Approver role — Who answers this approval: any person holding this role (Platform › Access › Roles). |
approver_user_id | uuid | No | Approver user id |
sla_hours | integer | No | Answer within (hours) — How long the approver has; after that the approval expires and the run is told. Empty: 72 hours. |
compensate_tool_id | uuid | No | Compensate tool id |
compensate_args | jsonb | No | Compensate args |
retry_limit | integer | No | Retries — How many times a failed step is tried again before On error applies. 0: not retried. |
timeout_seconds | integer | No | Time limit (seconds) — A step still running after this long is treated as failed. |
on_error | text | No | On error — If the step fails: inherit — do what the workflow says; stop — end the run; continue — go on to the next step; retry — try again (up to Retries); route — follow this step's error edge. Allowed: inherit stop continue retry route |
pos_x | integer | No | Pos x |
pos_y | integer | No | Pos y |
color | text | No | Color |
icon | text | No | Icon |
sort_order | integer | No | Sort order |
is_active | boolean | No | Active — Untick to leave the step out of runs without deleting it. |
Sample body
{
"workflow_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"node_key": "text",
"label": "text",
"node_kind": "text",
"label_local": "text",
"description": "text",
"agent_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"tool_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}Response 201
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"workflow_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"node_key": "text",
"label": "text",
"label_local": "text",
"node_kind": "text",
"description": "text",
"agent_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"tool_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"subflow_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"prompt": "text",
"arguments": {},
"output_key": "text"
}Sample request
curl -X POST "https://demo.tranxact.ai/api/agentic/workflow-nodes" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"workflow_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","node_key":"text","label":"text","node_kind":"text","label_local":"text","description":"text","agent_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","tool_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"}'PUT/api/agentic/workflow-nodes/{id}Change a node
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Request body
Only the fields to change; fields left out keep their value.
| Field | Type | Required | Description |
|---|---|---|---|
workflow_id | uuid | Yes | Workflow |
node_key | text | Yes | Key — A short name for this step, unique in the workflow, e.g. check_stock. Edges and later steps refer to it. |
label | text | Yes | Label — What the step is called on the canvas. |
label_local | text | No | Label local |
node_kind | text | Yes | Kind — What the step does. agent: an agent thinks and acts; tool: one tool call; decision: choose a path; loop: repeat over a list; human: a person approves; subflow: run another workflow. |
description | text | No | Description |
agent_id | uuid | No | Agent — The agent that does this step. |
tool_id | uuid | No | Tool — The tool called at this step. |
subflow_id | uuid | No | Sub-workflow — The workflow run as this step; it finishes before the next step starts. |
prompt | text | No | Instruction — What the agent is told to do at this step, or the question put to the approver. |
arguments | jsonb | No | Arguments — JSON passed to the tool or sub-workflow, e.g. {"employee_id": "{{input.employee_id}}"}. Checked when you save. |
output_key | text | No | Write result to — A name for this step's result, e.g. stock; later steps read it as {{stock}}. |
condition | text | No | Expression — The condition that decides the path, e.g. amount > 10000. Edges from this step say which way true and false go. |
loop_over | text | No | Loop over — The list to repeat for, from an earlier result, e.g. result.employees. |
loop_max | integer | No | Most iterations — The loop stops after this many items, however long the list is. |
approver_role | text | No | Approver role — Who answers this approval: any person holding this role (Platform › Access › Roles). |
approver_user_id | uuid | No | Approver user id |
sla_hours | integer | No | Answer within (hours) — How long the approver has; after that the approval expires and the run is told. Empty: 72 hours. |
compensate_tool_id | uuid | No | Compensate tool id |
compensate_args | jsonb | No | Compensate args |
retry_limit | integer | No | Retries — How many times a failed step is tried again before On error applies. 0: not retried. |
timeout_seconds | integer | No | Time limit (seconds) — A step still running after this long is treated as failed. |
on_error | text | No | On error — If the step fails: inherit — do what the workflow says; stop — end the run; continue — go on to the next step; retry — try again (up to Retries); route — follow this step's error edge. Allowed: inherit stop continue retry route |
pos_x | integer | No | Pos x |
pos_y | integer | No | Pos y |
color | text | No | Color |
icon | text | No | Icon |
sort_order | integer | No | Sort order |
is_active | boolean | No | Active — Untick to leave the step out of runs without deleting it. |
Sample body
{
"workflow_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"node_key": "text"
}Response 200
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"workflow_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"node_key": "text",
"label": "text",
"label_local": "text",
"node_kind": "text",
"description": "text",
"agent_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"tool_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"subflow_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"prompt": "text",
"arguments": {},
"output_key": "text"
}Sample request
curl -X PUT "https://demo.tranxact.ai/api/agentic/workflow-nodes/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"workflow_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","node_key":"text"}'DELETE/api/agentic/workflow-nodes/{id}Delete a node
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (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/workflow-nodes/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/agentic/workflow-nodes/{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/workflow-nodes/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 node, 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 |
workflow_id | uuid | read, write | Workflow |
node_key | text | read, write | Key — A short name for this step, unique in the workflow, e.g. check_stock. Edges and later steps refer to it. |
label | text | read, write | Label — What the step is called on the canvas. |
label_local | text | read, write | Label local |
node_kind | text | read, write | Kind — What the step does. agent: an agent thinks and acts; tool: one tool call; decision: choose a path; loop: repeat over a list; human: a person approves; subflow: run another workflow. |
description | text | read, write | Description |
agent_id | uuid | read, write | Agent — The agent that does this step. |
tool_id | uuid | read, write | Tool — The tool called at this step. |
subflow_id | uuid | read, write | Sub-workflow — The workflow run as this step; it finishes before the next step starts. |
prompt | text | read, write | Instruction — What the agent is told to do at this step, or the question put to the approver. |
arguments | jsonb | read, write | Arguments — JSON passed to the tool or sub-workflow, e.g. {"employee_id": "{{input.employee_id}}"}. Checked when you save. |
output_key | text | read, write | Write result to — A name for this step's result, e.g. stock; later steps read it as {{stock}}. |
condition | text | read, write | Expression — The condition that decides the path, e.g. amount > 10000. Edges from this step say which way true and false go. |
loop_over | text | read, write | Loop over — The list to repeat for, from an earlier result, e.g. result.employees. |
loop_max | integer | read, write | Most iterations — The loop stops after this many items, however long the list is. |
approver_role | text | read, write | Approver role — Who answers this approval: any person holding this role (Platform › Access › Roles). |
approver_user_id | uuid | read, write | Approver user id |
sla_hours | integer | read, write | Answer within (hours) — How long the approver has; after that the approval expires and the run is told. Empty: 72 hours. |
compensate_tool_id | uuid | read, write | Compensate tool id |
compensate_args | jsonb | read, write | Compensate args |
retry_limit | integer | read, write | Retries — How many times a failed step is tried again before On error applies. 0: not retried. |
timeout_seconds | integer | read, write | Time limit (seconds) — A step still running after this long is treated as failed. |
on_error | text | read, write | On error — If the step fails: inherit — do what the workflow says; stop — end the run; continue — go on to the next step; retry — try again (up to Retries); route — follow this step's error edge. Allowed: inherit stop continue retry route |
pos_x | integer | read, write | Pos x |
pos_y | integer | read, write | Pos y |
color | text | read, write | Color |
icon | text | read, write | Icon |
sort_order | integer | read, write | Sort order |
is_active | boolean | read, write | Active — Untick to leave the step out of runs without deleting it. |
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 |
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 › Nodes 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.