Onshape

Onshape AppElement API

Access and modify application elements.

GitHub OpenAPI

Operations 27

POST /appelements/d/{did}/w/{wid} Create a new application element #
POST /appelements/d/{did}/w/{wid}/bulkcreate Create multiple empty application elements at once #
GET /appelements/d/{did}/w/{wid}/e/{eid}/blob/{bid} Download the blob element (i.e., a file) stored in an app element in a… #
POST /appelements/d/{did}/w/{wid}/e/{eid}/blob/{bid} Create a new blob subelement from an uploaded file #
DELETE /appelements/d/{did}/w/{wid}/e/{eid}/blob/{bid} Delete a blob subelement from an app element #
GET /appelements/d/{did}/w/{wid}/e/{eid}/transactions Get a list of all transactions performed on an element #
POST /appelements/d/{did}/w/{wid}/e/{eid}/transactions Start a transaction #
DELETE /appelements/d/{did}/w/{wid}/e/{eid}/transactions/{tid} Abort a transaction #
POST /appelements/d/{did}/w/{wid}/transactions Merge multiple transactions into one microversion #
GET /appelements/d/{did}/{vm}/{vmid}/e/{eid}/blob/{bid} Download a blob subelement from the specified app element #
GET /appelements/d/{did}/{wvm}/{wvmid}/e/{eid}/blob Get a list of all blob subelement IDs for the specified workspace, version, or… #
GET /appelements/d/{did}/{wvm}/{wvmid}/e/{eid}/compare Compare app element JSON trees between workspaces/versions/microversions in a… #
GET /appelements/d/{did}/{wvm}/{wvmid}/e/{eid}/content Get a list of all subelement IDs in a specified workspace/version/microversion #
POST /appelements/d/{did}/{wvm}/{wvmid}/e/{eid}/content Update the content for the specified app element #
GET /appelements/d/{did}/{wvm}/{wvmid}/e/{eid}/content/history Get the history of the specified all element #
GET /appelements/d/{did}/{wvm}/{wvmid}/e/{eid}/content/ids Get a list of all subelement IDs in a specified workspace/version/microversion #
GET /appelements/d/{did}/{wvm}/{wvmid}/e/{eid}/content/json Get the full JSON tree for the specified workspace/version/microversion #
POST /appelements/d/{did}/{wvm}/{wvmid}/e/{eid}/content/jsonpaths Get the JSON at specified paths for an element #
GET /appelements/d/{did}/{wvm}/{wvmid}/e/{eid}/content/subelements Get a list of multiple subelements by document ID, workspace or version or… #
DELETE /appelements/d/{did}/{wvm}/{wvmid}/e/{eid}/content/subelements Delete multiple subelements array by document ID, workspace or version or… #
DELETE /appelements/d/{did}/{wvm}/{wvmid}/e/{eid}/content/subelements/{sid} Deletes the content from the specified app element #
POST /appelements/d/{did}/{wvm}/{wvmid}/e/{eid}/references Creates a reference to an app element #
GET /appelements/d/{did}/{wvm}/{wvmid}/e/{eid}/references/{rid} Resolves a single reference to an app element #
POST /appelements/d/{did}/{wvm}/{wvmid}/e/{eid}/references/{rid} Update an app element reference #
DELETE /appelements/d/{did}/{wvm}/{wvmid}/e/{eid}/references/{rid} Delete an app element reference #
GET /appelements/d/{did}/{wvm}/{wvmid}/e/{eid}/resolvereferences Resolves bulk app element references #
GET /appelements/d/{did}/{wvm}/{wvmid}/resolvereferences Resolves bulk app element references #

Documentation

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

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/onshape/refs/heads/main/openapi/onshape-appelement-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-appelement-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-appelement-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Onshape REST App Element 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 (67 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/onshape/refs/heads/main/openapi/onshape-appelement-api-openapi.yml