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

Create, modify, and access variables.

Documentation Provider Profile APIs.io OpenAPI GitHub

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

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

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

7 operations 7 paths 16 schemas 3 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 Variables 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 7

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

Variables 7

Create, modify, and access variables.

POST
/variables/d/{did}/w/{wid}/e/{eid}/variables
Assign variables to a Variable Studio
setVariables 4 params body → default
POST
/variables/d/{did}/w/{wid}/e/{eid}/variablestudioreferences
Set the Variable Studio references for an element.
setVariableStudioReferences 4 params body → default
POST
/variables/d/{did}/w/{wid}/e/{eid}/variablestudioscope
Set the scope the Variable Studio.
setVariableStudioScope 4 params body → default
POST
/variables/d/{did}/w/{wid}/variablestudio
Create a new Variable Studio in a document and workspace.
createVariableStudio 3 params body → default
GET
/variables/d/{did}/{wv}/{wvid}/e/{eid}/variables
Get the contents of all variable tables in an element.
getVariables 7 params → default
GET
/variables/d/{did}/{wv}/{wvid}/e/{eid}/variablestudioreferences
Get the Variable Studio references for an element.
getVariableStudioReferences 5 params → default
GET
/variables/d/{did}/{wv}/{wvid}/e/{eid}/variablestudioscope
Get the scope of a Variable Studio.
getVariableStudioScope 5 params → default

Schemas 16

The contract defines 16 schemas that model the data the API accepts and returns. The most detailed are BTDocumentElementInfo (31 properties), BTThumbnailSizeInfo (7 properties), BTVariableParams (6 properties), BTVariableStudioReferenceInfo (6 properties). Each schema is shown below with its type and property counts.

BTVariableTableInfo
object
2 properties 1 required
BTThumbnailInfo
object
4 properties
BTVariableParams
object
6 properties 2 required
BTApplicationTargetInfo
object
4 properties
BTThumbnailSizeInfo
object
7 properties
BTVariableInfo
object
Variables in the VariableTable
5 properties 4 required
BTConfiguredValue
object
A value that varies per option of a configuration input.
2 properties
BTZipFileInfo
object
1 property
BTVariableStudioScopeInfo
object
1 property 1 required
BTModelElementParams
object
1 property
GBTVariableType
string
Variable type name, from FeatureScript VariableType
BTOptionallyConfiguredValue
object
Optional map of configuration parameter id to value
2 properties
GBTElementType
string
BTDocumentElementInfo
object
31 properties
BTVariableStudioReferenceListInfo
object
1 property
BTVariableStudioReferenceInfo
object
List of variable studio references
6 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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