Skip to content
Docs
Sign in

Equipment API

Cutters, printers, presses, platemakers, guillotines, finishing machines, tools, die imports and rate cards: list, create, update, archive and test estimates.

For integrators

The equipment API manages the same printers and cutting machines as Equipment in the app. Estimates and imposition solutions take their print and cut times, costs and cut-file formats from them. All calls are team-scoped under /a/<team_slug>/production/api/v1/ and need an API key (see the API overview).

Machines and printers work the same way, so this page describes them together. Sizes are in millimetres, speeds in mm/s and m²/h; test cuts and test prints take their part sizes in inches (see Units and measurements). The API reference lists every field; Printers and Cutting machines explain what they do.

List, read and change#

GET /a/{team_slug}/production/api/v1/machines/

production_machines_list · View in API reference

GET /a/{team_slug}/production/api/v1/printers/

production_printers_list · View in API reference

Lists return the active machines or printers as a plain array; add ?include_inactive=1 to include archived ones.

POST /a/{team_slug}/production/api/v1/machines/

production_machines_create · View in API reference

PATCH /a/{team_slug}/production/api/v1/machines/{id}/

production_machines_partial_update · View in API reference

DELETE /a/{team_slug}/production/api/v1/machines/{id}/

Archives the machine.

production_machines_archive · View in API reference

  • Deleting archives. DELETE archives the machine or printer instead of removing it, so estimates and imposition solutions that refer to it keep working. Restore it with PATCH {"is_active": true}. Archiving the default hands the default to the next active one, by name.
  • Checks. A machine's default_cut_speed_mm_s can't exceed its max_speed_mm_s. A printer needs at least one entry in modes ([{"name", "speed_m2_h", "passes"}]); default_mode must name one of them (blank means the first). A roll printer never keeps a max_print_length_mm.

The printer endpoints have the same shape: production_printers_create, production_printers_retrieve, production_printers_partial_update and production_printers_archive.

Cut sequences#

Upload a cut file, get the order as written and an optimised order timed on a cutter, and download or save the optimised file: production_cut_sequences_upload, production_cut_sequences_analyse, production_cut_sequences_export and production_cut_sequences_save. These four calls are free on every plan, with an API key too. Cut sequence optimiser walks through them with their requests and responses.

For one request that processes a file without retaining it, use production_cut_sequences_analyse_upload. Cutting time without retaining files explains the multipart upload, team mapping defaults, unlimited file byte size and result.

Start from a preset#

Presets hold manufacturers' published specifications plus estimated starting values for everything a spec sheet doesn't give.

GET /a/{team_slug}/production/api/v1/machines/presets/

Machine presets grouped by manufacturer: published specs, sources, confidence and defaults.

production_machines_presets · View in API reference

GET /a/{team_slug}/production/api/v1/printers/presets/

Printer presets grouped by manufacturer: published modes, sources, confidence and defaults.

production_printers_presets · View in API reference

Both return {"manufacturers": [{"name", "machines": [...]}]}. Each entry has its specifications, the defaults a new machine or printer gets, and estimated_fields, the values that are estimates rather than published figures. Machine presets also carry tool_speed_guidance.

POST /a/{team_slug}/production/api/v1/machines/from-preset/

Create a machine from a preset (published specs plus estimated practical defaults).

production_machines_from_preset · View in API reference

POST /a/{team_slug}/production/api/v1/printers/from-preset/

Create a printer from a preset (published modes plus estimated overheads; prices 0).

production_printers_from_preset · View in API reference

curl -sS -X POST -H "Authorization: Api-Key $API_KEY" -H "Content-Type: application/json" \
  "https://app.example.com/a/acme/production/api/v1/machines/from-preset/" \
  -d '{"preset_key": "<a key from presets/>", "name": "Cutter 1"}'

name is optional. An unknown preset_key answers 400. Printers created from a preset start with prices at 0, so set your rates before they add to quotes.

The team default#

New material groups in estimates use the team's default machine and printer.

POST /a/{team_slug}/production/api/v1/machines/{id}/set-default/

Make this the team's default machine (new material groups use it).

production_machines_set_default · View in API reference

POST /a/{team_slug}/production/api/v1/printers/{id}/set-default/

Make this the team's default printer.

production_printers_set_default · View in API reference

An archived machine or printer can't be the default (400): restore it first.

Test cuts and calibration#

POST /a/{team_slug}/production/api/v1/machines/{id}/simulate/

Test cut: identical parts in a grid on the bed; returns the full time breakdown and price.

production_machines_simulate · View in API reference

A test cut lays identical parts out in a grid on the machine's bed and returns the full time breakdown and the price:

{"shape": "rect", "width_in": 4, "height_in": 6, "quantity": 50, "spacing_in": 0.25, "profile": "material:7"}
Field Values
shape rect (default), circle or polygon
width_in, height_in Required for rect and circle: 0.01 to 1,200 in
points Required for polygon: 3 to 500 [x, y] points in inches
quantity 1 to 500 (default 1)
spacing_in 0 to 12 in (default 0.25)
profile Optional cut settings to use, such as material:7 for an estimating material's settings
POST /a/{team_slug}/production/api/v1/machines/{id}/calibrate/

Suggest an efficiency factor from a timed job: (measured − fixed overheads) / estimated motion seconds, clamped to 0.2–5.

production_machines_calibrate · View in API reference

Time a real job on the machine and send the same body plus measured_seconds (1 second to 7 days). The answer suggests an efficiency factor: the measured time minus the fixed overheads, divided by the estimated motion time, kept between 0.2 and 5. If you agree, save it with PATCH {"efficiency_factor": …} on the machine.

POST /a/{team_slug}/production/api/v1/printers/{id}/simulate/

Test print: time (setup, printing, sheet handling), cost and price incl.

production_printers_simulate · View in API reference

Send either area_m2, or width_in × height_in × quantity (1 to 500), plus sheets (1 to 10,000) and a print mode (blank for the printer's default mode). The answer gives the time (setup, printing, sheet handling), the cost and the price including ink.

Presses and guillotines#

Presses (offset, digital and label presses) and guillotines have the same list, create, read, update, archive and set-default endpoints under presses/ and guillotines/. A press's default is per group: one for offset, one for digital cut-sheet and one for label presses (digital, feed web).

POST /a/{team_slug}/production/api/v1/presses/

production_presses_create · View in API reference

GET /a/{team_slug}/production/api/v1/presses/presets/

Press presets grouped by manufacturer: configuration, every value with its source and confidence (H maker, M secondary, L unverified, D derived, G generic) and the starting values.

production_presses_presets · View in API reference

POST /a/{team_slug}/production/api/v1/presses/from-preset/

Create a press from a preset (sourced values only; unverified values and costs left empty).

production_presses_from_preset · View in API reference

  • Typed settings. coaters is a list of {"side": "front"|"back"|"both", "types": ["aqueous", "uv"], "flood_only"} (at most 4); special_stations a list of {"index", "loaded", "allowed", "layers"} (at most 3, loaded one of allowed when that is set); nonprintable is {"lead", "trail", "left", "right"} in mm; fixed_inks and house_inks are ink keys such as process:cyan or pantone:185-c.
  • Checks. A perfecting press needs perfect_after_unit from 1 to units − 1, and only offset presses perfect. With ink_system uv or led_uv the dry time between passes is always 0. Only offset keeps cut_off_mm and web_folder.
  • Label presses. A digital press with feed web keeps label_frame ("max", "endless" or ""), max_frame_length_mm (with "max" only, and required then), max_print_width_mm and max_lanes (1 to 100); every other press keeps none of them. web_speed_m_min, web_speed_extra_m_min, speed_per_separation, makeready_m, label_charge (frame, metre or coverage), click_cost_per_m, ink_cost_per_m2 and special_ink_cost_per_m2 price its runs (see Presses: offset, digital and label presses).
  • Presets. Every value carries {"value", "source", "confidence"}: H the maker's own data, M a secondary source, D derived (with derived_from), G a generic configuration, L unverified. L values are listed in unverified and never copied. A press created from a preset keeps preset_sources.
POST /a/{team_slug}/production/api/v1/presses/{id}/simulate/

Test estimate: makeready, running and wash-up time, plates, impressions, cost and price.

production_presses_simulate · View in API reference

Send forms (1 to 12) identical forms of sheets sheets each; for offset add passes, plates per form (empty counts CMYK per side), custom_inks and wash_ups; for digital sides and mono. The answer's print object gives makeready, running and wash-up time, plates, impressions, cost and price. On an offset press the answer also has plate_source ({"kind", "label", "platemaker_name"}: who prices this press's plates) and plates_included: the plate money is in print only when the press itself prices the plates (kind press); when a platemaker does, print counts the plates but carries no plate money. On a label press send frames, frame_length_mm (default its max frame), separations and specials (and optionally print_width_mm) instead: print has kind label, the frames, clicks, web and substrate, speed, time, click and ink money, cost and price.

POST /a/{team_slug}/production/api/v1/guillotines/{id}/simulate/

Test cut: setup, jogging and knife time for piles of sheets at a number of strokes per lift.

production_guillotines_simulate · View in API reference

Send forms, sheets per form and strokes per lift. The answer's cut object gives setup, jogging and knife time, lifts, strokes, cost and price.

Platemakers#

Platemakers (offset platesetters and flexo plate lines) have the same list, create, read, update, archive and set-default endpoints under platemakers/. The default is per kind: one offset_ctp, one flexo. kind is set on create and can't be changed (a different kind on update answers 400). See Platemaking: offset CTP and flexo plate lines for what each field does.

POST /a/{team_slug}/production/api/v1/platemakers/

production_platemakers_create · View in API reference

  • Money is a number, null when not set: a blank plate_price or consumable_price charges the cost; 0 means included elsewhere. material_from press takes the plate material from the press's plate_cost (its basis is then always plate); a flexo platemaker always works per m2 with its own plate material.
  • Checks. technology and processing must belong to the kind; give both max_plate_w_mm and max_plate_h_mm or neither; plate_formats is a list of at most 12 {"name", "w_mm", "h_mm"} within the maximum. speed_unit (plates_h or m2_h) and rated are read-only.

Example request body: {"name": "Platesetter A", "kind": "offset_ctp", "speed": 30, "setup_min": 5, "handling_min_per_plate": 0.5, "hourly_cost": 60, "hourly_rate": 90, "minimum_charge": 25, "plate_cost": 8, "plate_price": 10, "consumable_cost": 0.5, "consumable_price": 0.75, "remake_pct": 5} (test rates).

GET /a/{team_slug}/production/api/v1/platemakers/presets/

Platemaker presets grouped by kind: what the platemaker is (kind, technology, maximum plate size), each value with its source and confidence, and the maker's rated maximum as a hint.

production_platemakers_presets · View in API reference

POST /a/{team_slug}/production/api/v1/platemakers/from-preset/

Create a platemaker from a preset (technical facts only; speed, times and money empty).

production_platemakers_from_preset · View in API reference

Presets return {"kinds": [{"kind", "platemakers": [...]}]} (?kind= keeps one kind). They set the kind, technology and plate size only; rated holds a maker's rated maximum, which a platemaker created from the preset keeps in preset_sources.rated as a hint.

POST /a/{team_slug}/production/api/v1/platemakers/{id}/simulate/

Test estimate with the saved settings: setup, run and wait time, machine, material and consumable cost and price, the average per plate (above the minimum only), whether the plates are priced, and notes.

production_platemakers_simulate · View in API reference

Send plates (0 to 10,000), and either plate_w_mm with plate_h_mm or area_m2 (the area of one plate), and press (an offset press: its plate cost, and its entered plate size when none is sent). A per-m² platemaker needs a plate size or area_m2, and one taking its plate material from the press needs press; otherwise the answer is 400 with the field. The answer gives plates, made, area_each_m2, setup_s, run_s, total_s, wait_s, the machine, material and consumable *_cost and *_price, cost, price, avg_price (null when the minimum applies), priced, material_priced and notes (such as plates.no_speed or plates.no_area). For the example above, 16 plates give cost 189.8, price 251.1 and avg_price 15.69.

Presses also carry plate_w_mm and plate_h_mm, the plate the press takes: platemakers check it fits, and per-m² plate costs need it.

Finishing machines#

Finishing machines (die-cutters, folder-gluers, flexo folder-gluers, folders, laminators…) have the same list, create, read, update, archive and set-default endpoints under finishing-machines/. The default is per kind: one die-cutter, one folder-gluer and so on. See Finishing machines for what each field does.

POST /a/{team_slug}/production/api/v1/finishing-machines/

production_finishing_machines_create · View in API reference

  • config holds the kind's own settings: a die-cutter's type (platen or rotary, required), stripping, blanking, stripping_setup_min, print_stations, sheet_trim_mm, min_sheet_mm / max_sheet_mm as [width, height]; a folder-gluer's classes ({"straight_line": {}, "crash_lock": {"setup_min": 45, "speed_factor": 0.7}}: a glue style that is absent is not supported) and blank limits; an FFG's stations (required) and setup_min_per_colour; a folder's schemes (a speed factor per fold); a window patcher's speed_by_blank_length ([[longest blank mm, pieces per hour], …], shortest first); a laminator's adhesive_cost_per_m2 and adhesive_price_per_m2. Unknown keys are refused, with the message under config.<key>. Changing kind needs a config valid for the new kind.
  • Stripping (die-cutters, see Pin-matrix stripping): stripping_method is none, dedicated or pin_matrix (a rotary die-cutter takes only none or dedicated). Without it, stripping: true reads as dedicated and false as none; with it, stripping is stored as stripping_method != "none", and stripping: false with another method is refused. Every platen die-cutter takes gripper_margin_mm, strip_min_skeleton_bar_mm, strip_allow_common_cut, strip_die_lead_mm (at least the gripper margin), strip_operator_side (os_left or os_right), strip_hand_min_per_k, strip_hand_cost_hr and strip_hand_rate_hr. A pin matrix adds pin_grid_pitch_mm ([x, y]; empty for free positions), pin_grid_pattern (square or staggered, which needs a pitch), pin_grid_origin_x_mm, pin_grid_origin_y_mm, pin_area_mm ([width, height], within max_sheet_mm), pin_needle_mm, pin_clearance_mm, pin_lower_tool (top_only or paired_pins, which needs pin_lower_body_mm), pin_lower_head_mm, pin_two_pins_over_mm, pin_bars_max (whole, free positions only, with pin_bar_reach_mm), pin_fit_new_dies, pin_female_board (per_die or not_needed), pin_setup_min, pin_setup_min_per_pin, pin_setup_min_per_bar, strip_falls_through_mm, strip_nick_to_skeleton_mm, strip_chip_mm2, strip_breaker_over_mm, strip_front_waste (front_grippers or front_separator) and strip_rear_waste (rear_machine or rear_pins). Lengths are in mm. A rotary die-cutter refuses every stripping key but the method.
  • degrade_rules (speed factors, at most 12): {"fact", "op", "value", "speed_factor", "setup_add_min"} with fact one of caliper_in, blank_length_in, pages, thickness_in, gluer, colours; op one of >, >=, <, <=, ==; gluer is compared with == to a glue style.
  • speed empty means not set; speed_unit m_per_min is only for folder-gluers, FFGs and label finishers.
GET /a/{team_slug}/production/api/v1/finishing-machines/presets/

Finishing machine presets grouped by kind: what the machine is (kind, glue styles, print stations, speed unit), each value with its source and confidence, and the maker's rated maximum as a hint.

production_finishing_machines_presets · View in API reference

POST /a/{team_slug}/production/api/v1/finishing-machines/from-preset/

Create a finishing machine from a preset (technical settings only; rates, times and speed empty).

production_finishing_machines_from_preset · View in API reference

Presets return {"kinds": [{"kind", "machines": [...]}]}. They set the kind, the speed unit and technical settings only; rated holds a maker's rated maximum, which a machine created from the preset keeps in preset_sources.rated as a hint. Costs, setup minutes, waste and the planning speed are never in a preset.

POST /a/{team_slug}/production/api/v1/finishing-machines/{id}/simulate/

Test estimate: pieces in, setup and run time, cost and price for a number of good pieces, with the saved settings, speed factors and the kind's own settings.

production_finishing_machines_simulate · View in API reference

Send out (good pieces), optionally setup_key_runs (1 or more: the same setup already ran, so the changeover time applies), feed_in (required for machines in m/min: the piece's length along the feed) and facts (scheme, gluer, colours, stripping, caliper_in, blank_length_in, pages, thickness_in, and on a pin-matrix die-cutter pins and bars, the stripping pins and pin bars of one die mount). The answer's step gives units_in, setup_s, run_s, total_s, cost, price and notes (such as speed_unset or degrade_fact_unknown:<fact>).

Tools and rate cards#

GET /a/{team_slug}/production/api/v1/tools/

production_tools_list · View in API reference

POST /a/{team_slug}/production/api/v1/tools/

production_tools_create · View in API reference

Tools (dies, plates, blocks, cylinders and companions) are listed, created, read, updated and archived under tools/; filter the list with tool_type, status and has_layout. A number must be unique in the team. match_key is read-only: it is derived from a box die's dieline, ups and sheet size, or a label die's shape, size, layout and teeth. A die also carries:

  • its layout: stations (the station layout, version 1, in mm: kinds, stations with i, kind, x, y, angle, mirrored, the grid, the die rule, board, sheet and die_to_sheet), board_w_in, board_h_in, grain, the whole die's rule (rule_cut_in, rule_crease_in, rule_perf_in, rule_score_in, rule_partial_in, common_line_in), nicks, waste_pieces, stripping, blanking, cut_kind and the read-only source_file_version, kinds (key, design, mirrored, count), ups_total and has_layout. A patched stations must keep each kind's station count; a tool without kinds gets its stations from a die import.
  • its links: companion_of (the die a counter, stripper, blanker, female stripping board or lower pin unit goes with; tool_type female_board and lower_pin_unit are companions) and mountable_on (die-cutter ids).
  • its stored waste, on GET …/tools/{id}/ only (the list leaves it out): waste (read-only; null until a die import stores it): v, shapes (each distinct waste piece's ring, in mm), pieces (id, shape, at, reason, bounded) and overrides ({piece id: grade}). A PATCH that changes stations clears the shapes and pieces, keeps the overrides and adds stale: true, so the die is checked from its stations (notice waste_stale) until its file is attached again.
  • its lifecycle and ownership: status (on_hand, ordered, repair, retired), ready_at, ordered_at, vendor, po_number, life_impressions, life_left (read-only), last_used_at, history (at most 200 entries of date, kind — rerule, resharpen, repair or note — cost, impressions, note), owner and exclusive.
GET /a/{team_slug}/production/api/v1/tools/{id}/layout.svg/

The die's stations drawn from its single-ups (404 without a station layout).

production_tools_layout_svg · View in API reference

GET /a/{team_slug}/production/api/v1/tools/{id}/export/

The die's station drawing as a cut file.

production_tools_export · View in API reference

tools/{id}/layout.svg/ draws the die's stations; tools/{id}/export/?format=cf2|dxf|pdf downloads them as a cut file.

GET /a/{team_slug}/production/api/v1/tools/{id}/stripping/

The die checked on a pin-matrix die-cutter: the stripping block without money (grades, pins, notices, piece shapes).

production_tools_stripping · View in API reference

PATCH /a/{team_slug}/production/api/v1/tools/{id}/waste-overrides/

Set the grade of stored waste pieces: {piece_id: stays_with_skeleton | falls_through | hand | stripping_tool | null}.

production_tools_waste_overrides · View in API reference

tools/{id}/stripping/?die_cutter= checks the die on a pin-matrix die-cutter (optional when the die mounts on only one) and answers its stripping block without money: pieces, chips, by_grade, pins, bars, openings, with_breakers, thin_min_mm, in_gripper, estimated, notices, pins_machine_mm ([x, y, piece], x from the centre line and y from the lead edge, mm), detail (a stored piece's ref.id is its key for overrides) and shapes (see Imposition API). With more than one pin-matrix die-cutter the die mounts on, name one, or the answer is 400. PATCH tools/{id}/waste-overrides/ takes {piece id: "stays_with_skeleton" | "falls_through" | "hand" | "stripping_tool" | null} (null removes a mark) and answers {"overrides": …}; the marks stay with the die.

POST /a/{team_slug}/production/api/v1/tool-rates/

Create or replace the fields sent of the team's rate card for `tool_type` (200 when it existed).

production_tool_rates_upsert · View in API reference

tool-rates/ lists the team's rate cards; POST with a tool_type creates that card (201) or updates the fields you send (200). Rule rates are stored in rule_unit (in or mm) and the area rate in area_unit (in2 or cm2), as sent. See Tools and dies for the formulas and the fields per_up_cost, cad_cost, matrix_cost_per_in, partial_cut_cost_per_in, score_cost_per_in, nick_cost, shipping_cost, minimum_cost, rush_pct, rerule_cost_per_in, wear_cost_per_1000 and board_margin_in. The steel-rule card's female_board_cost, female_board_per_opening and lower_pin_unit_cost price pin-matrix stripping (Pin-matrix stripping): a number, or null for not priced (0 means included).

Die imports#

POST /a/{team_slug}/production/api/v1/die-imports/

Upload a CF2, DXF or PDF die (or name a Files version) and get its preview: ups, kinds, grid, rule, issues and matches.

production_die_imports_create · View in API reference

Post a CF2, DXF or PDF die as file (multipart), or name a Files version with file_version; add format, units (mm or in), mirror (drawn from the die side), mapping ({source key: line kind} over your default profile), overrides ({piece id: "up" | "waste" | "split"}), page (a PDF page, from 0) and tool (the tool a file is attached to). The file is stored in Files first. The answer is the preview: token, file_version, format, units, units_source, board_mm, pages, issues (code, message, detail), sources (each source key with its kind, count and length_mm), ups, grid, rule, waste_pieces, frame, pieces, kinds (per shape: count, measures, svg, existing_design, near_designs, matches with exact and near dies, mirror_of), stations, near_misses, preview_svg and die_cost_estimate. A blocking issue answers 400 with issues, token, file_version, pages, format and sources (the line-type rows when the drawing was read, so a die with no known knife can be mapped): post again with the missing units or mapping. A large file answers 202 with a token; poll die-imports/{token}/ (a token of another team's file answers 404).

GET /a/{team_slug}/production/api/v1/die-imports/{token}/

production_die_imports_retrieve · View in API reference

POST /a/{team_slug}/production/api/v1/die-imports/{token}/save/

Save the single-ups and optionally the die as a tool (or attach the file to a tool).

production_die_imports_save · View in API reference

die-imports/{token}/save/ saves it: kinds (per shape key, name, family, facts, listed, and use_design to link an existing single-up, new to keep a copy anyway, distinct_from for near duplicates kept apart), tool ({"id": …} attaches the file to that tool; {"create": true, "tool_type", "number", "name", "status", "ready_at", "owner", "customer_name", "exclusive", "sheet_w_in", "sheet_h_in", "die_to_sheet": {"mode": "centre" | "lead", "lead_mm"}, "grain", "stripping", "blanking", "mountable_on"} adds a die), remember_mapping and confirm (a different number of ups than the tool's answers 409 with code ups_changed until confirmed). The answer is 201 with file_version, designs, tool and file_error (null, or Files' error when the file couldn't be moved into the die's folder: the rows are saved and the file stays in Die imports). tool.id must be an active die with stations (400 otherwise). See Importing dies.

Single-up dielines and profiles#

GET /a/{team_slug}/production/api/v1/die-designs/

production_die_designs_list · View in API reference

die-designs/ lists single-up dielines (filters family, q, used, listed, include_inactive), each with its measures, size_mm, signature and used_by; one design adds its geometry (version 1, mm, print side), definition, hints and distinct_from. Patch name, family, facts, listed or notes. archive/ answers 409 with in_use while an active die or a part uses it. export/?format=pdf|dxf|cf2|svg downloads it, structure/ returns {structure, scene} for the 3D view (409 with no_structure when it has no panels to fold) and PUT hints/ stores fold hints (version 1; 400 with invalid_fold otherwise). The downloads are the same bytes the Box designer gives. POST distinct/ with {"other": id} records two near-duplicate single-ups as different dies ("Different die: keep separate"): 204, both ways round, so an import never asks about the pair again and matching a design leaves the other out; 400 for the design itself or a design that isn't yours.

GET /a/{team_slug}/production/api/v1/line-type-profiles/

production_line_type_profiles_list · View in API reference

line-type-profiles/ keeps how your files name their lines: a name, a format (cf2, dxf, pdf), a mapping of at most 200 source keys and is_default (one default per format; making one the default unsets the other).

GET /a/{team_slug}/production/api/v1/tooling-settings/

production_tooling_settings_retrieve · View in API reference

tooling-settings/ reads and patches your tooling settings (near_mm must be at least exact_mm; new_die_ups is a list of up to 10 numbers of ups).

Matching dies#

POST /a/{team_slug}/production/api/v1/tools/match/

The dies that fit a single-up, a library design, a Box designer Definition or a label size: exact matches, then near and style-and-size suggestions, usable first.

production_tools_match · View in API reference

POST tools/match/ answers which of your dies fit something, the way the app's match chips do (Matching jobs to dies). Send exactly one of:

  • geometry: a single-up (version 1, mm, y up: outline of at least 3 [x, y] points, holes, and lines by kind: cut, crease, perforation, score, partial_cut; at most 256 KB);
  • design: the id of one of your single-up dielines (dies that use that design match at 0 mm);
  • definition: a Box designer Definition (a box drawn in the app, at most 4 KB; its shape, then its style and inside size);
  • label: {shape, w_in, h_in, r_in} with shape rect, rounded or oval, sizes 0.01 to 200 in and r_in 0 by default (a custom label shape is sent as geometry).

Narrow it with tool_types (dies with stations only; default: all of them; label sizes: the label dies), sheet_in ([w, h], to flag a die laid out for another sheet), die_cutter (a die-cutter's id), customer (the customer's name: another customer's die is listed, not usable), for_imposition (a mirrored fit and a die without stations can't place work) and accepted ({tool, kind, geometry_hash}: a near match the user confirmed; it lapses when geometry_hash differs from the single-up's). The answer is {exact: [...], near: [...]}, near ending with the style-and-size (structural) suggestions; each entry has tool, number, name, kind, tier, dist_mm (null for a style-and-size suggestion), ups, status, ready_at, reasons, usable, confirmed and pose ({x, y, angle, mirrored}). Usable dies come first. Anything but exactly one of the four, an id that isn't yours or a Definition that doesn't validate answers 400.

Every equipment endpoint#

API operations tagged production
MethodPathWhat it does
POST /a/{team_slug}/production/api/v1/cut-sequences/analyse/ production_cut_sequences_analyse
POST /a/{team_slug}/production/api/v1/cut-sequences/analyse-upload/ Analyse a cut file in memory without retaining the upload or result.
GET /a/{team_slug}/production/api/v1/cut-sequences/export/ production_cut_sequences_export
POST /a/{team_slug}/production/api/v1/cut-sequences/save/ production_cut_sequences_save
POST /a/{team_slug}/production/api/v1/cut-sequences/upload/ production_cut_sequences_upload
GET /a/{team_slug}/production/api/v1/die-designs/ production_die_designs_list
GET /a/{team_slug}/production/api/v1/die-designs/{id}/ production_die_designs_retrieve
PUT /a/{team_slug}/production/api/v1/die-designs/{id}/ a_production_api_v1_die_designs_update
PATCH /a/{team_slug}/production/api/v1/die-designs/{id}/ production_die_designs_partial_update
POST /a/{team_slug}/production/api/v1/die-designs/{id}/archive/ production_die_designs_archive
POST /a/{team_slug}/production/api/v1/die-designs/{id}/distinct/ production_die_designs_distinct
GET /a/{team_slug}/production/api/v1/die-designs/{id}/export/ production_die_designs_export
PUT /a/{team_slug}/production/api/v1/die-designs/{id}/hints/ production_die_designs_hints
GET /a/{team_slug}/production/api/v1/die-designs/{id}/structure/ production_die_designs_structure
POST /a/{team_slug}/production/api/v1/die-imports/ Upload a CF2, DXF or PDF die (or name a Files version) and get its preview: ups, kinds, grid, rule, issues and matches.
GET /a/{team_slug}/production/api/v1/die-imports/{token}/ production_die_imports_retrieve
POST /a/{team_slug}/production/api/v1/die-imports/{token}/save/ Save the single-ups and optionally the die as a tool (or attach the file to a tool).
GET /a/{team_slug}/production/api/v1/finishing-machines/ production_finishing_machines_list
POST /a/{team_slug}/production/api/v1/finishing-machines/ production_finishing_machines_create
GET /a/{team_slug}/production/api/v1/finishing-machines/{id}/ production_finishing_machines_retrieve
PATCH /a/{team_slug}/production/api/v1/finishing-machines/{id}/ production_finishing_machines_partial_update
DELETE /a/{team_slug}/production/api/v1/finishing-machines/{id}/ Archives the machine.
POST /a/{team_slug}/production/api/v1/finishing-machines/{id}/set-default/ Make this the team's default machine of its kind.
POST /a/{team_slug}/production/api/v1/finishing-machines/{id}/simulate/ Test estimate: pieces in, setup and run time, cost and price for a number of good pieces, with the saved settings, speed factors and the kind's own settings.
POST /a/{team_slug}/production/api/v1/finishing-machines/from-preset/ Create a finishing machine from a preset (technical settings only; rates, times and speed empty).
GET /a/{team_slug}/production/api/v1/finishing-machines/presets/ Finishing machine presets grouped by kind: what the machine is (kind, glue styles, print stations, speed unit), each value with its source and confidence, and the maker's rated maximum as a hint.
GET /a/{team_slug}/production/api/v1/guillotines/ production_guillotines_list
POST /a/{team_slug}/production/api/v1/guillotines/ production_guillotines_create
GET /a/{team_slug}/production/api/v1/guillotines/{id}/ production_guillotines_retrieve
PATCH /a/{team_slug}/production/api/v1/guillotines/{id}/ production_guillotines_partial_update
DELETE /a/{team_slug}/production/api/v1/guillotines/{id}/ Archives the guillotine.
POST /a/{team_slug}/production/api/v1/guillotines/{id}/set-default/ Make this the team's default guillotine (N-up and strips jobs cut on it).
POST /a/{team_slug}/production/api/v1/guillotines/{id}/simulate/ Test cut: setup, jogging and knife time for piles of sheets at a number of strokes per lift.
GET /a/{team_slug}/production/api/v1/line-type-profiles/ production_line_type_profiles_list
POST /a/{team_slug}/production/api/v1/line-type-profiles/ production_line_type_profiles_create
GET /a/{team_slug}/production/api/v1/line-type-profiles/{id}/ production_line_type_profiles_retrieve
PATCH /a/{team_slug}/production/api/v1/line-type-profiles/{id}/ production_line_type_profiles_partial_update
GET /a/{team_slug}/production/api/v1/machines/ production_machines_list
POST /a/{team_slug}/production/api/v1/machines/ production_machines_create
GET /a/{team_slug}/production/api/v1/machines/{id}/ production_machines_retrieve
PATCH /a/{team_slug}/production/api/v1/machines/{id}/ production_machines_partial_update
DELETE /a/{team_slug}/production/api/v1/machines/{id}/ Archives the machine.
POST /a/{team_slug}/production/api/v1/machines/{id}/calibrate/ Suggest an efficiency factor from a timed job: (measured − fixed overheads) / estimated motion seconds, clamped to 0.2–5.
POST /a/{team_slug}/production/api/v1/machines/{id}/set-default/ Make this the team's default machine (new material groups use it).
POST /a/{team_slug}/production/api/v1/machines/{id}/simulate/ Test cut: identical parts in a grid on the bed; returns the full time breakdown and price.
POST /a/{team_slug}/production/api/v1/machines/from-preset/ Create a machine from a preset (published specs plus estimated practical defaults).
GET /a/{team_slug}/production/api/v1/machines/presets/ Machine presets grouped by manufacturer: published specs, sources, confidence and defaults.
GET /a/{team_slug}/production/api/v1/platemakers/ production_platemakers_list
POST /a/{team_slug}/production/api/v1/platemakers/ production_platemakers_create
GET /a/{team_slug}/production/api/v1/platemakers/{id}/ production_platemakers_retrieve
PATCH /a/{team_slug}/production/api/v1/platemakers/{id}/ production_platemakers_partial_update
DELETE /a/{team_slug}/production/api/v1/platemakers/{id}/ Archives the platemaker.
POST /a/{team_slug}/production/api/v1/platemakers/{id}/set-default/ Make this the team's default platemaker of its kind.
POST /a/{team_slug}/production/api/v1/platemakers/{id}/simulate/ Test estimate with the saved settings: setup, run and wait time, machine, material and consumable cost and price, the average per plate (above the minimum only), whether the plates are priced, and notes.
POST /a/{team_slug}/production/api/v1/platemakers/from-preset/ Create a platemaker from a preset (technical facts only; speed, times and money empty).
GET /a/{team_slug}/production/api/v1/platemakers/presets/ Platemaker presets grouped by kind: what the platemaker is (kind, technology, maximum plate size), each value with its source and confidence, and the maker's rated maximum as a hint.
GET /a/{team_slug}/production/api/v1/presses/ production_presses_list
POST /a/{team_slug}/production/api/v1/presses/ production_presses_create
GET /a/{team_slug}/production/api/v1/presses/{id}/ production_presses_retrieve
PATCH /a/{team_slug}/production/api/v1/presses/{id}/ production_presses_partial_update
DELETE /a/{team_slug}/production/api/v1/presses/{id}/ Archives the press.
POST /a/{team_slug}/production/api/v1/presses/{id}/set-default/ Make this the team's default press for its technology group (offset or digital).
POST /a/{team_slug}/production/api/v1/presses/{id}/simulate/ Test estimate: makeready, running and wash-up time, plates, impressions, cost and price.
POST /a/{team_slug}/production/api/v1/presses/from-preset/ Create a press from a preset (sourced values only; unverified values and costs left empty).
GET /a/{team_slug}/production/api/v1/presses/presets/ Press presets grouped by manufacturer: configuration, every value with its source and confidence (H maker, M secondary, L unverified, D derived, G generic) and the starting values.
GET /a/{team_slug}/production/api/v1/printers/ production_printers_list
POST /a/{team_slug}/production/api/v1/printers/ production_printers_create
GET /a/{team_slug}/production/api/v1/printers/{id}/ production_printers_retrieve
PATCH /a/{team_slug}/production/api/v1/printers/{id}/ production_printers_partial_update
DELETE /a/{team_slug}/production/api/v1/printers/{id}/ Archives the printer.
POST /a/{team_slug}/production/api/v1/printers/{id}/set-default/ Make this the team's default printer.
POST /a/{team_slug}/production/api/v1/printers/{id}/simulate/ Test print: time (setup, printing, sheet handling), cost and price incl.
POST /a/{team_slug}/production/api/v1/printers/from-preset/ Create a printer from a preset (published modes plus estimated overheads; prices 0).
GET /a/{team_slug}/production/api/v1/printers/presets/ Printer presets grouped by manufacturer: published modes, sources, confidence and defaults.
GET /a/{team_slug}/production/api/v1/tool-rates/ production_tool_rates_list
POST /a/{team_slug}/production/api/v1/tool-rates/ Create or replace the fields sent of the team's rate card for `tool_type` (200 when it existed).
GET /a/{team_slug}/production/api/v1/tooling-settings/ production_tooling_settings_retrieve
PATCH /a/{team_slug}/production/api/v1/tooling-settings/ production_tooling_settings_partial_update
GET /a/{team_slug}/production/api/v1/tools/ production_tools_list
POST /a/{team_slug}/production/api/v1/tools/ production_tools_create
GET /a/{team_slug}/production/api/v1/tools/{id}/ production_tools_retrieve
PATCH /a/{team_slug}/production/api/v1/tools/{id}/ production_tools_partial_update
DELETE /a/{team_slug}/production/api/v1/tools/{id}/ Archives the tool.
GET /a/{team_slug}/production/api/v1/tools/{id}/export/ The die's station drawing as a cut file.
GET /a/{team_slug}/production/api/v1/tools/{id}/layout.svg/ The die's stations drawn from its single-ups (404 without a station layout).
GET /a/{team_slug}/production/api/v1/tools/{id}/stripping/ The die checked on a pin-matrix die-cutter: the stripping block without money (grades, pins, notices, piece shapes).
PATCH /a/{team_slug}/production/api/v1/tools/{id}/waste-overrides/ Set the grade of stored waste pieces: {piece_id: stays_with_skeleton | falls_through | hand | stripping_tool | null}.
POST /a/{team_slug}/production/api/v1/tools/match/ The dies that fit a single-up, a library design, a Box designer Definition or a label size: exact matches, then near and style-and-size suggestions, usable first.

All “production” operations in the API reference

Last updated Nov. 2, 2026