API Endpoint Reference / Print Jobs

Make a library project file an inspected print source

PUT https://api.printhiv3d.com/v1/model-files/{id}/print-source

Operation ID openPrintSource. Requires the control API key scope.

Idempotent. Copies the library .3mf into the organization's source vault once, then reports its plates, material slots, and machine. The status is `reading` until the worker has inspected the source; repeat the call to read it again. Slots are zero-based. A file that is not a .3mf, or that holds a toolpath, answers 422.

Parameters

NameInTypeRequiredDescription
idpathuuidYes

Responses

StatusDescription
200Default Response
400Invalid file id
401Authentication required
403API key requires control scope
404Library file not found
409Default Response
413Default Response
422Default Response
429Default Response
503Default Response

200 response fields

Send one of these shapes.

Option 1

FieldTypeRequiredDescription
status"reading"Yes
sourceVersionIduuidYes
filenamestringYes
bytesintegerYes

Option 2

FieldTypeRequiredDescription
status"ready"Yes
sourceVersionIduuidYes
filenamestringYes
bytesintegerYes
platesobject[]Yes
slotsobject[]Yes
machineobject | nullYes
printerModelstring | nullYes

Option 3

FieldTypeRequiredDescription
status"failed"Yes
sourceVersionIduuidYes
filenamestringYes
bytesintegerYes
errorobjectYes

400 response fields

FieldTypeRequiredDescription
errorstringNo
messagestringNo
requestIdstringNo

401 response fields

FieldTypeRequiredDescription
errorstringNo
messagestringNo
requestIdstringNo
codestringNo

403 response fields

FieldTypeRequiredDescription
errorstringNo
messagestringNo
requestIdstringNo
codestringNo

404 response fields

FieldTypeRequiredDescription
error"not_found" | "not_a_3mf" | "empty_file" | "has_embedded_gcode" | "upload_too_large" | "upload_capacity_reached" | "library_file_changed" | "idempotency_conflict" | "storage_unavailable" | "database_unavailable"Yes
limitobjectNo

409 response fields

FieldTypeRequiredDescription
error"not_found" | "not_a_3mf" | "empty_file" | "has_embedded_gcode" | "upload_too_large" | "upload_capacity_reached" | "library_file_changed" | "idempotency_conflict" | "storage_unavailable" | "database_unavailable"Yes
limitobjectNo

413 response fields

FieldTypeRequiredDescription
error"not_found" | "not_a_3mf" | "empty_file" | "has_embedded_gcode" | "upload_too_large" | "upload_capacity_reached" | "library_file_changed" | "idempotency_conflict" | "storage_unavailable" | "database_unavailable"Yes
limitobjectNo

422 response fields

FieldTypeRequiredDescription
error"not_found" | "not_a_3mf" | "empty_file" | "has_embedded_gcode" | "upload_too_large" | "upload_capacity_reached" | "library_file_changed" | "idempotency_conflict" | "storage_unavailable" | "database_unavailable"Yes
limitobjectNo

429 response fields

FieldTypeRequiredDescription
error"not_found" | "not_a_3mf" | "empty_file" | "has_embedded_gcode" | "upload_too_large" | "upload_capacity_reached" | "library_file_changed" | "idempotency_conflict" | "storage_unavailable" | "database_unavailable"Yes
limitobjectNo

503 response fields

FieldTypeRequiredDescription
error"not_found" | "not_a_3mf" | "empty_file" | "has_embedded_gcode" | "upload_too_large" | "upload_capacity_reached" | "library_file_changed" | "idempotency_conflict" | "storage_unavailable" | "database_unavailable"Yes
limitobjectNo

Example 200 response

{
  "status": "reading",
  "sourceVersionId": "5f8a2c6e-9d1b-4e73-b4a0-2c7e9f1d6b85",
  "filename": "phone-stand.3mf",
  "bytes": 2483621
}