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

Onshape Element API

Access and manage Elements. Every Element in an Onshape document is represented by a tab.

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

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

This API exposes 8 operations across 7 paths, and defines 25 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.

8 operations 7 paths 25 schemas 1 DELETE3 GET4 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
License
Terms of Service
Resource Areas
1

Authentication & Security 2

Onshape Element 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 8

Across 7 paths, the API surfaces 8 operations — 1 DELETE, 3 GET, 4 POST. Each is listed below with its method, path, parameters, and response codes.

Element 8

Access and manage Elements. Every Element in an Onshape document is represented by a tab.

POST
/elements/copyelement/{did}/workspace/{wid}
Copy an element from a source document.
copyElementFromSourceDocument 2 params body → default
POST
/elements/d/{did}/e/{eid}/configurationencodings
Encode a configuration option for use in other API calls.
encodeConfigurationMap 4 params body → default
DELETE
/elements/d/{did}/w/{wid}/e/{eid}
Delete an element from a document.
deleteElement 3 params → default
POST
/elements/d/{did}/w/{wid}/e/{eid}/updatereferences
Update or replace references in an element.
updateReferences 3 params body → default
GET
/elements/d/{did}/{wvm}/{wvmid}/e/{eid}/configuration
Get the configuration definition for a Part Studio, Variable Studio, or Assembly.
getConfiguration 5 params → default
POST
/elements/d/{did}/{wvm}/{wvmid}/e/{eid}/configuration
Update the configuration definition for a Part Studio, Variable Studio, or Assembly.
updateConfiguration 4 params body → default
GET
/elements/d/{did}/{wvm}/{wvmid}/e/{eid}/configurationencodings/{cid}
Decode a configuration string.
decodeConfiguration 8 params → default
GET
/elements/translatorFormats/{did}/{wv}/{wvid}/{eid}
Gets the list of formats an element can be translated to or from.
getElementTranslatorFormatsByVersionOrWorkspace 7 params → default

Schemas 25

The contract defines 25 schemas that model the data the API accepts and returns. The most detailed are BTDocumentElementInfo (31 properties), BTUniqueDocumentItemParams (9 properties), ConfigurationInfoEntry (9 properties), BTConfigurationUpdateCall-2933 (8 properties). Each schema is shown below with its type and property counts.

BTThumbnailSizeInfo
object
7 properties
BTMConfigurationParameter-819
object
1 property
BTUniqueDocumentItemParams
object
9 properties
BTConfigurationResponse-2019
object
8 properties
BTConfigurationUpdateCall-2933
object
8 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
BTMNode-19
object
3 properties
BTConfigurationParams
object
2 properties
ConfigurationInfoEntry
object
9 properties
BTZipFileInfo
object
1 property
GBTParameterLibraryRelationType
string
BTApplicationTargetInfo
object
4 properties
GBTConfigurationParameterType
string
BTThumbnailInfo
object
4 properties
BTTreeNode-20
object
2 properties
BTParameterVisibilityCondition-177
object
2 properties
UpdateParams
object
4 properties
GBTElementType
string
BTDocumentElementInfo
object
31 properties
BTModelFormatInfo
object
3 properties
BTEncodedConfigurationInfo
object
2 properties
ConfigurationEntry
object
2 properties
BTCopyElementParams
object
5 properties
BTConfigurationInfo
object
2 properties
BTUpdateReferenceParams
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

onshape-element-api-openapi.yml Raw ↑

Other APIs Onshape publishes across the network.

Onshape Account API
Onshape Alias API
Onshape APIApplication API
Onshape AppAssociativeData API
Onshape AppElement API
Onshape Assembly API
Onshape Billing API
Onshape BlobElement API
Onshape Comment API
Onshape Company API
Onshape Document API
Onshape Drawing API
Where this information came from

This is an independent, third-party profile of Onshape Element 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.