get started

API reference

API Reference

Interactive OpenAPI reference for the SmartCut API. Every endpoint is documented from the Zod schemas the server validates against, so the reference cannot drift from the implementation.

SmartCut exposes two separate HTTP APIs. The optimisation API takes a list of parts and a list of stock and returns a cutting layout, three versions of it are documented below, of which v3 is current. The store API is a different surface entirely, covering materials, stock, quotes and orders for the hosted cut-to-size shop.

All of them authenticate with the same API key, are billed in credits against your plan, and return results either synchronously or through a result webhook if the job is a long one. If you are integrating for the first time, the API guide walks through a complete request before you reach for the reference.

Reference Saw settings explorer Every field of the request's saw object, with allowed values, defaults, and which stock types and cut types each one applies to. Also the rules that resolve contradictory settings instead of rejecting them, and the saw models the platform recognises by name. Paste a saw and see what the API would run.

Looking for the narrative documentation? Browse the docs.