TRANXACT.AI Help

Manufacturing · Manufacturing Intelligence

Vision Inspections

Surface and dimensional defects found by camera, with the sampled human verdict beside them. The disagreement rate — not the accuracy figure — is what decides whether a camera may act on its own.

Type REST8 operationsBase path /api/mfg/vision-inspectionsPublished as /api/v1/vision-inspections

Download specification (OpenAPI 3.1) Screen: Vision Inspections

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 › Vision Inspections 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.vision_inspections · 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

8 operations. Open one for its parameters, bodies, responses and a sample request.

GET/api/mfg/vision-inspectionsList vision inspections

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",
      "device_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "equipment_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "work_center_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "production_order_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "batch_record_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "item_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "lot_no": "LOT-000001",
      "serial_no": "SER-000001",
      "inspected_at": "2026-10-30T09:00:00Z",
      "model_ref": "text",
      "model_version": "text",
      "image_content_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
    }
  ],
  "count": 1
}

Sample request

curl "https://demo.tranxact.ai/api/mfg/vision-inspections?limit=20" \
  -H "Authorization: Bearer $TOKEN"
GET/api/mfg/vision-inspections/{id}Read one vision inspection

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",
  "device_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "equipment_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "work_center_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "production_order_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "batch_record_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "item_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "lot_no": "LOT-000001",
  "serial_no": "SER-000001",
  "inspected_at": "2026-10-30T09:00:00Z",
  "model_ref": "text",
  "model_version": "text",
  "image_content_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/mfg/vision-inspections/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/mfg/vision-inspectionsPost vision inspections

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/mfg/vision-inspections" \
  -H "Authorization: Bearer $TOKEN"
POST/api/mfg/vision-inspections/{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/vision-inspections/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/copy" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"overrides":"value","preview":"value","withLines":"value"}'
PUT/api/mfg/vision-inspections/{id}Put vision inspections

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/mfg/vision-inspections/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
DELETE/api/mfg/vision-inspections/{id}Delete vision inspections

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

Request body

The keys this action reads (* = required; "one of" lists the only values):

verdict, confidence, deviceId, equipmentId, workCenterId, productionOrderId, batchRecordId, itemId, lotNo, serialNo, modelRef, modelVersion, imageContentId, imageRef; verdict one of pass|fail|review|no_read; findings: [{ defect }]

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/vision-inspections/record" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"verdict":"value","confidence":"value","deviceId":"value","equipmentId":"value","workCenterId":"value","productionOrderId":"value"}'
POST/api/mfg/vision-inspections/{id}/checkCheck

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

verdict; verdict one of pass|fail|review|no_read

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/vision-inspections/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/check" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"verdict;":"value"}'

Data model

Every field of a vision inspection, 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
device_iduuidread onlyDevice id
equipment_iduuidread onlyEquipment id
work_center_iduuidread onlyWork center id
production_order_iduuidread onlyProduction order id
batch_record_iduuidread onlyBatch record id
item_iduuidread onlyItem id
lot_notextread onlyLot no
serial_notextread onlySerial no
inspected_attimestamp with time zoneread onlyInspected at
model_reftextread onlyModel ref
model_versiontextread onlyModel version
image_content_iduuidread onlyImage content id
image_reftextread onlyImage ref
findingsjsonbread onlyFindings
defect_countintegerread onlyDefect count
verdicttextread onlyVerdict
confidencenumericread onlyConfidence
human_verdicttextread onlyHuman verdict
human_checked_byuuidread onlyHuman checked by
human_checked_attimestamp with time zoneread onlyHuman checked at
agreementtextread onlyAgreement
inspection_iduuidread onlyInspection id
nonconformance_iduuidread onlyNonconformance id
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 › Vision Inspections 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.