TRANXACT.AI Help

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.

Type REST6 operationsBase path /api/mfg/ai-capabilitiesPublished as /api/v1/ai-capabilities

Download specification (OpenAPI 3.1) Screen: AI Capabilities

Overview

PackageManufacturing
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 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.
Tablemfg.ai_capabilities · 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/mfg/ai-capabilitiesList ai capabilities

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

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

FieldTypeRequiredDescription
providertextNoProvider
model_reftextNoModel reference
autonomytextNoWhat 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_floornumericNoConfidence 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_frequencytextNoRun frequency
is_enabledbooleanNoEnabled

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

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
providertextNoProvider
model_reftextNoModel reference
autonomytextNoWhat 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_floornumericNoConfidence 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_frequencytextNoRun frequency
is_enabledbooleanNoEnabled

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

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/mfg/ai-capabilities/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/mfg/ai-capabilities/{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/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.

FieldTypeAccessDescription
iduuidread onlyId
org_iduuidread onlyOrg id
org_unit_iduuidread onlyOrg unit id
capability_keytextread onlyCapability key
nametextread onlyName
blurbtextread onlyBlurb
categorytextread onlyCategory
moduletextread onlyModule
subject_entitytextread onlySubject entity
methodtextread onlyMethod
providertextread, writeProvider
model_reftextread, writeModel reference
inputs_summarytextread onlyInputs summary
output_summarytextread onlyOutput summary
autonomytextread, writeWhat 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_floornumericread, writeConfidence 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_pctnumericread onlyAccuracy pct
precision_pctnumericread onlyPrecision pct
recall_pctnumericread onlyRecall pct
predictions_madeintegerread onlyPredictions made
predictions_scoredintegerread onlyPredictions scored
acceptance_pctnumericread onlyAcceptance pct
last_run_attimestamp with time zoneread onlyLast run at
run_frequencytextread, writeRun frequency
is_enabledbooleanread, writeEnabled
created_attimestamp with time zoneread onlyCreated at
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
created_byuuidread onlyCreated by
updated_attimestamp with time zoneread onlyUpdated at
updated_byuuidread onlyUpdated by

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 Manufacturing › AI Capabilities 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.