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

Access and modify metadata.

Documentation Provider Profile APIs.io OpenAPI GitHub

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

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

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

11 operations 8 paths 13 schemas 7 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
Contact
api-support@onshape.zendesk.com
License
Apache 2.0
Terms of Service
View terms
Resource Areas
1

Authentication & Security 2

Onshape Metadata 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 11

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

Metadata 11

Access and modify metadata.

GET
/metadata/d/{did}/{wvm}/{wvmid}/e
Get the metadata for all elements in a document.
getWMVEsMetadata 9 params → default
GET
/metadata/d/{did}/{wvm}/{wvmid}/e/{eid}
Get the metadata for an element.
getWMVEMetadata 11 params → default
POST
/metadata/d/{did}/{wvm}/{wvmid}/e/{eid}
Update the metadata for an element.
updateWVEMetadata 5 params body → default
GET
/metadata/d/{did}/{wvm}/{wvmid}/e/{eid}/assembly-debug
Get the metadata for an assembly, including supporting metadata.
getFullAssemblyMetadata 6 params → default
GET
/metadata/d/{did}/{wvm}/{wvmid}/e/{eid}/p
Get the metadata for all parts in a document.
getWMVEPsMetadata 10 params → default
GET
/metadata/d/{did}/{wvm}/{wvmid}/e/{eid}/{iden}/{pid}
Get the metadata for a part.
getWMVEPMetadata 14 params → default
POST
/metadata/d/{did}/{wvm}/{wvmid}/e/{eid}/{iden}/{pid}
Update the metadata for a part.
updateWVEPMetadata 10 params body → default
GET
/metadata/d/{did}/{wv}/{wvid}
Get the metadata for a workspace or version.
getWVMetadata 9 params → default
POST
/metadata/d/{did}/{wv}/{wvid}
Update the metadata for a workspace or version.
updateWVMetadata 3 params body → default
POST
/metadata/standardcontent/d/{did}
Update the metadata for a standard content part.
updateVEOPStandardContentPartMetadata 3 params body → default
GET
/metadata/standardcontent/d/{did}/v/{vid}/e/{eid}/p/{pid}
Get the metadata for a standard content part.
getVEOPStandardContentMetadata 10 params → default

Schemas 13

The contract defines 13 schemas that model the data the API accepts and returns. The most detailed are BTMetadataPropertyInfo (24 properties), BTMetadataPropertyValidatorInfo (10 properties), BTAssemblyItemMetadataRequestInfo (8 properties), BTAssemblyItemMetadataInfo (7 properties). Each schema is shown below with its type and property counts.

BTMetadataPropertyUiHintsInfo
object
1 property
BTThumbnailInfo
object
4 properties
BTThumbnailSizeInfo
object
7 properties
BTMetadataElementInfo
object
BTMetadataObjectListInfoBTMetadataPartInfo
object
4 properties
BTMetadataPartInfo
object
BTMetadataEnumValueInfo
object
3 properties
BTAssemblyItemMetadataInfo
object
7 properties
BTAssemblyItemMetadataRequestInfo
object
8 properties
BTMetadataObjectListInfoBTMetadataElementInfo
object
4 properties
BTMetadataPropertyValidatorInfo
object
10 properties
BTMetadataObjectInfo
object
4 properties 1 required
BTMetadataPropertyInfo
object
24 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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