Agentic AI · Assess
Evaluations
Whether the agent was any good — graded by a person, by another agent, or by what happened to what it produced. A proposal accepted and still standing thirty days later is the strongest signal this table can carry.
/api/agentic/evaluationsPublished as /api/v1/evaluationsOverview
| 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 › Evaluations 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.evaluations · 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/evaluationsList evaluations
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",
"artifact_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"agent_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"workflow_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"evaluator": "text",
"evaluator_user_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"evaluator_agent_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"criterion": "text",
"score": "1250.00",
"verdict": "good",
"comment": "text",
"outcome_kind": "text"
}
],
"count": 1
}Sample request
curl "https://demo.tranxact.ai/api/agentic/evaluations?limit=20" \
-H "Authorization: Bearer $TOKEN"GET/api/agentic/evaluations/{id}Read one evaluation
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",
"artifact_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"agent_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"workflow_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"evaluator": "text",
"evaluator_user_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"evaluator_agent_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"criterion": "text",
"score": "1250.00",
"verdict": "good",
"comment": "text",
"outcome_kind": "text"
}404 when no record with that id is visible to the caller.
Sample request
curl "https://demo.tranxact.ai/api/agentic/evaluations/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/agentic/evaluationsCreate a evaluation
Request body
The record as JSON. Fields marked Yes are required.
| Field | Type | Required | Description |
|---|---|---|---|
run_id | uuid | No | Run — Optional: the run being graded, from this agent's runs. Empty grades the agent in general. |
artifact_id | uuid | No | Artifact id |
agent_id | uuid | No | Agent — The agent whose work is graded. |
workflow_id | uuid | No | Workflow id |
evaluator | text | No | Graded by — Who judged it. A person: you or a colleague. Another agent: an agent acting as grader (choose it below). What happened next: the result of its work, e.g. a proposal accepted and still standing. A rule: an automatic check. |
evaluator_user_id | uuid | No | Evaluator user id |
evaluator_agent_id | uuid | No | Graded by agent — The agent that did the grading — usually a reviewer agent set up to check other agents' work. |
criterion | text | No | Criterion — What the grade is for, e.g. overall, accuracy, tone. Leave blank for overall. The date is recorded automatically when the evaluation is saved (When). |
score | numeric | No | Score — Out of 100: 0 is the worst, 100 the best, e.g. 80. Optional — Verdict alone is enough. |
verdict | text | No | Verdict — good: right and useful; acceptable: usable with small fixes; poor: needed real rework; wrong: incorrect; harmful: would have caused damage if acted on. Kept beside Score; neither is worked out from the other. Allowed: good acceptable poor wrong harmful |
comment | text | No | Comment — Why, in a sentence — the most useful part for whoever improves the agent. |
outcome_kind | text | No | Outcome — For What happened next: what became of the work, e.g. accepted or rejected (filled in by Accept it and Reject it). |
outcome_value | numeric | No | Value — What that outcome was worth, in the company currency, e.g. the cost saved. Optional. |
Sample body
{
"run_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"artifact_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"agent_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"workflow_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}Response 201
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"run_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"artifact_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"agent_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"workflow_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"evaluator": "text",
"evaluator_user_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"evaluator_agent_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"criterion": "text",
"score": "1250.00",
"verdict": "good",
"comment": "text",
"outcome_kind": "text"
}Sample request
curl -X POST "https://demo.tranxact.ai/api/agentic/evaluations" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"run_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","artifact_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","agent_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","workflow_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"}'PUT/api/agentic/evaluations/{id}Change a evaluation
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 |
|---|---|---|---|
run_id | uuid | No | Run — Optional: the run being graded, from this agent's runs. Empty grades the agent in general. |
artifact_id | uuid | No | Artifact id |
agent_id | uuid | No | Agent — The agent whose work is graded. |
workflow_id | uuid | No | Workflow id |
evaluator | text | No | Graded by — Who judged it. A person: you or a colleague. Another agent: an agent acting as grader (choose it below). What happened next: the result of its work, e.g. a proposal accepted and still standing. A rule: an automatic check. |
evaluator_user_id | uuid | No | Evaluator user id |
evaluator_agent_id | uuid | No | Graded by agent — The agent that did the grading — usually a reviewer agent set up to check other agents' work. |
criterion | text | No | Criterion — What the grade is for, e.g. overall, accuracy, tone. Leave blank for overall. The date is recorded automatically when the evaluation is saved (When). |
score | numeric | No | Score — Out of 100: 0 is the worst, 100 the best, e.g. 80. Optional — Verdict alone is enough. |
verdict | text | No | Verdict — good: right and useful; acceptable: usable with small fixes; poor: needed real rework; wrong: incorrect; harmful: would have caused damage if acted on. Kept beside Score; neither is worked out from the other. Allowed: good acceptable poor wrong harmful |
comment | text | No | Comment — Why, in a sentence — the most useful part for whoever improves the agent. |
outcome_kind | text | No | Outcome — For What happened next: what became of the work, e.g. accepted or rejected (filled in by Accept it and Reject it). |
outcome_value | numeric | No | Value — What that outcome was worth, in the company currency, e.g. the cost saved. Optional. |
Sample body
{
"run_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"artifact_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}Response 200
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"run_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"artifact_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"agent_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"workflow_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"evaluator": "text",
"evaluator_user_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"evaluator_agent_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"criterion": "text",
"score": "1250.00",
"verdict": "good",
"comment": "text",
"outcome_kind": "text"
}Sample request
curl -X PUT "https://demo.tranxact.ai/api/agentic/evaluations/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"run_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","artifact_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"}'DELETE/api/agentic/evaluations/{id}Delete a evaluation
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/evaluations/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/agentic/evaluations/{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/evaluations/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 evaluation, 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, write | Run — Optional: the run being graded, from this agent's runs. Empty grades the agent in general. |
artifact_id | uuid | read, write | Artifact id |
agent_id | uuid | read, write | Agent — The agent whose work is graded. |
workflow_id | uuid | read, write | Workflow id |
evaluator | text | read, write | Graded by — Who judged it. A person: you or a colleague. Another agent: an agent acting as grader (choose it below). What happened next: the result of its work, e.g. a proposal accepted and still standing. A rule: an automatic check. |
evaluator_user_id | uuid | read, write | Evaluator user id |
evaluator_agent_id | uuid | read, write | Graded by agent — The agent that did the grading — usually a reviewer agent set up to check other agents' work. |
criterion | text | read, write | Criterion — What the grade is for, e.g. overall, accuracy, tone. Leave blank for overall. The date is recorded automatically when the evaluation is saved (When). |
score | numeric | read, write | Score — Out of 100: 0 is the worst, 100 the best, e.g. 80. Optional — Verdict alone is enough. |
verdict | text | read, write | Verdict — good: right and useful; acceptable: usable with small fixes; poor: needed real rework; wrong: incorrect; harmful: would have caused damage if acted on. Kept beside Score; neither is worked out from the other. Allowed: good acceptable poor wrong harmful |
comment | text | read, write | Comment — Why, in a sentence — the most useful part for whoever improves the agent. |
outcome_kind | text | read, write | Outcome — For What happened next: what became of the work, e.g. accepted or rejected (filled in by Accept it and Reject it). |
outcome_value | numeric | read, write | Value — What that outcome was worth, in the company currency, e.g. the cost saved. Optional. |
evaluated_at | timestamp with time zone | read only | Evaluated at |
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 › Evaluations 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.