Parameterized shape reference
This reference lists shape kinds accepted by parameter based shape creation and the additional fields each kind accepts. Placement and dimensions common to all kinds are omitted. The engine request registry is the source of truth.
For placement, shared fields, defaults, and request behavior, see the REST API shape guide. Use the OpenAPI contract for the documented project and shape CRUD schemas.
| Kind | Additional request fields |
|---|---|
box | taperTopWidth, taperTopDepth, taperBottomWidth, taperBottomDepth |
cube | taperTopWidth, taperTopDepth, taperBottomWidth, taperBottomDepth |
cylinder | sides, taperTopWidth, taperTopDepth, taperBottomWidth, taperBottomDepth |
cone | sides, topRadius, baseRadius, taperTopWidth, taperTopDepth, taperBottomWidth, taperBottomDepth |
sphere | steps, taperTopWidth, taperTopDepth, taperBottomWidth, taperBottomDepth |
halfSphere | steps, taperTopWidth, taperTopDepth, taperBottomWidth, taperBottomDepth |
torus | taperTopWidth, taperTopDepth, taperBottomWidth, taperBottomDepth |
tube | bevel, taperTopWidth, taperTopDepth, taperBottomWidth, taperBottomDepth |
ring | bevel, taperTopWidth, taperTopDepth, taperBottomWidth, taperBottomDepth |
polygon | taperTopWidth, taperTopDepth, taperBottomWidth, taperBottomDepth |
pyramid | sides, taperTopWidth, taperTopDepth, taperBottomWidth, taperBottomDepth |
roof | taperTopWidth, taperTopDepth, taperBottomWidth, taperBottomDepth |
roundRoof | sides, taperTopWidth, taperTopDepth, taperBottomWidth, taperBottomDepth |
wedge | taperTopWidth, taperTopDepth, taperBottomWidth, taperBottomDepth |
icosahedron | taperTopWidth, taperTopDepth, taperBottomWidth, taperBottomDepth |
text | bevel, segments, taperTopWidth, taperTopDepth, taperBottomWidth, taperBottomDepth, text, font |
loft | taperTopWidth, taperTopDepth, taperBottomWidth, taperBottomDepth, loftBottomShape, loftTopShape, loftTopWidth, loftTopDepth, loftBottomRotation, loftTopRotation, loftSegments, loftLayers |
gear | teeth, toothSize, toothWidth, centerHoleSize, gearType, helixAngle |
The cube kind is an accepted request alias that creates a box with equal side dimensions. Imported meshes and drawn sketches are not parameterized shape requests.
Documentation version: 1.30.0 · Repository revision: 1cb9fee8dff4d394684c229dd67a21da539d167f · View source