Skip to main content
The importer turns CAD files into clean, nestable geometry through a session. Unlike a one-shot nesting request, a session is stateful: you upload files, inspect what was found, assign which layers mean what (cut, engrave, ignore…), and pull back the resulting geometry — which you can then feed to POST /nesting/geometry.

When to use the importer

  • Your files carry layers that need mapping (e.g. an “ENGRAVE” layer vs. the cut path).
  • You want a human (or your UI) to review import results before nesting.
  • You’re building an interactive import experience in your product.
If you just have clean DXF and want a layout, submit directly to POST /nesting instead.

Session lifecycle

1

Create a session

POST /importer/Session (CreateImportSession) with your ImportSessionSettings. Returns a session identity used by every subsequent call.
Multiple end users sharing one API key? Pass the optional X-End-User-Id header on session creation. Importer layer assignments are then stored and reloaded per end user; omit it and they’re indexed by API key/account only.
2

Add files

POST /importer/File (CreateFileSettings) to add each file to the session. Update a file’s settings with PUT /importer/File, or remove it with DELETE /importer/File.
3

Review layers & assignments

GET /importer/Assignments (GetAssignmentTypes) lists the assignment types a layer can be given. Apply assignments through the file/model settings so the importer knows which layers are cut paths, which are engraving, and which to ignore.
4

Inspect the model

GET /importer/Model (RetrieveModelIdentity) returns the interpreted model; PUT /importer/Model (UpdateModelSettings) adjusts model-level settings.
5

Retrieve results

GET /importer/Result (RetrieveResultIdentity) returns the imported geometry, ready to nest via POST /nesting/geometry.
6

Complete or cancel

PUT /importer/Session/Complete finalises the session. To abandon it, use DELETE /importer/Session/Cancel (or DELETE /importer/Session).

Keeping a session alive

Long interactive sessions can be kept warm with KeepSessionAlive so they aren’t reclaimed mid-edit. Complete or cancel sessions you’re done with rather than leaving them to expire.

Endpoint summary

EndpointMethodPurpose
/importer/SessionPOSTCreate a session
/importer/SessionDELETECancel session settings
/importer/Session/CancelDELETECancel the session
/importer/Session/CompletePUTComplete the session
/importer/FilePOST / PUT / DELETEAdd / update / remove a file
/importer/ModelGET / PUTRetrieve / update the model
/importer/ResultGETRetrieve imported geometry
/importer/AssignmentsGETList layer assignment types

Next

Nest the imported geometry

Feed the retrieved geometry to POST /nesting/geometry.