TRANXACT.AI Help

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.

Type REST10 operationsBase path /api/agentic/runsPublished as /api/v1/runs

Download specification (OpenAPI 3.1) Screen: Agent Runs

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 › 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.
Tableagent.runs · kept per company (and organisational unit where it has one)
RecordRead only; key id
RulesThe 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

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

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

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

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

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

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

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

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):

reason

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/cancel" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"reason":"value"}'
POST/api/agentic/runs/{id}/retryRetry

Path parameters

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

FieldTypeAccessDescription
iduuidread onlyId
org_iduuidread onlyOrg id
org_unit_iduuidread onlyOrg unit id
run_notextread onlyRun no
workflow_iduuidread onlyWorkflow id
workflow_versionintegerread onlyWorkflow version
agent_iduuidread onlyAgent id
agent_versionintegerread onlyAgent version
trigger_iduuidread onlyTrigger id
parent_run_iduuidread onlyParent run id
started_bytextread onlyStarted by
started_by_user_iduuidread onlyStarted by user id
subject_moduletextread onlySubject module
subject_resourcetextread onlySubject resource
subject_iduuidread onlySubject id
inputjsonbread onlyInput
statejsonbread onlyState
outputjsonbread onlyOutput
statustextread onlyStatus
current_nodetextread onlyCurrent node
step_countintegerread onlyStep count
tool_call_countintegerread onlyTool call count
approval_countintegerread onlyApproval count
input_tokensbigintread onlyInput tokens
output_tokensbigintread onlyOutput tokens
cached_tokensbigintread onlyCached tokens
costnumericread onlyCost
currencytextread onlyCurrency
records_createdintegerread onlyRecords created
records_updatedintegerread onlyRecords updated
messages_sentintegerread onlyMessages sent
value_amountnumericread onlyValue amount
started_attimestamp with time zoneread onlyStarted at
finished_attimestamp with time zoneread onlyFinished at
duration_msintegerread onlyDuration ms
error_codetextread onlyError code
error_messagetextread onlyError message
stopped_bytextread onlyStopped by
guardrail_iduuidread onlyGuardrail id
summarytextread onlySummary
summary_localtextread onlySummary local
created_attimestamp with time zoneread onlyCreated at
created_byuuidread onlyCreated by
updated_attimestamp with time zoneread onlyUpdated at
updated_byuuidread onlyUpdated by
run_as_user_iduuidread onlyRun as user id
source_event_idbigintread onlySource event id
providertextread onlyProvider
modeltextread onlyModel
cost_statustextread onlyCost status
partial_reasontextread onlyPartial reason
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 › Agent Runs 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.