Sheet metal - unfold a face to flat geometry

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

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.

Request

Responses

202

Task accepted

400

Validation error

403

Insufficient scope

500

Server error

Reference

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

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.

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.
faceIndex	integer	no	0-based index of the developable face (in the shape's BRepGraph face array) to unfold.Default: 0.
outputs	object	no	Controls which output formats are generated and their quality settings
outputs.formats	array of object	yes	Output formats to generate. Multiple formats can be requested (e.g. ['gltf', 'stpz']) - each produces a separate downloadable result. Do not include both 'step' and 'stpz' - only one STEP variant is supported per request.
outputs.meshPrecision	number	no	Mesh tessellation precision (lower = finer). Range: [0.0001, 10]
outputs.gltfMeshPrecision	number	no	Mesh tessellation precision (lower = finer). Range: [0.0001, 10]
outputs.adjustYtoZ	boolean	no	Convert from Y-up to Z-up coordinate system in the output. Useful for software that expects Z-up.

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/face-to-flat" \
  -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.