API v1 preview
Glossary
Short definitions of the terms used across the API and these guides.
Terms
| Term | Meaning |
|---|---|
| File | An uploaded GLB, OBJ or ZIP. Register it, upload its bytes, then use its ID to create a model. |
| Model | A design you can price and order. Its ID never changes; replacing the file adds a file revision. |
| File revision | The source file a model currently uses: your upload, or a model repair OTTO MFG published for it (1.1 repairs revision 1; file_repair). Rename and resize do not change it. |
| Model status | processing, ready, action_required or failed. ready means it can be priced, quoted and ordered at its saved size. |
| Mesh check | The automatic inspection for inverted normals, bad edges and holes. Defects make Model repair apply. |
| Model repair | Repair work by staff before printing. The server decides when it applies and reports it in the repair object. |
| Price | Manufacturing cost per line for a model, size and quantity. It is an estimate until saved in a quote. |
| Quote | Saved prices and shipping options for an address. Its terms hold for 30 minutes. |
| Shipping option | One carrier service in a quote, with its price and transit estimate. |
| Order | An accepted quote. It starts in awaiting_payment and is confirmed once payment is verified. |
| Hosted Checkout | A payment page your customer opens from next_action.url. |
| Spending authorization | An administrator's consent that lets an API key charge saved cards or start Checkout. |
| Idempotency-Key | A value you save and resend on retry so the server does not create a second resource. |
| Scope | A permission on an API key, such as orders:write. Each endpoint page lists the scope it requires. |
| X-Request-ID | An ID on every response. Include it when you contact support. |
| Webhook event | A signed POST to your endpoint when a model or order changes. Deduplicate on its id. |
API v1 preview