API Endpoint Reference

This reference is generated from the public OpenAPI contract. Each operation lists the API key scope it requires. A key with control also satisfies read. Partner production scopes must be granted exactly.

Printers

OperationEndpoint
List organization printers and loaded filamentGET /v1/printersread
Read an organization printer and loaded filamentGET /v1/printers/{id}read
Record Filament assignments and report saving, delivery, and observed filamentPOST /v1/printers/{id}/material-slots/assigncontrol
List Printer material slots with their Filament assignments and observed filament in one snapshotGET /v1/printers/{id}/material-slotsread
Read one Printer material slot with its Filament assignment and observed filamentGET /v1/printers/{id}/material-slots/{position}read
Read the Filament assignment of a Printer material slot without querying the printerGET /v1/printers/{id}/material-slots/{position}/assignmentread
Delete Filament assignments without sending printer commandsPOST /v1/printers/{id}/material-slots/clear-assignmentscontrol
Request an RFID reread of an AMS Printer material slot without G-codePOST /v1/printers/{id}/material-slots/{position}/refresh-rfidcontrol
Read printer material slots and their source and nozzle layoutGET /v1/printers/{id}/material-slots/layoutread
Read installed nozzle configuration and separate firmware reportsGET /v1/printers/{id}/nozzle-configurationsread
Record an installed nozzle type and diameter in HivePUT /v1/printers/{id}/nozzle-configurations/{targetKey}control
Search organization printers with the web palette matcherGET /v1/printers/searchread
Attest that an operator cleared printer bedsPOST /v1/printers/operator-readycontrol
Assign exact materials and report persistence, delivery, and fresh observationDeprecated. Use Record Filament assignments and report saving, delivery, and observed filament.POST /v1/printers/{id}/filaments/assigncontrol
Read saved and fresh reported state for all printer slots in one snapshotDeprecated. Use List Printer material slots with their Filament assignments and observed filament in one snapshot.GET /v1/printers/{id}/filaments/stateread
Read a saved override and independent fresh tray factsDeprecated. Use Read one Printer material slot with its Filament assignment and observed filament.GET /v1/printers/{id}/filaments/{position}/stateread
Read a saved override without querying the printerDeprecated. Use Read the Filament assignment of a Printer material slot without querying the printer.GET /v1/printers/{id}/filaments/{position}/assignmentread
Delete Hive overrides without sending printer commandsDeprecated. Use Delete Filament assignments without sending printer commands.POST /v1/printers/{id}/filaments/clearcontrol
Delete one Hive override if its saved version is unchanged, without sending printer commandsDeprecated. Use Delete Filament assignments without sending printer commands.POST /v1/printers/{id}/filaments/clear-capturedcontrol
Request an AMS RFID reread without G-codeDeprecated. Use Request an RFID reread of an AMS Printer material slot without G-code.POST /v1/printers/{id}/filaments/{position}/refresh-rfidcontrol

Print Jobs

OperationEndpoint
List organization print jobs in queue orderGET /v1/print-jobsread
Request Stop for one exact active print attemptPOST /v1/print-jobs/{id}/stopdangerous
Recover a Stop receipt using fresh observation without another abortGET /v1/print-jobs/{id}/stops/{receiptId}read
Read job state and the exact current Start Print attemptGET /v1/print-jobs/{id}/control-stateread
Cancel an unclaimed queued print without a printer commandPOST /v1/print-jobs/{id}/cancel-queuedcontrol
Create one print job for one platePOST /v1/print-jobs/createcontrol
Request dispatch of a queued print job to its assigned printerPOST /v1/print-jobs/{id}/startcontrol
Read an organization print jobGET /v1/print-jobs/{id}read
List the organization's creation requests, newest firstGET /v1/print-jobs/create-requestsread
Poll one asynchronous single-plate creation requestGET /v1/print-jobs/create-requests/{requestId}read
Authorize admission of a manually held creation requestPOST /v1/print-jobs/create-requests/{requestId}/releasecontrol
Approve the reported holds of a creation request and re-slicePOST /v1/print-jobs/create-requests/{requestId}/approve-reviewcontrol
Amend a held creation request and plan it againPOST /v1/print-jobs/create-requests/{requestId}/amendcontrol
Send every print request of one project send in one batchPOST /v1/print-jobs/sendscontrol
List the batches that sends of one source version madeGET /v1/print-jobs/sendsread
Read a batch that a send made, with its print requestsGET /v1/print-jobs/batches/{batchId}/requestsread
Release several manually held creation requestsPOST /v1/print-jobs/create-requests/releasecontrol
Retry a failed creation request from its stored inputPOST /v1/print-jobs/create-requests/{requestId}/retrycontrol
Cancel a creation request before job admissionPOST /v1/print-jobs/create-requests/{requestId}/cancelcontrol
Plan which printers can take a plate and what to loadPOST /v1/print-jobs/planread
Make a library project file an inspected print sourcePUT /v1/model-files/{id}/print-sourcecontrol

Materials

OperationEndpoint
Search available catalog filaments with the web pickerGET /v1/filaments/searchread
Upsert an organization catalog filament by partner external idPOST /v1/filament-catalogcontrol
List organization catalog filamentsGET /v1/filament-catalogread
Read an organization catalog filamentGET /v1/filament-catalog/{id}read
List the stock filament profiles a material type can use on a printerGET /v1/filament-profiles/compatibleread

Partner production

OperationEndpoint
Upload an immutable partner sourcePOST /v1/partner-production/uploadsproduction:upload
Read a partner source versionGET /v1/partner-production/uploads/{sourceId}production:read
Find the model bound to a partner external idGET /v1/partner-production/modelsproduction:read
List a model's partner source versionsGET /v1/partner-production/models/{modelId}/filesproduction:read
Create a Slice jobPOST /v1/slice-jobsproduction:upload
Poll a Slice jobGET /v1/slice-jobs/{sliceJobId}production:read
Get a short-lived download URL for a plate of a Slice jobGET /v1/slice-jobs/{sliceJobId}/plates/{plateId}/downloadproduction:read
Prepare plates of partner sources for an exact printerDeprecated. Use Create a Slice job.POST /v1/partner-production/preparationsproduction:upload
Poll a partner preparation requestDeprecated. Use Poll a Slice job.GET /v1/partner-production/preparations/{preparationId}production:read
Get a short-lived download URL for a prepared plateDeprecated. Use Get a short-lived download URL for a plate of a Slice job.GET /v1/partner-production/preparations/{preparationId}/plates/{plateId}/downloadproduction:read

Webhooks

OperationEndpoint
List webhook endpointsGET /v1/webhooksread
Create a webhook endpointPOST /v1/webhookswebhooks:write
Read a webhook endpointGET /v1/webhooks/{id}read
Update a webhook endpointPATCH /v1/webhooks/{id}webhooks:write
Delete a webhook endpointDELETE /v1/webhooks/{id}webhooks:write
List delivery attemptsGET /v1/webhooks/{id}/attemptsread
Send a test eventPOST /v1/webhooks/{id}/testwebhooks:write