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
| Name | In | Type | Required | Description |
|---|
id | path | uuid | Yes | |
Responses
| Status | Description |
|---|
200 | Default Response |
400 | Invalid file id |
401 | Authentication required |
403 | API key requires control scope |
404 | Library file not found |
409 | Default Response |
413 | Default Response |
422 | Default Response |
429 | Default Response |
503 | Default Response |
200 response fields
Send one of these shapes.
Option 1
| Field | Type | Required | Description |
|---|
status | "reading" | Yes | |
sourceVersionId | uuid | Yes | |
filename | string | Yes | |
bytes | integer | Yes | |
Option 2
| Field | Type | Required | Description |
|---|
status | "ready" | Yes | |
sourceVersionId | uuid | Yes | |
filename | string | Yes | |
bytes | integer | Yes | |
plates | object[] | Yes | |
slots | object[] | Yes | |
machine | object | null | Yes | |
printerModel | string | null | Yes | |
Option 3
| Field | Type | Required | Description |
|---|
status | "failed" | Yes | |
sourceVersionId | uuid | Yes | |
filename | string | Yes | |
bytes | integer | Yes | |
error | object | Yes | |
400 response fields
| Field | Type | Required | Description |
|---|
error | string | No | |
message | string | No | |
requestId | string | No | |
401 response fields
| Field | Type | Required | Description |
|---|
error | string | No | |
message | string | No | |
requestId | string | No | |
code | string | No | |
403 response fields
| Field | Type | Required | Description |
|---|
error | string | No | |
message | string | No | |
requestId | string | No | |
code | string | No | |
404 response fields
| Field | Type | Required | Description |
|---|
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 | |
limit | object | No | |
409 response fields
| Field | Type | Required | Description |
|---|
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 | |
limit | object | No | |
413 response fields
| Field | Type | Required | Description |
|---|
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 | |
limit | object | No | |
422 response fields
| Field | Type | Required | Description |
|---|
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 | |
limit | object | No | |
429 response fields
| Field | Type | Required | Description |
|---|
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 | |
limit | object | No | |
503 response fields
| Field | Type | Required | Description |
|---|
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 | |
limit | object | No | |
Example 200 response
{
"status": "reading",
"sourceVersionId": "5f8a2c6e-9d1b-4e73-b4a0-2c7e9f1d6b85",
"filename": "phone-stand.3mf",
"bytes": 2483621
}