Reference API
Základní URL https://api.cutoptim.com · verze kontraktu v1
Klíč si vytvořte na své nástěnce a pak jej posílejte jako Authorization: Bearer <key>.
▶ Vyzkoušejte API živě — bez registracePoužívá veřejný demo klíč — s limitem, jen malé úlohy, nikdy se neúčtuje.
Integrace
NávodyEN
PojmyEN
Endpointy
| Metoda | Cesta | Popis |
|---|---|---|
| POST | /v1/optimize/2d | optimalizace 2D desek |
| POST | /v1/optimize/1d | optimalizace 1D / lineárního materiálu (tyče, profily, trubky) |
| POST | /v1/optimize/wood | optimalizace dřeva — 1D s přiřazením průřezu |
| POST | /v1/optimize/nest | nesting podle skutečného tvaru — nepravidelné polygony na pevných deskách, s vyloučenými zónami (laser / plazma / vodní paprsek) |
| POST | /v1/validate/2d | validace požadavku bez výpočtu — zdarma, bez klíče, bez kvóty (2d / 1d / wood / nest) |
| POST | /v1/validate/1d | validace požadavku bez výpočtu — zdarma, bez klíče, bez kvóty (2d / 1d / wood / nest) |
| POST | /v1/validate/wood | validace požadavku bez výpočtu — zdarma, bez klíče, bez kvóty (2d / 1d / wood / nest) |
| POST | /v1/validate/nest | validace požadavku bez výpočtu — zdarma, bez klíče, bez kvóty (2d / 1d / wood / nest) |
| GET | /v1/jobs/{id} | dotázání na asynchronní úlohu jádra max — vrací její status a po dokončení i plán (bez kvóty; jen vaše vlastní úlohy) |
| POST | /v1/import/nest | načte obrysy dílů ze souboru SVG nebo DXF — vyžaduje klíč, nespotřebovává kvótu |
| GET | /v1/usage | spotřeba a kvóta ÚČTU v aktuálním měsíci |
| GET | /v1/health | kontrola dostupnosti — bez klíče, bez rate limitu, bez databáze |
POST /v1/validate/{2d,1d,wood,nest} — response
The request is well-formed. No solve ran and no quota was spent.
| Pole | Typ | Popis |
|---|---|---|
| valid | boolean | Always true on a 200 — a malformed request is a 400 with the exact bad field path (details.path) instead. The body is the SAME one the matching optimize endpoint takes. |
| mode | "2d" | "1d" | "wood" | "nest" | The endpoint you called. |
| contractVersion | string | Shape version. Currently "1". |
| engineEnabled | boolean | Nest only — whether the nesting engine is built into this deployment. Absent for the rectangular modes. |
| parts | { rows, total } | Part rows sent, and the total quantity after qty expansion. Check it against the part cap before you spend a call. |
| parts.rows | integer | Number of part rows sent. |
| parts.total | integer | Total quantity across all part rows (Σ qty). |
| stock | { rows, total } | The same for stock. |
| stock.rows | integer | Number of stock rows sent. |
| stock.total | integer | Total quantity across all stock rows (Σ qty). |
| warnings | string[] | Approximate, solve-free feasibility notes — e.g. a part that fits no stock (2D and nest: by bounding box; wood: no matching section long enough). Empty ⇒ every part fits some stock. Ignores trim/kerf/material (a shape check, not a solve). |
Specifikace OpenAPI
Strojově čitelný dokument OpenAPI 3.1 popisuje všech dvanáct endpointů, každé tělo požadavku, každou podobu odpovědi a každou chybu. Nasměrujte na něj svůj generátor klienta místo toho, abyste přepisovali tuto stránku. Samotný dokument je jen v angličtině: skládá se z tokenů kontraktu a OpenAPI žádný lokalizační mechanismus nemá.
curl -s https://cutoptim.com/engine/openapi.json > cutoptim-engine.jsonOtevřít dokument OpenAPI 3.1 →
- TypeScript
npm install @cutoptim/engine
GitHub · npm - Python
pip install cutoptim
GitHub · PyPI - PHP
composer require cutoptim/engine
GitHub · Packagist
A two-page summary of the Engine API — the four modes (2D, 1D, wood and true-shape nest), a request and response, determinism and pricing. Print-ready, with a QR back to the docs.