How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Onshape

Onshape Assembly API

Create and manage assemblies.

Documentation Provider Profile APIs.io OpenAPI GitHub

Onshape Assembly API is one of 42 APIs that Onshape publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Assembly. The published artifact set on APIs.io includes an OpenAPI specification and an API reference.

This API exposes 27 operations across 25 paths, and defines 105 schemas. It is described by OpenAPI 3.0.1, at version 1.218.84032-34acba44be17.

Requests are made against a single base URL, https://cad.onshape.com/api/v16.

27 operations 25 paths 105 schemas 2 DELETE12 GET13 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
1.218.84032-34acba44be17
Base URL
https://cad.onshape.com/api/v16
Authentication
OAuth 2.0, HTTP Basic
Contact
api-support@onshape.zendesk.com
License
Apache 2.0
Terms of Service
View terms
Resource Areas
1

Authentication & Security 2

Onshape Assembly API declares 2 security schemes for authenticating requests. It supports OAuth 2.0 (OAuth2) using the authorizationCode flow, exposing 24 scopes. It accepts HTTP basic authentication (BasicAuth). By default, every request must be authenticated.

  • OAuth2 — Use OAuth 2.0 to authenticate requests.
  • BasicAuth — Use Basic Authentication with API Keys (key as username and secret as password) to authenticate requests.

Paths & Operations 27

Across 25 paths, the API surfaces 27 operations — 2 DELETE, 12 GET, 13 POST. Each is listed below with its method, path, parameters, and response codes.

Assembly 27

Create and manage assemblies.

GET
/assemblies/d/{did}/e/{eid}/namedViews
Get the view data for all named views for the specified element.
getNamedViews 5 params → default
POST
/assemblies/d/{did}/w/{wid}
Create a new assembly tab in the document.
createAssembly 2 params body → default
POST
/assemblies/d/{did}/w/{wid}/e/{eid}/bomelement
Gets the Bill Of Materials (BOM) for the specified assembly, or creates a BOM if none exist.
getOrCreateBillOfMaterialsElement 3 params → default
POST
/assemblies/d/{did}/w/{wid}/e/{eid}/features/featureid/{fid}
Update an existing feature for an Assembly.
updateFeature 4 params body → default
DELETE
/assemblies/d/{did}/w/{wid}/e/{eid}/features/featureid/{fid}
Delete a feature from an assembly.
deleteFeature 4 params → 200
DELETE
/assemblies/d/{did}/w/{wid}/e/{eid}/instance/nodeid/{nid}
Delete an instance of an assembly.
deleteInstance 4 params → default
POST
/assemblies/d/{did}/w/{wid}/e/{eid}/instances
Insert an instance of a part, sketch, assembly, or Part Studio into an assembly.
createInstance 3 params body → default
POST
/assemblies/d/{did}/w/{wid}/e/{eid}/matevalues
Update mate values for the given mates in the specified assembly.
updateMateValues 3 params body → default
POST
/assemblies/d/{did}/w/{wid}/e/{eid}/modify
Modify an assembly.
modify 4 params body → default
POST
/assemblies/d/{did}/w/{wid}/e/{eid}/occurrencetransforms
Transform a list of assembly occurrences.
transformOccurrences 3 params body → default
POST
/assemblies/d/{did}/w/{wid}/e/{eid}/transformedinstances
Create new instances with transformation.
insertTransformedInstances 3 params body → default
GET
/assemblies/d/{did}/{wvm}/{wvmid}/e/{eid}
Get definition information for the specified assembly.
getAssemblyDefinition 11 params → default
GET
/assemblies/d/{did}/{wvm}/{wvmid}/e/{eid}/bom
Get the Bill Of Materials (BOM) content for the specified assembly.
getBillOfMaterials 18 params → default
GET
/assemblies/d/{did}/{wvm}/{wvmid}/e/{eid}/boundingboxes
Get bounding box information for the specified assembly.
getAssemblyBoundingBoxes 11 params → default
GET
/assemblies/d/{did}/{wvm}/{wvmid}/e/{eid}/displaystates
Get a list of display states for the specified assembly.
getDisplayStates 5 params → 200
GET
/assemblies/d/{did}/{wvm}/{wvmid}/e/{eid}/explodedviews
Get a list of exploded views for the specified assembly.
getExplodedViews 7 params → default
GET
/assemblies/d/{did}/{wvm}/{wvmid}/e/{eid}/features
Get the definitions of the specified features in an assembly.
getFeatures 8 params → 200
POST
/assemblies/d/{did}/{wvm}/{wvmid}/e/{eid}/features
Add a feature to the assembly feature list.
addFeature 4 params body → default
GET
/assemblies/d/{did}/{wvm}/{wvmid}/e/{eid}/featurespecs
Get the feature spec definitions for an assembly.
getFeatureSpecs 4 params → default
GET
/assemblies/d/{did}/{wvm}/{wvmid}/e/{eid}/massproperties
Get the mass properties for the assembly.
getAssemblyMassProperties 6 params → default
GET
/assemblies/d/{did}/{wvm}/{wvmid}/e/{eid}/namedpositions
Get a list of all named positions for the assembly.
getNamedPositions 7 params → default
GET
/assemblies/d/{did}/{wvm}/{wvmid}/e/{eid}/shadedviews
Get an array of shaded view images for the document.
getAssemblyShadedViews 18 params → default
POST
/assemblies/d/{did}/{wv}/{wvid}/e/{eid}/export/gltf
Export the assembly to glTF.
createAssemblyExportGltf 4 params body → default
POST
/assemblies/d/{did}/{wv}/{wvid}/e/{eid}/export/obj
Export the assembly to OBJ.
createAssemblyExportObj 4 params body → default
POST
/assemblies/d/{did}/{wv}/{wvid}/e/{eid}/export/step
Export the assembly to STEP.
createAssemblyExportStep 4 params body → default
GET
/assemblies/d/{did}/{wv}/{wvid}/e/{eid}/matevalues
Get a list of mate values in the specified assembly.
getMateValues 4 params → default
POST
/assemblies/d/{did}/{wv}/{wvid}/e/{eid}/translations
Export the assembly to another format.
translateFormat 4 params body → default

Schemas 105

The contract defines 105 schemas that model the data the API accepts and returns. The most detailed are BTTranslateFormatParams (102 properties), BTFeatureSpec-129 (35 properties), BTDocumentElementInfo (31 properties), BTLocationInfo-226 (18 properties). Each schema is shown below with its type and property counts.

BTRootAssemblyInfo
object
13 properties
BTAssemblyFeatureInfo
object
List of Assembly features including those are created by replicates.
5 properties
BTFeatureState-1688
object
3 properties
BTAssemblyDefinitionInfo
object
4 properties
BTMFeature-134
object
17 properties
GBTUiSelectionType
string
BTUiSelection-1185
object
6 properties
BTMAssemblyFeature-887
object
1 property
BTDisplayStateInfo
object
Describes a display state.
3 properties
GBTUrdfMeshFormat
string
BTAssemblyOccurrenceInfo
object
5 properties
BTAssemblyInstanceDefinitionParams
object
14 properties 1 required
GBTExportUnit
string
Units to export the model with.
GBTElementType
string
BTFeatureApiBase-1430
object
6 properties
BTVector3d-389
object
4 properties
GBTPDefinitionType
string
GBTPatternType
string
BTModelElementParams
object
1 property
GBTRhinoVersions
string
GBTStlEncodingType
string
STL encoding type, TEXT | BINARY
TransformGroup
object
2 properties
BTEditingLogic-2350
object
6 properties
BTPNode-7
object
10 properties
BTBObjExportParams
object
Options for exporting elements to OBJ.
12 properties
BTFeatureDefinitionCall-1406
object
7 properties
BTMNode-19
object
3 properties
BTTranslateFormatParams
object
102 properties 1 required
BTAssemblyMateValueInfo
object
Quantities for length are specified in meters, and quantities for angles are specified in radians.
4 properties 1 required
BTBExportAdvancedParams
object
Advanced element export options.
9 properties
BTAssemblyInstanceType
string
BTShadedViewsInfo
object
Images are returned as base64-encoded strings.
1 property
GBTInsertableType
string
BTAssemblyFeatureDataInfo
object
1 property
BTThumbnailInfo
object
4 properties
BTBoundingBoxInfo
object
6 properties
BTAssemblyFeatureListResponse-1174
object
1 property
BTAssemblyPartInfo
object
12 properties
GBTPreProcessParasolidOption
string
Original geometry processing mode to improve results of translation to STEP.
BTAssemblyTransformDefinitionParams
object
3 properties
GBTExportResolution
string
Determines export resolution of fine, medium, or coarse
BTPartsExportFilter-4308
object
Skip mesh/curve foreign data creation in individual parts export
4 properties
BTBStepExportParams
object
Options for exporting elements to STEP.
14 properties
BTGraphicsSectionPlaneData-1429
object
4 properties
BTFeatureSpec-129
object
35 properties
BTParameterSpec-6
object
16 properties
BTThumbnailSizeInfo
object
7 properties
BTAssemblyPsFeatureInfo
object
10 properties
BTSubAssemblyInfo
object
12 properties
BTMParameter-1
object
A list of parameter values for instantiation of the feature spec. Parameters are present for all defined parameters, even if not used in a specific instantiati…
7 properties
BTAssemblyInstanceInfo
object
List of instances including those created by patterns and replicates.
18 properties
BTBillOfMaterialsSourceInfo
object
8 properties
BTConfiguredValue
object
A value that varies per option of a configuration input.
2 properties
BTAssemblyParametricInstanceChildInfo
object
Children instance description of parametric instance.
2 properties
BTZipFileInfo
object
1 property
BTBGltfExportParams
object
Options for exporting elements to GLTF.
12 properties
BTApplicationTargetInfo
object
4 properties
BTNamedViewInfo
object
6 properties
GBTUIHint
string
BTParameterGroupSpec-3469
object
10 properties
BTBillOfMaterialsObjectWithPropertiesInfo
object
6 properties
GBTQuantityType
string
BTDocumentVersionElementIds-1897
object
4 properties
BTAssemblyPatternInfo
object
Pattern description.
6 properties
GBTNodeStatusType
string
BTBCloudStorageOptions
object
Options for exporting elements to cloud storage.
2 properties 2 required
BTOptionallyConfiguredValue
object
Optional map of configuration parameter id to value
2 properties
BTMassPropertiesInfo
object
Mass properties information.
9 properties
BTDocumentElementInfo
object
31 properties
BTObjectId
object
1 property
BTAssemblyModificationParams
object
6 properties
BTMetadataEnumValueInfo
object
3 properties
BTAssemblyMateValuesInfo
object
Get a list of mate values for all the mates of a specified assembly.
1 property
BTGraphicsSectionViewStateData-4379
object
6 properties
BTMateConnectorCSInfo
object
4 properties
BTAssemblyInstanceOccurrenceInfo
object
1 property
BTBillOfMaterialsRowInfo
object
10 properties
BTAssemblyInstanceStatus
string
BTAssemblyTransformedInstancesDefinitionParams
object
1 property
BTAssemblyMateConnectorInfo
object
2 properties
BTAssemblyPartBodyType
string
BTBExportMeshParams
object
Options for an element export to mesh format.
5 properties
BTBillOfMaterialsHeaderInfo
object
7 properties
BTBillOfMaterialsInfo
object
12 properties
BTBillOfMaterialsItemSourceInfo
object
16 properties
BTBAssemblyExportParams
object
Options for exporting assemblies.
1 property
BTLocationInfo-226
object
18 properties
BTAssemblyParametricInstanceInfo
object
Parametric instance description.
6 properties
GBTParasolidEncodingType
string
Export Parasolid in BINARY (.xb) or TEXT (.xt) mode.
BTFeatureSpecsResponse-664
object
7 properties
GBTParameterLibraryRelationType
string
BTPSpace-10
object
4 properties
BTTranslationRequestInfo
object
15 properties
BTParameterVisibilityCondition-177
object
2 properties
BTBillOfMaterialsElementInfo
object
7 properties
BTViewFeatureBaseInfo
object
Describes a view feature.
2 properties
BTMSuppressionState-1924
object
1 property
BTAssemblyInsertTransformedInstancesResponse
object
2 properties
BTTranslationRequestState
string
BTSelectedMetadataEnumValue
object
2 properties
BTFeatureDefinitionResponse-1617
object
8 properties
BTNamedViewsInfo
object
1 property
BTSectionPlaneInfo
object
3 properties
BTBEmailExportOptions
object
Options for exporting elements as a link in an email.
9 properties 3 required
BTOccurrence-74
object
7 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

onshape-assembly-api-openapi.yml Raw ↑

Other APIs Onshape publishes across the network.

Onshape Account API
AE Profile APIs.io
Onshape Alias API
AE Profile APIs.io
Onshape APIApplication API
AE Profile APIs.io
Onshape AppAssociativeData API
AE Profile APIs.io
Onshape AppElement API
AE Profile APIs.io
Onshape Billing API
AE Profile APIs.io
Onshape BlobElement API
AE Profile APIs.io
Onshape Comment API
AE Profile APIs.io
Onshape Company API
AE Profile APIs.io
Onshape Document API
AE Profile APIs.io
Onshape Drawing API
AE Profile APIs.io
Onshape Element API
AE Profile APIs.io
#Assembly
← Back to O APIs
API Details
ID
onshape:onshape-assembly-api
Base URL
https://cad.onshape.com/api/v16
Docs
https://onshape-public.github.io/docs/
Provider
Onshape
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=onshape-assembly-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/onshape-assembly-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of Onshape Assembly API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.