Sheet metal - unfold all solids, metrics report

POST 
/api/v1/cad/pro/unfold/solid-report

Proprietary sheet-metal analysis: computes per-solid unfold metrics for every solid in an uploaded STEP file. Requires the 'cad' API key scope. Returns 202 with a task ID; the JSON report array is delivered in the task metadata.

Request

Responses

202

Task accepted

400

Validation error

403

Insufficient scope

500

Server error

Reference

POST /api/v1/cad/pro/unfold/solid-report

Proprietary sheet-metal analysis: computes per-solid unfold metrics for every solid in an uploaded STEP file. Requires the 'cad' API key scope. Returns 202 with a task ID; the JSON report array is delivered in the task metadata.

Request body

Content type: application/json (required)

Field	Type	Required	Description
stepFileId	string	yes	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.
kFactor	number	no	Sheet-metal K-factor (neutral-axis position), typically ~0.5.Default: 0.5.
thicknessOverride	number	no	Sheet thickness override in model units; 0 auto-detects thickness from face pairs.Default: 0.

Responses

Status	Description
202	Task accepted
400	Validation error
403	Insufficient scope
500	Server error

Example request

curl -X POST "https://api.bitbybit.dev/api/v1/cad/pro/unfold/solid-report" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ ... }'

Authentication: send your key in the x-api-key header. The full machine-readable specification is at openapi.json.