Sign in
Sheet Metal

Sheet metal - unfold a face to flat geometry

Proprietary sheet-metal unfold: flattens a single developable face (by index) of an uploaded STEP shape. Requires the 'cad' API key scope. Returns 202 with a task ID; the flattened geometry is delivered as the task's output files.

post/api/v1/cad/pro/unfold/face-to-flat

Request body

stepFileIdstring required

ID of the previously uploaded STEP file (returned by the file upload endpoint). Both plain STEP (.step/.stp) and gzip-compressed STEP (.stpz) uploads are accepted - compression is detected automatically.

faceIndexinteger

0-based index of the developable face (in the shape's BRepGraph face array) to unfold.

Example request

{
  "outputs": {
    "meshPrecision": 0.1,
    "gltfMeshPrecision": 0.1
  }
}

Response

Task accepted

oktrue required

Example response

{
  "data": {
    "statusUrl": "/api/v1/tasks/{taskId}"
  }
}

Changes

Changed in 2 of the 15 revisions of this API.11