SolidWorks API Functions: 20 Expert Commands You Must Know

SolidWorks API Functions: 20 Expert Commands You Must Know

SolidWorks automation has become one of the most powerful productivity multipliers in modern CAD engineering. Whether you are building complex parametric models, processing thousands of drawings, or automating metadata across large assemblies, one thing remains constant: SolidWorks API Functions are the backbone behind every serious automation workflow.

In this cornerstone guide, we dive deep into the 20 expert-level SolidWorks API Functions every engineer should know if they want to automate real-world tasks, eliminate repetitive work, and build reliable VBA macros or full-scale CAD tools.

This guide is written with accuracy, clarity, and real engineering experience — designed to help professionals, teams, and future automation leaders build a strong foundation in SolidWorks API.

Let’s begin.

Introduction to SolidWorks API Functions

The SolidWorks API (Application Programming Interface) exposes the entire CAD system to automation. Through a structured set of functions, known as SolidWorks API Functions, engineers can programmatically control sketches, features, assemblies, drawings, configurations, metadata, and more.

These functions are the key building blocks behind:

• VBA macros

• Add-ins

• Batch tools

• Data migration programs

• Drawing check automations

• Manufacturing or QC workflows

Understanding these functions not only improves productivity but also positions your engineering team for scalable automation.

---

Why Learning SolidWorks API Matters

Engineering teams adopting automation are seeing major productivity gains:

Benefits of Using SolidWorks API Functions

• 70–90% time reduction in repetitive CAD tasks

• Lower human errors in metadata & dimension updates

• Faster drawing creation and batch processing

• Consistent output across teams

• Better control over complex assemblies

• Cleaner workflows for manufacturing

Manual vs Automated Workflow (Quick Comparison)

Automation is no longer optional — it’s a competitive engineering skill.

---

How SolidWorks API Works (Simple Object Model)

Understanding the SolidWorks object hierarchy helps you know where each API Function belongs.

Core Object Flow

Key API Access Points

• ISldWorks → Opening files, creating documents

• ModelDoc2 → Editing models

• ModelDocExtension → Advanced property, export, selection

• FeatureManager → Features & rebuild

• SketchManager → Create sketches

• IAssemblyDoc → Component manipulation

This structure ensures your automation touches the right layer of SolidWorks.

---

Top 20 SolidWorks API Functions Engineers Must Know

Below are the 20 expert-level SolidWorks API Functions — each explained with purpose, use cases, and mini-snippets.

---

1. ISldWorks::OpenDoc6

What It Does

Opens any SolidWorks document programmatically.

Why It Matters

Essential for batch tools, migrations, and automation.

Mini VBA Snippet

Set swModel = swApp.OpenDoc6(path, swDocPART, 0, "", err, warn)

Use Cases

• Batch open hundreds of files

• Data extraction tools

• Mass metadata updates

---

2. ModelDoc2::Save

The simplest yet most crucial save API.

Mini VBA Snippet

boolStatus = swModel.Save()

Use for:

• Auto-saving after edits

• Batch repair tools

• Standardization scripts

---

3. ModelDoc2::ForceRebuild

Forces SolidWorks to rebuild every feature..

Mini VBA Snippet

swModel.ForceRebuild3 False

Use when:

• Parameters changed

• Sketches updated

• Features dependent on external references

---

4. CustomPropertyManager

Used for reading & writing metadata.

Mini VBA Snippet

Set propMgr = swModel.Extension.CustomPropertyManager("")
propMgr.Add "Description", "Text", "Flange Bracket"

Use in:

• ERP integration

• PDM migration

• Batch naming

• Drawing automation

If you want to automate metadata at scale, you can also explore our SolidWorks Custom Properties Manager tool, which helps update properties in bulk and integrates fully with the same API functions used here.

---

5. FeatureManager::InsertFeature

Inserts new features (boss, cut, etc).

What It Does

FeatureManager::InsertFeature is one of the most versatile SolidWorks API Functions used to create 3D features directly from sketches or geometry. This includes operations like extrude, revolve, cut, shell, fillet, chamfer, and many more.

It gives automation engineers the ability to generate parametric features programmatically, making it essential for design automation, product configurators, or template-based modeling.

If you want a practical, step-by-step example of automating cut features, you can follow our detailed guide on creating a Cut-Extrude from a sketch in SolidWorks using VBA. It shows how to apply these SolidWorks API Functions in a real modeling workflow.
👉 https://thetechthinker.com/cut-extrude-from-sketch-in-solidworks-using-vba-macro/

---

Why It Matters

This is the function that allows your macro to behave like an actual CAD designer.
Any tool that auto-builds models — from simple brackets to large product generators — will require this API.

Key reasons it is important:

• Enables fully automated model creation

• Ensures parametric consistency across variants

• Avoids manual sketch-feature steps

• Reduces modelling time for repeat families

• Core of advanced CAD automation engines (CPQ, product builders, etc.)

When paired with sketch APIs (CreateLine, CreateCircle, CreateEllipse, etc.), it forms the foundation of automated geometry creation.

Mini VBA Snippet

Dim swApp As SldWorks.SldWorks
Dim swModel As ModelDoc2
Dim swFeatureMgr As FeatureManager
Dim swFeature As Feature

Set swApp = Application.SldWorks
Set swModel = swApp.ActiveDoc
Set swFeatureMgr = swModel.FeatureManager

' Create a boss-extrude from the active sketch
Set swFeature = swFeatureMgr.FeatureExtrusion2( _
        True, False, False, _
        0, 0, _
        0.02, 0.0, _
        False, False, False, False, _
        0.0, 0.0, _
        False, False, False, _
        False, True, True _
)

---

This snippet assumes an active sketch exists.
Automation pipelines typically create a sketch, apply constraints, and then call FeatureExtrusion2 or similar methods.

Common Variants of InsertFeature

Depending on the feature type, SolidWorks exposes different API calls:

(All of these fall under the FeatureManager API umbrella.)

---

Typical Engineering Use Cases

1. Configurable product generators

Automatically create a 3D model based on input parameters (width, height, hole size, flange length, etc.).

2. Template-driven modeling

Used when manufacturing standards require identical modeling structure for every part.

3. Automated bracket, plate, and frame generation

Common in sheet-metal industries where geometry follows strict rules.

4. Rapid prototyping tools

Engineers can quickly generate multiple design variants without manually modeling each one.

5. Smart macros for daily engineering

Examples: auto-cut slot generator, boss-placement tools, stiffener creation macros, weld feature automation.

---

Best Practices for Using InsertFeature APIs

✔ Always create and close sketches properly before calling a feature API.
✔ Avoid unnecessary rebuilds — group multiple actions before calling ForceRebuild.
✔ Use meaningful names for features using:

swFeature.Name = "My_Automated_Feature"

---

6. SelectionMgr::GetSelectedObject6

Critical for tools that depend on user selection.

What It Does

SelectionMgr::GetSelectedObject6 retrieves whatever entities the user (or macro) has selected — faces, edges, vertices, bodies, features, components, or sketch entities. This is one of the most commonly used SolidWorks API Functions when building interactive tools that depend on user input.

It enables your automation to “understand” what the engineer clicked — forming the basis for geometry-driven macros, measurement tools, feature analyzers, and drawing automation.

Mini VBA Snippet

Dim swSelMgr As SelectionMgr
Dim swObj As Object

Set swSelMgr = swModel.SelectionManager
Set swObj = swSelMgr.GetSelectedObject6(1, -1)

If Not swObj Is Nothing Then
    Debug.Print "Selected Type: "; swSelMgr.GetSelectedObjectType3(1, -1)
End If

This retrieves the first selected object, regardless of its type.

---

Used For

• Tools that require clicking specific geometry (faces, edges, vertices)

• Feature-based automations (detect hole features, chamfers, fillets, etc.)

• Measurement or thickness-check tools

• Drawing view selection handling

• Multi-selection macros (loop through all selected items)

• QC scripts that validate selected entities

---

Common Selection Types

---

Best Practices

✔ Always check if the selection count > 0
✔ Use GetSelectedObjectType3 to avoid type errors
✔ For multi-selection tasks, loop through GetSelectedObjectCount2
✔ Use ClearSelection2 after automation steps

---

7. SketchManager::CreateLine

Creates lines in sketches.

What It Does

SketchManager::CreateLine creates straight sketch lines using two coordinate points. It is one of the most fundamental SolidWorks API Functions for building automated sketches, parametric layouts, and feature-ready geometry.

This function is widely used in macros that generate profiles, sheet-metal outlines, base sketches, or construction geometry.

---

Mini VBA Snippet

Dim swSk As SketchManager
Set swSk = swModel.SketchManager

'Create a line from (0,0) to (0.1,0.05)
swSk.CreateLine 0#, 0#, 0#, 0.1, 0.05, 0#

Coordinates are always in meters.

---

Used For

• Building automated 2D profiles

• Creating reference layouts for extrude/revolve

• Sheet metal blank outlines

• Construction geometry in parametric sketches

• Auto-generating bracket, plate, or frame profile macros

---

Best Practices

✔ Always open a sketch before creating entities
✔ Use construction geometry when needed:
swSk.MakeSketchBlock3 or CreateCenterLine
✔ Apply dimensions/relations after line creation for parametric control
✔ Keep coordinate values consistent (meters)

---

8. SketchManager::CreateCircleByRadius

Create circles with precision.

What It Does

CreateCircleByRadius adds a circle to the active sketch by specifying its center point and radius. It is one of the most essential SolidWorks API Functions for hole features, cutouts, revolved shapes, and parametric sketch profiles.

---

Mini VBA Snippet

swModel.SketchManager.CreateCircleByRadius _
    0#, 0#, 0#, 0.015

This creates a 15 mm circle centered at the origin.

---

Used For

• Hole creation (extrude-cut)

• Shaft or pipe profiles

• Sheet-metal pierce holes

• Revolved shapes

• Automated bracket or flange generators

---

Best Practices

✔ Ensure sketch is active
✔ Maintain radius in meters
✔ Add relations/dimensions after creation

---

9. IAssemblyDoc::AddComponent5

Adds components to assemblies.

What It Does

AddComponent5 inserts a part or sub-assembly into the active assembly. It is one of the most important SolidWorks API Functions for automating assembly construction.

Mini VBA Snippet

swAssy.AddComponent5 path, 0, "", x, y, z

What It Does

AddComponent5 inserts a part or sub-assembly into the active assembly. It is one of the most important SolidWorks API Functions for automating assembly construction.

---

10. CreateFeatureFromSketch

Creates features from sketches.

What It Does

Creates a 3D feature (like an extrude, cut, or revolve) from the currently active sketch. It bridges sketch creation and solid feature generation.

Mini VBA Snippet

swModel.FeatureManager.FeatureExtrusion2 (...)

Used For

• Automated part creation

• Template-based model generators

• Sheet-metal profile operations

Summary

Essential for turning sketches into manufacturable 3D features during automation.

---

11. EditSketch

Switches sketch to edit mode.

What It Does

EditSketch enters sketch edit mode for the selected sketch or creates a new editable state.

Mini VBA Snippet

swModel.EditSketch

Used For

• Editing existing sketch geometry

• Applying constraints/dimensions

• Preparing profiles for auto-features

Summary

A simple but necessary function for any macro modifying sketch geometry.

---

12. IComponent2::GetMassProperties

Gets mass, volume, and inertia.

What It Does

Retrieves mass, center of gravity, volume, moments of inertia, and other physical properties.

Mini VBA Snippet

arr = swComp.GetMassProperties

Used For

• Weight calculation tools

• BOM automation

• Material optimization scripts

• Structural or FEA checks

Summary

A must-know API for any automation involving material or weight-driven engineering.

---

13. InsertTableAnnotation

Used for BOM, weld tables, hole tables.

What It Does

Adds tables into drawings or models — including BOM, hole table, weld table, and general tables.

Mini VBA Snippet

swModel.InsertTableAnnotation2(...)

Used For

• Automated BOM creation

• Hole tables in sheet metal drawings

• Welding documentation

• Standardized drawing templates

Summary

Critical in drawing automation where structured tabular data is required.

---

14. ModelDocExtension::SaveAs

Export STEP, DXF, IGES, PDF.

What It Does

Exports models or drawings to formats like STEP, IGES, DXF, PDF, Parasolid, etc.

Mini VBA Snippet

swModel.Extension.SaveAs fileName, 0, 0, Nothing, err, warn

Used For

• Batch exports

• NC/DXF generation

• Customer deliverable automation

• Neutral file conversions

Summary

Essential for any export-related automation, especially in manufacturing workflows.

---

15. IPartDoc::CreateFlatPattern

Creates flat patterns for sheet metal.

What It Does

Generates a flat pattern for sheet-metal parts programmatically.

Mini VBA Snippet

swPart.CreateFlatPattern

Used For

• CAM-ready flat patterns

• Sheet-metal costing

• Batch DXF flattening tools

Summary

A key API for any sheet-metal automation suite.

---

16. ConfigurationManager Functions

• Add

• Rename

• Activate

Critical for variant design.

What It Does

Allows you to add, rename, or activate configurations inside a model.

Mini VBA Snippet

swCfgMgr.AddConfiguration "Size_100"
swCfgMgr.ActivateConfiguration "Default"

Used For

• Variant design automation

• CPQ/configurator models

• Multi-size product families

Summary

Critical for engineering teams handling product variants and design permutations.

---

17. Body & Geometry Access Functions

• GetBodies

• GetFaces

• GetEdges

• Traverse loops

Used in advanced automation like collision, drafting checks.

What It Does

APIs like GetBodies, GetFaces, GetEdges, and loop traversal functions give access to geometric entities.

Mini VBA Snippet

Set bodies = swModel.GetBodies2(swSolidBody, False)

Used For

• Collision checks

• Draft analysis automation

• Geometry validation tools

• Feature detection

Summary

Essential for advanced geometry computation and CAD quality-check tools.

---

18. Measure & Dimension Functions

Retrieve dimensions, rebuild values, and compare.

What It Does

Retrieve and compare dimensions, measure distances, angles, thickness, and rebuild parametric values.

Mini VBA Snippet

Set swDim = swModel.Parameter("D1@Sketch1")
val = swDim.GetSystemValue

Used For

• Automated tolerance validation

• Fit-check tools

• Interference/clearance checks

• Design rule enforcement

Summary

A core API group for automated measurement or QC workflows.

---

19. Feature Traversal APIs

Enumerate features for QC tools.

What It Does

Enumerates all features in a model using functions like IEnumFeatures.

Mini VBA Snippet

Set feat = swModel.FirstFeature
Do While Not feat Is Nothing
    feat = feat.GetNextFeature
Loop

Used For

• Feature-based quality checks

• Model audits

• Automation that targets specific feature types

Summary

Essential for scanning models and performing automated validations.

---

20. Drawing View Entity Functions

Extract notes, dimensions, balloons, symbols.

What It Does

APIs like View::GetVisibleEntities2 extract notes, dimensions, balloons, symbols, and other entities in drawing views.

Mini VBA Snippet

entities = swView.GetVisibleEntities2(...)

Used For

• Drawing QC automation

• Balloon/annotation validation

• Hole callout extraction

• Automated dimension checks

Summary

Indispensable for macros and tools that analyze or standardize drawing annotations.

---

Practical Engineering Use Cases

• Auto-flattening sheet metal

• Batch exporting drawings

• Automated dimension validation

• Custom property mapping

• QC and drafting checks

• ERP integration workflows

---

Best Practices for Using SolidWorks API Functions

Checklist:

• Always use proper error handling

• Avoid unnecessary rebuilds

• Work with lightweight mode for large assemblies

• Use With/End With for performance

• Release objects to avoid memory leaks

---

Common Errors & Debugging Tips

Even with the most reliable SolidWorks API Functions, automation can fail if the model, sketch, selection, or rebuild state is not what the macro expects. Most issues engineers face are not “API bugs” — they are workflow sequence problems, invalid geometry, or missing selections.
This section highlights the most common API errors, why they occur, and how to fix them quickly so you can build stable, production-ready macros.

If you’re serious about building dependable CAD automation tools, this part of the guide is essential reading.