Concepts and lifecycle
Understand files, models, inspection, quotes and orders.
From file to order
- File: register metadata, upload the bytes, then keep the file ID.
- Model: create a design from that file and its default size. Its ID is permanent.
- Inspection: poll the model for progress, findings and measurements.
- Prices: request manufacturing prices for model IDs, sizes and quantities.
- Quote: add a shipping address to save prices and shipping options for 30 minutes.
- Order: accept one quote option, then start payment. Accepted terms remain fixed.
Inspection progress
Progress flow
text
queued → preparing → inspecting → inspection_completed
Any active stage can end in failed.| progress.stage | Meaning | Client action |
|---|---|---|
| queued | Waiting to start | Keep polling the same model. |
| preparing | Reading and preparing the model | Keep polling. |
| inspecting | Checking the geometry | Keep polling. |
| resizing | Updating a saved size; previous checks are cleared | Wait for fresh mesh inspection, measurements and printability before requesting a new quote. |
| inspection_completed | Inspection finished; defects may be present | Read mesh_check.result; request prices when volume is available. |
| failed | Processing could not finish | Read mesh_check.error and follow recovery guidance. |
Poll until status is no longer processing, or subscribe to model.ready. ready means CalculatePrices, quotes and orders accept the model at its saved size, including any required Model repair price. status_reasons explains processing, action_required and failed. progress.stage adds inspection detail. manufacturing_estimate is a provisional default-size price that excludes repair, shipping and tax.
Identity and snapshots
Model IDs do not change. Replace a model file to append an immutable file revision under the same ID. Rename and resize change current settings without incrementing file_revision. Creating a separate model is still available for a separate design.
Each price or quote item selects its own longest_dimension_mm and quantity without modifying the saved model. PATCH changes the saved size and refreshes its measurements and printability. With print-risk policies enabled, price at the assessed size; resize and wait for a new assessment first.
A quote snapshots the selected configuration, address and prices. An order accepts those terms. Later price calculations or model updates do not rewrite an accepted order.
ID formats
Treat IDs as opaque, case-sensitive references and reuse them exactly. They do not grant access. These are the current formats.
| Resource | Format |
|---|---|
| Model | MD- followed by eight uppercase Crockford Base32 characters |
| Order | OM- followed by eight uppercase Crockford Base32 characters |
| File | file_ followed by 32 hexadecimal characters |
| Quote | quote_ followed by 32 hexadecimal characters |
| Shipping option | shipopt_ followed by 32 hexadecimal characters; scoped to its quote |
| Payment method | Provider-owned opaque ID returned by List payment methods |
| Event | evt_ followed by 32 hexadecimal characters |
API v1 preview