Calls
Exports
A finished plan's files: DXF and SVG for nests, CSV and Excel for loads, labels, and the print packet. Free calls that answer with the file itself.
A finished nest or load offers files. GET /v1/plans/{id}/exports/{format} answers with the file, not JSON around it, so a script can save the body straight to disk. Exports are free calls.
curl https://api.nestsolver.com/v1/plans/0192f0c9-1a2b-7c3d-8e4f-5a6b7c8d9e0f/exports/dxf \
-H "Authorization: Bearer $NESTSOLVER_KEY" \
-o nest.dxf
Formats
format |
Nest | Load | Content |
|---|---|---|---|
dxf |
Yes | Every sheet of the nest as DXF, parts in place, for CAM. Downloads. | |
svg |
Yes | One sheet as SVG. ?sheet=n picks it, from 0. Downloads. |
|
labels |
Yes | Works plan | Part labels for a nest; for a load, pallet labels whose codes open the pallet on the portal. A print page. |
packet |
Yes | Yes | The shop packet: the plan as the shop prints it. A print page. |
csv |
Yes | Every item with its stage, space, loading step and stop, size and place; each space's weight, centre of gravity and axle loads; and what didn't fit, why, and the nearest fix. Downloads. | |
excel |
Yes | The same as csv, as an Excel workbook with Summary, Items, Spaces and Not loaded sheets. Downloads. |
A plan's exports field lists exactly the formats it offers, with their full URLs, so a client need not guess. Jobs and plans shows it.
Answers
| Status | When |
|---|---|
200 |
The file, with its Content-Type and a Content-Disposition naming it: attachment for DXF and SVG, inline for the print pages, which are HTML meant to be opened in a browser and printed. |
403 |
Pallet labels for a workspace below the Works plan. upgrade names it. |
404 |
No such plan, or no such export for it: a load asked for DXF, a sheet number past the last. |
Linear and sheet plans are answered in the solve call itself and have no exports here. Their files (CSV, Excel, DXF, the image, the print page and labels) are made on the web from the plan on screen.
Labels for linear and sheet plans
Every solved linear or sheet plan on the web prints a label for each part and each offcut worth keeping, on every plan.
| Labels | Stock | Barcode |
|---|---|---|
| Avery 5160 | US Letter sheet, 30 labels of 2⅝ × 1 in | QR code |
| Avery L7160 | A4 sheet, 21 labels of 63.5 × 38.1 mm | QR code |
| Dymo 89 × 36 mm | One label a page, for a Dymo label printer | QR code and Code 128 |
| ZPL 4 × 2 in | A file for a Zebra printer at 203 dpi | QR code and Code 128 |
| ZPL 2 × 1 in | A file for a Zebra printer at 203 dpi | QR code |
The label sheets open as a print page; print at 100% scale, not "fit to page". The ZPL files download and go straight to the printer.
The QR code holds a few plain lines: what the piece is, its name, size, material and where it was cut. The Code 128 barcode holds a short code: S2-P3-1 is sheet 2, part row 3, its first copy; B3-P1-2 is bar 3, part row 1, its second copy; S2-O1 and B3-O1 are the first offcut or drop on that sheet or bar.
Saw files for linear and sheet plans
On the Bench plan and up, a solved plan on the web also downloads a file for the saw. Like the other linear and sheet files, they come from the plan on screen, not from the API.
| File | Plan | What it holds | Checked against |
|---|---|---|---|
PTX (.ptx) |
Sheet, panel saw | Parts, boards, materials with the kerf, offcuts, and each pattern's rips, cross cuts and recuts in saw order | The Pattern Exchange File specification V1.12 in Magi-Cut's Interface Guide, the PTX format HOMAG intelliDivide also exports |
Saw stop CSV (.csv) |
Linear | Each bar's cuts in order: quantity, length, left and right angle, label, material | The cut list rules in TigerStop's TigerSaw manual: plain text, one column per field, a length column and two angle columns |
A saw file runs a machine. Before a full job, cut one test board or one test bar from it and measure the parts. Sheet cutting and Linear cutting say how each file reads.
Edge banding in the sheet files
The sheet CSV and Excel files list each part's finished width and height, grain, band, and how many long and short edges are banded. Below the parts, the CSV lists each band type's thickness, edges, length and length with waste; the Excel workbook puts the same on its Edge band sheet, and its Sheets sheet gives each sheet's grain.