Onshape

Onshape Assembly API

Create and manage assemblies.

GitHub OpenAPI
Business capability
Product Design Management BC-820.20

Operations 27

GET /assemblies/d/{did}/e/{eid}/namedViews Get the view data for all named views for the specified element #
POST /assemblies/d/{did}/w/{wid} Create a new assembly tab in the document #
POST /assemblies/d/{did}/w/{wid}/e/{eid}/bomelement Gets the Bill Of Materials (BOM) for the specified assembly, or creates a BOM… #
POST /assemblies/d/{did}/w/{wid}/e/{eid}/features/featureid/{fid} Update an existing feature for an Assembly #
DELETE /assemblies/d/{did}/w/{wid}/e/{eid}/features/featureid/{fid} Delete a feature from an assembly #
DELETE /assemblies/d/{did}/w/{wid}/e/{eid}/instance/nodeid/{nid} Delete an instance of an assembly #
POST /assemblies/d/{did}/w/{wid}/e/{eid}/instances Insert an instance of a part, sketch, assembly, or Part Studio into an assembly #
POST /assemblies/d/{did}/w/{wid}/e/{eid}/matevalues Update mate values for the given mates in the specified assembly #
POST /assemblies/d/{did}/w/{wid}/e/{eid}/modify Modify an assembly #
POST /assemblies/d/{did}/w/{wid}/e/{eid}/occurrencetransforms Transform a list of assembly occurrences #
POST /assemblies/d/{did}/w/{wid}/e/{eid}/transformedinstances Create new instances with transformation #
GET /assemblies/d/{did}/{wvm}/{wvmid}/e/{eid} Get definition information for the specified assembly #
GET /assemblies/d/{did}/{wvm}/{wvmid}/e/{eid}/bom Get the Bill Of Materials (BOM) content for the specified assembly #
GET /assemblies/d/{did}/{wvm}/{wvmid}/e/{eid}/boundingboxes Get bounding box information for the specified assembly #
GET /assemblies/d/{did}/{wvm}/{wvmid}/e/{eid}/displaystates Get a list of display states for the specified assembly #
GET /assemblies/d/{did}/{wvm}/{wvmid}/e/{eid}/explodedviews Get a list of exploded views for the specified assembly #
GET /assemblies/d/{did}/{wvm}/{wvmid}/e/{eid}/features Get the definitions of the specified features in an assembly #
POST /assemblies/d/{did}/{wvm}/{wvmid}/e/{eid}/features Add a feature to the assembly feature list #
GET /assemblies/d/{did}/{wvm}/{wvmid}/e/{eid}/featurespecs Get the feature spec definitions for an assembly #
GET /assemblies/d/{did}/{wvm}/{wvmid}/e/{eid}/massproperties Get the mass properties for the assembly #
GET /assemblies/d/{did}/{wvm}/{wvmid}/e/{eid}/namedpositions Get a list of all named positions for the assembly #
GET /assemblies/d/{did}/{wvm}/{wvmid}/e/{eid}/shadedviews Get an array of shaded view images for the document #
POST /assemblies/d/{did}/{wv}/{wvid}/e/{eid}/export/gltf Export the assembly to glTF #
POST /assemblies/d/{did}/{wv}/{wvid}/e/{eid}/export/obj Export the assembly to OBJ #
POST /assemblies/d/{did}/{wv}/{wvid}/e/{eid}/export/step Export the assembly to STEP #
GET /assemblies/d/{did}/{wv}/{wvid}/e/{eid}/matevalues Get a list of mate values in the specified assembly #
POST /assemblies/d/{did}/{wv}/{wvid}/e/{eid}/translations Export the assembly to another format #

Documentation

📖
APIReference
https://cad.onshape.com/glassworks/explorer/

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/onshape/refs/heads/main/openapi/onshape-assembly-api-openapi.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/onshape-assembly-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

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

OpenAPI Specification

onshape-assembly-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Onshape REST Assembly API
  description: '## Welcome to the Onshape REST API Explorer


    **See the API Explorer Guide for help navigating this page.**


    ### Using this page

    1.'
  termsOfService: https://www.onshape.com/legal/terms-of-use
  contact:
    email: api-support@onshape.zendesk.com
  license:
    name: Apache 2.0
    url: http://www.apache.org/licenses/LICENSE-2.0.html
  version: 1.218.84032-34acba44be17
  x-logo:
    url: images/logo-onshape-gray-green-nav-bar.svg
    backgroundColor: '#ffffff'
    altText: Onshape
    href: images/logo-onshape-gray-green-nav-bar.svg
  x-indeterministic-schemas:
  - BTDiffInfo
  - BTParameterSpecArray-2600
  - BTSplineDescription-2118
  - NodeModel
  - BTPFunctionDeclaration-246
  - BTPFunctionOrPredicateDeclaration-247
  - BTPExpression-9
  - SkinModel
  - BTMAnnotation-4664
  x-filter-info: ?restUserRole=PUBLIC
servers:
- url: https://cad.onshape.com/api/v16
  description: Current
security:
- BasicAuth: []
tags:


# --- truncated at 32 KB (137 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/onshape/refs/heads/main/openapi/onshape-assembly-api-openapi.yml