Toolpath Engine API
Public REST API for Toolpath engine operations.
Early access. Machining plans and toolpath calculation — creating, listing, and reading
plans, calculating toolpaths, and reading toolpath results and machining time — are available
now but still gaining functionality; planned additions include plan constraints and specifying
material and stock, among others. Breaking changes still follow the API major version, so you
can build against them today. These operations are grouped under the Plans and Toolpaths
tags and marked x-toolpath-experimental.
Units. All dimensional values — in parts and in feature details — are in
millimetres; all angles are in degrees. Each part response also states this in its units field.
Browser use. CORS is per API key: a request only receives an
Access-Control-Allow-Origin header when its Origin is in the allowlist configured on the
key used (set when creating or editing the key in the portal). A key with no allowed origins
is server-to-server only. A Bearer API key placed in client-side JavaScript is readable by
anyone — restrict its origins, prefer a key granted read access only (writes made with it
are rejected with 403 read_only_key), or proxy requests through your own server.
Access and billing. An API key is granted read and write access separately in each area
of the API — the core API (uploads, part display, holders, and jobs), DFM (part analysis,
feature datasheets, and plans), and Quoting (toolpaths and machining time) — and that access
can be edited on an existing key in the portal. Every operation states its area in its
x-toolpath-product field (core, dfm, or quoting) and whether the call is billed in
x-toolpath-metered. Reads are free but still belong to their product: reading a plan needs
DFM access, and reading toolpaths needs Quoting. GET reads; every other method writes. A key
with no access to the operation’s area is refused with 403 product_mismatch; one with read
access used for a write is refused with 403 read_only_key.
Authentication
- HTTP: Bearer Auth
A Toolpath API key supplied as a Bearer credential.
Security Scheme Type: | http |
|---|---|
HTTP Authorization Scheme: | bearer |