TRANXACT.AI Help

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.

Type REST6 operationsBase path /api/agentic/workflow-nodesPublished as /api/v1/workflow-nodes

Download specification (OpenAPI 3.1) Screen: Nodes

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 › 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.
Tableagent.workflow_nodes · kept per company (and organisational unit where it has one)
RecordCreated, changed and (where the screen allows) deleted; 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/workflow-nodesList nodes

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",
      "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

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",
  "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.

FieldTypeRequiredDescription
workflow_iduuidYesWorkflow
node_keytextYesKey — A short name for this step, unique in the workflow, e.g. check_stock. Edges and later steps refer to it.
labeltextYesLabel — What the step is called on the canvas.
label_localtextNoLabel local
node_kindtextYesKind — 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.
descriptiontextNoDescription
agent_iduuidNoAgent — The agent that does this step.
tool_iduuidNoTool — The tool called at this step.
subflow_iduuidNoSub-workflow — The workflow run as this step; it finishes before the next step starts.
prompttextNoInstruction — What the agent is told to do at this step, or the question put to the approver.
argumentsjsonbNoArguments — JSON passed to the tool or sub-workflow, e.g. {"employee_id": "{{input.employee_id}}"}. Checked when you save.
output_keytextNoWrite result to — A name for this step's result, e.g. stock; later steps read it as {{stock}}.
conditiontextNoExpression — The condition that decides the path, e.g. amount > 10000. Edges from this step say which way true and false go.
loop_overtextNoLoop over — The list to repeat for, from an earlier result, e.g. result.employees.
loop_maxintegerNoMost iterations — The loop stops after this many items, however long the list is.
approver_roletextNoApprover role — Who answers this approval: any person holding this role (Platform › Access › Roles).
approver_user_iduuidNoApprover user id
sla_hoursintegerNoAnswer within (hours) — How long the approver has; after that the approval expires and the run is told. Empty: 72 hours.
compensate_tool_iduuidNoCompensate tool id
compensate_argsjsonbNoCompensate args
retry_limitintegerNoRetries — How many times a failed step is tried again before On error applies. 0: not retried.
timeout_secondsintegerNoTime limit (seconds) — A step still running after this long is treated as failed.
on_errortextNoOn 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_xintegerNoPos x
pos_yintegerNoPos y
colortextNoColor
icontextNoIcon
sort_orderintegerNoSort order
is_activebooleanNoActive — 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

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

Request body

Only the fields to change; fields left out keep their value.

FieldTypeRequiredDescription
workflow_iduuidYesWorkflow
node_keytextYesKey — A short name for this step, unique in the workflow, e.g. check_stock. Edges and later steps refer to it.
labeltextYesLabel — What the step is called on the canvas.
label_localtextNoLabel local
node_kindtextYesKind — 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.
descriptiontextNoDescription
agent_iduuidNoAgent — The agent that does this step.
tool_iduuidNoTool — The tool called at this step.
subflow_iduuidNoSub-workflow — The workflow run as this step; it finishes before the next step starts.
prompttextNoInstruction — What the agent is told to do at this step, or the question put to the approver.
argumentsjsonbNoArguments — JSON passed to the tool or sub-workflow, e.g. {"employee_id": "{{input.employee_id}}"}. Checked when you save.
output_keytextNoWrite result to — A name for this step's result, e.g. stock; later steps read it as {{stock}}.
conditiontextNoExpression — The condition that decides the path, e.g. amount > 10000. Edges from this step say which way true and false go.
loop_overtextNoLoop over — The list to repeat for, from an earlier result, e.g. result.employees.
loop_maxintegerNoMost iterations — The loop stops after this many items, however long the list is.
approver_roletextNoApprover role — Who answers this approval: any person holding this role (Platform › Access › Roles).
approver_user_iduuidNoApprover user id
sla_hoursintegerNoAnswer within (hours) — How long the approver has; after that the approval expires and the run is told. Empty: 72 hours.
compensate_tool_iduuidNoCompensate tool id
compensate_argsjsonbNoCompensate args
retry_limitintegerNoRetries — How many times a failed step is tried again before On error applies. 0: not retried.
timeout_secondsintegerNoTime limit (seconds) — A step still running after this long is treated as failed.
on_errortextNoOn 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_xintegerNoPos x
pos_yintegerNoPos y
colortextNoColor
icontextNoIcon
sort_orderintegerNoSort order
is_activebooleanNoActive — 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

NameTypeDescription
idstring (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

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

FieldTypeAccessDescription
iduuidread onlyId
org_iduuidread onlyOrg id
org_unit_iduuidread onlyOrg unit id
workflow_iduuidread, writeWorkflow
node_keytextread, writeKey — A short name for this step, unique in the workflow, e.g. check_stock. Edges and later steps refer to it.
labeltextread, writeLabel — What the step is called on the canvas.
label_localtextread, writeLabel local
node_kindtextread, writeKind — 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.
descriptiontextread, writeDescription
agent_iduuidread, writeAgent — The agent that does this step.
tool_iduuidread, writeTool — The tool called at this step.
subflow_iduuidread, writeSub-workflow — The workflow run as this step; it finishes before the next step starts.
prompttextread, writeInstruction — What the agent is told to do at this step, or the question put to the approver.
argumentsjsonbread, writeArguments — JSON passed to the tool or sub-workflow, e.g. {"employee_id": "{{input.employee_id}}"}. Checked when you save.
output_keytextread, writeWrite result to — A name for this step's result, e.g. stock; later steps read it as {{stock}}.
conditiontextread, writeExpression — The condition that decides the path, e.g. amount > 10000. Edges from this step say which way true and false go.
loop_overtextread, writeLoop over — The list to repeat for, from an earlier result, e.g. result.employees.
loop_maxintegerread, writeMost iterations — The loop stops after this many items, however long the list is.
approver_roletextread, writeApprover role — Who answers this approval: any person holding this role (Platform › Access › Roles).
approver_user_iduuidread, writeApprover user id
sla_hoursintegerread, writeAnswer within (hours) — How long the approver has; after that the approval expires and the run is told. Empty: 72 hours.
compensate_tool_iduuidread, writeCompensate tool id
compensate_argsjsonbread, writeCompensate args
retry_limitintegerread, writeRetries — How many times a failed step is tried again before On error applies. 0: not retried.
timeout_secondsintegerread, writeTime limit (seconds) — A step still running after this long is treated as failed.
on_errortextread, writeOn 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_xintegerread, writePos x
pos_yintegerread, writePos y
colortextread, writeColor
icontextread, writeIcon
sort_orderintegerread, writeSort order
is_activebooleanread, writeActive — Untick to leave the step out of runs without deleting it.
created_attimestamp with time zoneread onlyCreated at
created_byuuidread onlyCreated by
updated_attimestamp with time zoneread onlyUpdated at
updated_byuuidread onlyUpdated by
xf_text_1textread onlyXf text 1
xf_text_2textread onlyXf text 2
xf_text_3textread onlyXf text 3
xf_text_4textread onlyXf text 4
xf_text_5textread onlyXf text 5
xf_num_1numericread onlyXf num 1
xf_num_2numericread onlyXf num 2
xf_num_3numericread onlyXf num 3
xf_date_1dateread onlyXf date 1
xf_date_2dateread onlyXf date 2

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 › Nodes 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.