Sign in

v1

latestOpenAPI 3.1.0Proprietary2026-07-173298155.5 KB
Sheet Metal

Sheet metal - unfold a face, metrics report

Proprietary sheet-metal analysis: computes the unfold metrics report (developability, area, ...) for a single face of an uploaded STEP shape. Requires the 'cad' API key scope. Returns 202 with a task ID; the JSON report is delivered in the task metadata.

post/api/v1/cad/pro/unfold/face-report

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 face to analyze.

Response

Task accepted

oktrue required

Example response

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