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 AppElement API

Access and modify application elements.

Documentation Provider Profile APIs.io OpenAPI GitHub

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

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

This API exposes 27 operations across 20 paths, and defines 31 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 20 paths 31 schemas 5 DELETE13 GET9 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 AppElement 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 20 paths, the API surfaces 27 operations — 5 DELETE, 13 GET, 9 POST. Each is listed below with its method, path, parameters, and response codes.

AppElement 27

Access and modify application elements.

POST
/appelements/d/{did}/w/{wid}
Create a new application element.
createElement 3 params body → default
POST
/appelements/d/{did}/w/{wid}/bulkcreate
Create multiple empty application elements at once.
bulkCreateElement 3 params body → default
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 document's workspace.
downloadBlobSubelementWorkspace 8 params → default
POST
/appelements/d/{did}/w/{wid}/e/{eid}/blob/{bid}
Create a new blob subelement from an uploaded file.
uploadBlobSubelement 4 params body → default
DELETE
/appelements/d/{did}/w/{wid}/e/{eid}/blob/{bid}
Delete a blob subelement from an app element.
deleteBlobSubelement 6 params → default
GET
/appelements/d/{did}/w/{wid}/e/{eid}/transactions
Get a list of all transactions performed on an element.
getElementTransactions 3 params → default
POST
/appelements/d/{did}/w/{wid}/e/{eid}/transactions
Start a transaction
startTransaction 3 params body → default
DELETE
/appelements/d/{did}/w/{wid}/e/{eid}/transactions/{tid}
Abort a transaction.
abortTransaction 5 params → default
POST
/appelements/d/{did}/w/{wid}/transactions
Merge multiple transactions into one microversion.
commitTransactions 3 params body → default
GET
/appelements/d/{did}/{vm}/{vmid}/e/{eid}/blob/{bid}
Download a blob subelement from the specified app element.
downloadBlobSubelement 10 params → default
GET
/appelements/d/{did}/{wvm}/{wvmid}/e/{eid}/blob
Get a list of all blob subelement IDs for the specified workspace, version, or microversion.
getBlobSubelementIds 6 params → default
GET
/appelements/d/{did}/{wvm}/{wvmid}/e/{eid}/compare
Compare app element JSON trees between workspaces/versions/microversions in a document.
compareAppElementJson 9 params → default
GET
/appelements/d/{did}/{wvm}/{wvmid}/e/{eid}/content
Get a list of all subelement IDs in a specified workspace/version/microversion.
getSubElementContent 9 params → default
POST
/appelements/d/{did}/{wvm}/{wvmid}/e/{eid}/content
Update the content for the specified app element.
updateAppElement 4 params body → default
GET
/appelements/d/{did}/{wvm}/{wvmid}/e/{eid}/content/history
Get the history of the specified all element.
getAppElementHistory 4 params → default
GET
/appelements/d/{did}/{wvm}/{wvmid}/e/{eid}/content/ids
Get a list of all subelement IDs in a specified workspace/version/microversion.
getSubelementIds 6 params → default
GET
/appelements/d/{did}/{wvm}/{wvmid}/e/{eid}/content/json
Get the full JSON tree for the specified workspace/version/microversion.
getJson 7 params → default
POST
/appelements/d/{did}/{wvm}/{wvmid}/e/{eid}/content/jsonpaths
Get the JSON at specified paths for an element.
getJsonPaths 7 params body → default
GET
/appelements/d/{did}/{wvm}/{wvmid}/e/{eid}/content/subelements
Get a list of multiple subelements by document ID, workspace or version or microversion ID, tab ID, and subelement IDs.
getSubElementContentBatch 9 params → default
DELETE
/appelements/d/{did}/{wvm}/{wvmid}/e/{eid}/content/subelements
Delete multiple subelements array by document ID, workspace or version or microversion ID, tab ID, and subelement IDs.
deleteAppElementContentBatch 8 params → default
DELETE
/appelements/d/{did}/{wvm}/{wvmid}/e/{eid}/content/subelements/{sid}
Deletes the content from the specified app element.
deleteAppElementContent 8 params → default
POST
/appelements/d/{did}/{wvm}/{wvmid}/e/{eid}/references
Creates a reference to an app element.
createReference 4 params body → default
GET
/appelements/d/{did}/{wvm}/{wvmid}/e/{eid}/references/{rid}
Resolves a single reference to an app element.
resolveReference 9 params → default
POST
/appelements/d/{did}/{wvm}/{wvmid}/e/{eid}/references/{rid}
Update an app element reference.
updateReference 5 params body → default
DELETE
/appelements/d/{did}/{wvm}/{wvmid}/e/{eid}/references/{rid}
Delete an app element reference.
deleteReference 8 params → default
GET
/appelements/d/{did}/{wvm}/{wvmid}/e/{eid}/resolvereferences
Resolves bulk app element references.
resolveReferences 9 params → default
GET
/appelements/d/{did}/{wvm}/{wvmid}/resolvereferences
Resolves bulk app element references.
resolveAllElementReferences 10 params → default

Schemas 31

The contract defines 31 schemas that model the data the API accepts and returns. The most detailed are BTAppElementReferenceResolveInfo (29 properties), BTAppElementReferenceParams (21 properties), BTAppElementBulkModifyInfo (12 properties), BTAppElementModifyInfo (10 properties). Each schema is shown below with its type and property counts.

BTJEdit-3734
object
An edit that will be applied to the application element's json data.
1 property 1 required
BTElementTransaction
object
6 properties
BTAppElementReferenceParams
object
21 properties
BTAppElementReferenceInfo
object
7 properties 1 required
BTAppElementStartTransactionParams
object
3 properties
BTAppElementReferenceResolveInfo
object
29 properties
BTAppElementErrorCode
string
BTAppElementContentEntryInfo
object
3 properties
BTGetJsonPaths-1697
object
2 properties
BTElementLocationParams
object
The location at which the new element should be inserted.
2 properties
BTAppElementTransactionsInfo
object
4 properties
BTGetJsonResponse-2137
object
3 properties
BTAppElementUpdateParams
object
8 properties
BTAppElementContentDeltaInfo
object
1 property
BTAppElementBulkCreateParams
object
4 properties 1 required
BTAppElementHistoryInfo
object
4 properties
BTDiffJsonResponse-2725
object
5 properties
BTAppElementHistoryEntryInfo
object
3 properties
BTAppElementChangeParams
object
3 properties 1 required
BTBAppElementBlobUploadParams
object
5 properties
BTJsonMatch-2290
object
3 properties
BTAppElementBulkCreateInfo
object
6 properties 1 required
BTAppElementReferencesResolveInfo
object
2 properties
BTAppElementIdsInfo
object
5 properties
BTAppElementModifyInfo
object
10 properties 1 required
BTAppElementParams
object
6 properties 1 required
BTAppElementBulkModifyInfo
object
12 properties
BTMetadataPropertyUpdateParams
object
2 properties
BTAppElementCommitTransactionParams
object
4 properties
BTGetJsonPathsResponse-1544
object
3 properties
BTAppElementContentInfo
object
5 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

onshape-appelement-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 Assembly 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
#AppElement
← Back to O APIs
API Details
ID
onshape:onshape-appelement-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-appelement-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/onshape-appelement-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 AppElement 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.