Manufacturing · Manufacturing Intelligence
AI Capabilities
The fourteen, with the two columns that matter: what each is ALLOWED to do, and how accurate it has been measured to be. Nothing ships able to act on its own.
/api/mfg/ai-capabilitiesPublished as /api/v1/ai-capabilitiesDownload specification (OpenAPI 3.1) Screen: AI Capabilities
Overview
| Package | Manufacturing |
|---|---|
| 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 Manufacturing › AI Capabilities 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 | mfg.ai_capabilities · 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/mfg/ai-capabilitiesList ai capabilities
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",
"capability_key": "text",
"name": "Example",
"blurb": "text",
"category": "text",
"module": "text",
"subject_entity": "text",
"method": "text",
"provider": "text",
"model_ref": "text",
"inputs_summary": "text",
"output_summary": "text",
"autonomy": "advise"
}
],
"count": 1
}Sample request
curl "https://demo.tranxact.ai/api/mfg/ai-capabilities?limit=20" \
-H "Authorization: Bearer $TOKEN"GET/api/mfg/ai-capabilities/{id}Read one capability
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",
"capability_key": "text",
"name": "Example",
"blurb": "text",
"category": "text",
"module": "text",
"subject_entity": "text",
"method": "text",
"provider": "text",
"model_ref": "text",
"inputs_summary": "text",
"output_summary": "text",
"autonomy": "advise"
}404 when no record with that id is visible to the caller.
Sample request
curl "https://demo.tranxact.ai/api/mfg/ai-capabilities/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/mfg/ai-capabilitiesCreate a capability
Request body
The record as JSON. Fields marked Yes are required.
| Field | Type | Required | Description |
|---|---|---|---|
provider | text | No | Provider |
model_ref | text | No | Model reference |
autonomy | text | No | What it may do — The most important setting here. "AI-driven" is a spectrum from showing somebody a number to changing a setpoint on a running machine. Allowed: advise recommend approve_then_act act_and_notify |
confidence_floor | numeric | No | Confidence floor — Below this the output is not shown at all rather than shown with a caveat. A capability that publishes its guesses trains people to ignore its findings. |
run_frequency | text | No | Run frequency |
is_enabled | boolean | No | Enabled |
Sample body
{
"provider": "text",
"model_ref": "text",
"autonomy": "advise",
"confidence_floor": "1250.00"
}Response 201
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"capability_key": "text",
"name": "Example",
"blurb": "text",
"category": "text",
"module": "text",
"subject_entity": "text",
"method": "text",
"provider": "text",
"model_ref": "text",
"inputs_summary": "text",
"output_summary": "text",
"autonomy": "advise"
}Sample request
curl -X POST "https://demo.tranxact.ai/api/mfg/ai-capabilities" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"provider":"text","model_ref":"text","autonomy":"advise","confidence_floor":"1250.00"}'PUT/api/mfg/ai-capabilities/{id}Change a capability
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 |
|---|---|---|---|
provider | text | No | Provider |
model_ref | text | No | Model reference |
autonomy | text | No | What it may do — The most important setting here. "AI-driven" is a spectrum from showing somebody a number to changing a setpoint on a running machine. Allowed: advise recommend approve_then_act act_and_notify |
confidence_floor | numeric | No | Confidence floor — Below this the output is not shown at all rather than shown with a caveat. A capability that publishes its guesses trains people to ignore its findings. |
run_frequency | text | No | Run frequency |
is_enabled | boolean | No | Enabled |
Sample body
{
"provider": "text",
"model_ref": "text"
}Response 200
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"capability_key": "text",
"name": "Example",
"blurb": "text",
"category": "text",
"module": "text",
"subject_entity": "text",
"method": "text",
"provider": "text",
"model_ref": "text",
"inputs_summary": "text",
"output_summary": "text",
"autonomy": "advise"
}Sample request
curl -X PUT "https://demo.tranxact.ai/api/mfg/ai-capabilities/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"provider":"text","model_ref":"text"}'DELETE/api/mfg/ai-capabilities/{id}Delete a capability
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/mfg/ai-capabilities/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/mfg/ai-capabilities/{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/mfg/ai-capabilities/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 capability, 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 |
capability_key | text | read only | Capability key |
name | text | read only | Name |
blurb | text | read only | Blurb |
category | text | read only | Category |
module | text | read only | Module |
subject_entity | text | read only | Subject entity |
method | text | read only | Method |
provider | text | read, write | Provider |
model_ref | text | read, write | Model reference |
inputs_summary | text | read only | Inputs summary |
output_summary | text | read only | Output summary |
autonomy | text | read, write | What it may do — The most important setting here. "AI-driven" is a spectrum from showing somebody a number to changing a setpoint on a running machine. Allowed: advise recommend approve_then_act act_and_notify |
confidence_floor | numeric | read, write | Confidence floor — Below this the output is not shown at all rather than shown with a caveat. A capability that publishes its guesses trains people to ignore its findings. |
accuracy_pct | numeric | read only | Accuracy pct |
precision_pct | numeric | read only | Precision pct |
recall_pct | numeric | read only | Recall pct |
predictions_made | integer | read only | Predictions made |
predictions_scored | integer | read only | Predictions scored |
acceptance_pct | numeric | read only | Acceptance pct |
last_run_at | timestamp with time zone | read only | Last run at |
run_frequency | text | read, write | Run frequency |
is_enabled | boolean | read, write | Enabled |
created_at | timestamp with time zone | read only | Created at |
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 |
created_by | uuid | read only | Created by |
updated_at | timestamp with time zone | read only | Updated at |
updated_by | uuid | read only | Updated by |
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 Manufacturing › AI Capabilities 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.