API Endpoint Reference / Printers

Assign exact materials and report persistence, delivery, and fresh observation

Deprecated. Use Record Filament assignments and report saving, delivery, and observed filament (POST /v1/printers/{id}/material-slots/assign) instead. This operation keeps working, and no removal date is set.

POST https://api.printhiv3d.com/v1/printers/{id}/filaments/assign

Operation ID assignPrinterFilaments. Requires the control API key scope.

Requires an organization API key with control scope or an authenticated organization session. Host credentials are rejected, including Host-bound wildcard keys. Legacy unbound wildcard keys are accepted.

Parameters

NameInTypeRequiredDescription
idpathstringYes

Request body

Content type application/json.

FieldTypeRequiredDescription
jobIdnumber | nullNo
syncPolicy"save-only" | "automatic"No
slotsobject[]Yes

Responses

StatusDescription
200Default Response
400Default Response
401Default Response
403Default Response
404Default Response
409Default Response
422Default Response
500Default Response
503Default Response

200 response fields

FieldTypeRequiredDescription
reevaluationsobject[]No
organizationIduuidYes
printerIduuidYes
jobIdnull | numberYes
slotsobject[]Yes

400 response fields

FieldTypeRequiredDescription
errorstringNo
messagestringNo
requestIdstringNo
codestringNo
positionnumberNo
slotsobject[]No
reasonstringNo
reevaluationsobject[]No
holdingJobobjectNo

401 response fields

FieldTypeRequiredDescription
errorstringNo
messagestringNo
requestIdstringNo
codestringNo
positionnumberNo
slotsobject[]No
reasonstringNo
reevaluationsobject[]No
holdingJobobjectNo

403 response fields

FieldTypeRequiredDescription
errorstringNo
messagestringNo
requestIdstringNo
codestringNo
positionnumberNo
slotsobject[]No
reasonstringNo
reevaluationsobject[]No
holdingJobobjectNo

404 response fields

FieldTypeRequiredDescription
errorstringNo
messagestringNo
requestIdstringNo
codestringNo
positionnumberNo
slotsobject[]No
reasonstringNo
reevaluationsobject[]No
holdingJobobjectNo

409 response fields

FieldTypeRequiredDescription
errorstringNo
messagestringNo
requestIdstringNo
codestringNo
positionnumberNo
slotsobject[]No
reasonstringNo
reevaluationsobject[]No
holdingJobobjectNo

422 response fields

FieldTypeRequiredDescription
errorstringNo
messagestringNo
requestIdstringNo
codestringNo
positionnumberNo
slotsobject[]No
reasonstringNo
reevaluationsobject[]No
holdingJobobjectNo

500 response fields

FieldTypeRequiredDescription
errorstringNo
messagestringNo
requestIdstringNo
codestringNo
positionnumberNo
slotsobject[]No
reasonstringNo
reevaluationsobject[]No
holdingJobobjectNo

503 response fields

FieldTypeRequiredDescription
errorstringNo
messagestringNo
requestIdstringNo
codestringNo
positionnumberNo
slotsobject[]No
reasonstringNo
reevaluationsobject[]No
holdingJobobjectNo

Example 200 response

{
  "organizationId": "3b9e4d71-0c2f-4a58-8e6d-91f2a7c4b605",
  "printerId": "7d3f1c2a-5b8e-4f6a-9c1d-2e4b6a8c0f13",
  "jobId": null,
  "reevaluations": [],
  "slots": [
    {
      "position": 0,
      "materialType": "PLA",
      "color": "#FFFFFF",
      "materialId": "9c2e7b4a-1d8f-4a63-8f5b-6e0d3a9c7b21",
      "database": "saved",
      "record": "saved",
      "assignmentRevision": "5f8a2c6e-9d1b-4e73-b4a0-2c7e9f1d6b85",
      "expected": {
        "materialType": "PLA",
        "color": "#FFFFFF",
        "filamentId": "GFA00",
        "settingId": "GFA00"
      },
      "printerSync": {
        "status": "sent"
      },
      "observation": {
        "status": "observed",
        "observedAt": "2026-11-04T18:00:00.000Z",
        "reported": {
          "materialType": "PLA",
          "color": "#FFFFFF",
          "filamentId": "GFA00",
          "settingId": "GFA00"
        }
      }
    }
  ]
}