The Sheet Metal API exposes the same sheet metal rules, features, and flat patterns you create in the Design workspace. Use it from a script or add-in to define and apply sheet metal rules, create and edit features (flanges, hems, corner closures, and more), and work with the resulting flat pattern for manufacturing.
This introduction explains the sheet metal object model and how to create rules, features, and flat patterns from a script or add-in. The content is split into four topics. Examples use Python; the same types and methods are available in TypeScript and C++. For every class, method, and property, see the API Reference Manual (for example SheetMetalRule and HemFeatures).
Use a parametric design (history captured). Sheet metal is not supported in a direct, history-free design.
At the start of your script, define the application, design, root component, and document. Later samples assume these variables exist:
import adsk.core, adsk.fusion app = adsk.core.Application.get() design = adsk.fusion.Design.cast(app.activeProduct) rootComp = design.rootComponent doc = app.activeDocument
For runnable examples, see the Sheet Metal Rules Sample and other samples under Sheet Metal on the API Samples page.
The Sheet Metal API uses two entry points: the Design and its components. Knowing which to use helps you find rules, features, and flat patterns in code:
Rules live on the Design. SheetMetalRule objects come from design.designSheetMetalRules or design.librarySheetMetalRules.
Features and flat patterns live on each component. Sheet metal feature collections (flangeFeatures, hemFeatures, ripFeatures, and others) come from Component.features, alongside extrudes, fillets, and other feature types. A component's flat pattern comes from Component.flatPattern.
Sketching on a flat pattern is the one exception. It goes through that flat pattern's own FlatPatternProduct in the document's products collection. See Flat Patterns.
| Area | Root | How you reach it |
|---|---|---|
| Sheet metal rules | Design | design.designSheetMetalRules, design.librarySheetMetalRules |
| Sheet metal features | Component | component.features.flangeFeatures, .hemFeatures, .ripFeatures, … |
| Flat pattern | Component | component.flatPattern |
Sheet Metal API Overview – Feature collections, sheet metal bodies and rules, flat patterns, and the common feature pattern.
Sheet Metal Rules and Conversion – Rules, units, assigning rules to components, and converting solids to sheet metal.
Sheet Metal Features – Flanges, lofted flanges, hems, rips, corner closures, join by bend, rule overrides, folding and unfolding, fillets, and chamfers.
Flat Patterns – Creating flat patterns, bend info, and sketching on the flat pattern.