step2gcode

Check whether the user finished the browser upload. Returns the file_id once ready. Free. NEXT STEP - do not generate yet. Ask the user: 1. Which material? Offer the presets (wood, hardwood, plywood, acrylic, aluminum, steel, brass). If theirs is not among them, pick the closest preset AND set spindle_speed, feed_rate, plunge_rate and step_down yourself from known cutting data for that material and cutter. 2. Which cutter diameters do they actually own? Recommend one from that list: it must fit the smallest inner radius of the part, and a smaller cutter means longer machining time. If you cannot judge the geometry yet, say so and suggest generating once to see the dimensions. 3. Is the part cut all the way through? Then recommend holding_tabs so it does not come loose on the last pass.

Turn an uploaded STL or 3MF mesh back into a STEP solid with exact surfaces - planes, cylinders, cones and fillets instead of triangles, intersected into real edges. Free; only the download of the finished file is charged. Use this when the user has a mesh and needs CAD geometry: a hole becomes a cylinder with a diameter again, a chamfer a cone with an angle, so the part can be dimensioned, modified and machined. Typical case: the CAD source is gone and the mesh is all that is left. The answer states the largest measured deviation between the built solid and the mesh, in millimetres - always pass that number on to the user, it is what tells them whether the result is accurate enough for their part. Parts made of freeform surfaces and raw 3D scans are rejected with a reason instead of being badly reconstructed. Upload the mesh the same way as any other file (curl to /api/upload, upload_file_content or create_upload_link), then pass the file_id here. The resulting STEP file can go straight into generate_gcode afterwards.

Create a short-lived link the user opens in their browser to upload a CAD file (STEP, DXF or SVG). Returns the link and an upload_id. Poll check_upload with the upload_id until it reports a file_id, then call generate_gcode. Free. Before using this, check whether you can run shell commands. If you can, do not send the user to the browser: compress the file locally and pass it to upload_file_content (the compression is detected by itself). That works inside sandboxes without network access, which is the common case - a direct curl upload fails there with a proxy error. The response of this tool spells out all three routes in order.

Start G-code generation for an uploaded file and wait for the result. Most jobs finish within the wait, so the answer usually already carries the part dimensions and hole diameters - no polling needed. Only if it says the job is still running, call get_job_status once after a few seconds. Free - only the download is charged. BEFORE CALLING THIS, ask the user about the settings you cannot infer from the file. Two of them change the result substantially and are wrong by default more often than not: - material: drives spindle speed, feed rates and depth per pass. Aluminium cut with wood settings breaks cutters. - holding_tabs: without them a cut-out part comes loose on the last pass and can be thrown off the machine. Recommend them for any part cut all the way through. Also worth asking when the geometry suggests it: pockets and holes (STEP files carry that depth information), and whether the job is milling or laser work. IMAGES (PNG, JPG, WebP ...) are always laser raster engraving. Ask for the engraving width in mm, photo or logo (image_mode), the controller (GRBL or Marlin) and its S maximum (laser_max_s), and tell the user to test power and speed on a scrap piece first.

Show credits left on the access token and how many models are already paid for. Free.

Return the download link for the finished G-code. THIS is the billed step: one credit per model not paid for yet. Re-downloading the same job or a model already paid for is free. Called without confirm, this tool charges nothing and only reports what the download would cost. Show that to the user, wait for their answer, and only then call again with confirm=true. Never set confirm=true on your own initiative - it spends the user's money.

Check a generation job. While it runs you get the percentage done, how long it has been running and how much time is left before the generator gives up on its own (180 s). When it fails you get the generator's own reason - pass that on to the user instead of retrying blindly. This is the ONLY correct way to wait for a job; calling generate_gcode again never helps. Free.

Return the download link for a STEP file built by convert_mesh_to_step. THIS is the billed step: one credit per model not paid for yet. The DXF contour that comes with a 2.5D part belongs to the same part and costs nothing extra. Called without confirm, this tool charges nothing and only reports what the download would cost. Show that to the user, wait for their answer, and only then call again with confirm=true. Never set confirm=true on your own initiative - it spends the user's money.

Show the finished tool path as an image (top view and isometric view, cutting moves and rapids in different colours) so the user can sanity-check the job before paying. Free.

Upload a CAD file by writing its content out yourself. Use this only when a direct curl upload to /api/upload is not possible - that route costs you no output at all. If you must use this tool, ALWAYS compress first and pass the output as content: (xz -9e -c model.step 2>/dev/null || gzip -9c model.step) | base64 | tr -d '\n' xz writes about a quarter less than gzip; the command falls back to gzip where xz is missing (macOS). xz, bzip2 and gzip are recognised by themselves - no extra argument. Do not paste the raw file. You have to write out every character you pass here, and a typical STEP solid takes you three minutes raw against twenty seconds compressed - the user watches that happen. Compression shrinks it about fivefold, which brings files up to roughly 80 KB within reach. NO SHELL AVAILABLE? Then do not use this tool for anything above about 10 KB - you would have to type the whole file out and the user waits minutes for it. Call create_upload_link instead: the user drops the file in a browser and it is done in five seconds. Same if the file is still too large after compressing. Free. NEXT STEP - do not generate yet. Ask the user: 1. Which material? Offer the presets (wood, hardwood, plywood, acrylic, aluminum, steel, brass). If theirs is not among them, pick the closest preset AND set spindle_speed, feed_rate, plunge_rate and step_down yourself from known cutting data for that material and cutter. 2. Which cutter diameters do they actually own? Recommend one from that list: it must fit the smallest inner radius of the part, and a smaller cutter means longer machining time. If you cannot judge the geometry yet, say so and suggest generating once to see the dimensions. 3. Is the part cut all the way through? Then recommend holding_tabs so it does not come loose on the last pass.