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

Access, create, and translate drawings.

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

Tagged areas include Drawing. 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 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.

7 operations 7 paths 31 schemas 4 GET3 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 Drawing 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 — 4 GET, 3 POST. Each is listed below with its method, path, parameters, and response codes.

Drawing 7

Access, create, and translate drawings.

POST
/drawings/d/{did}/w/{wid}/create
Create a new drawing in a document.
createDrawingAppElement 2 params body → default
POST
/drawings/d/{did}/w/{wid}/e/{eid}/modify
Modify a drawing via JSON payload.
modifyDrawing 4 params body → default
GET
/drawings/d/{did}/w/{wid}/e/{eid}/translationformats
Get a list of all valid formats the drawing can be translated (exported) to.
getDrawingTranslatorFormats 3 params → default
GET
/drawings/d/{did}/{wvm}/{wvmid}/e/{eid}/views
Get details of all drawing views.
getDrawingViews_1 7 params → default
GET
/drawings/d/{did}/{wvm}/{wvmid}/e/{eid}/views/{viewid}/jsongeometry
Get view geometry of a drawing view in JSON format.
getDrawingViewJsonGeometry_1 9 params → default
POST
/drawings/d/{did}/{wv}/{wvid}/e/{eid}/translations
Translate (export) a drawing to a different format.
createDrawingTranslation 4 params body → default
GET
/drawings/modify/status/{mrid}
Get the status of a drawing modification operation.
getModificationStatus 1 param → default

Schemas 31

The contract defines 31 schemas that model the data the API accepts and returns. The most detailed are BTTranslateFormatParams (102 properties), BTAppDrawingViewInfo (54 properties), BTDrawingParams (52 properties), BTDocumentElementInfo (31 properties). Each schema is shown below with its type and property counts.

BTThumbnailSizeInfo
object
7 properties
BTAppArrayInfoBTAppDrawingViewInfo
object
6 properties
BTDrawingHiddenLineOption
string
BTAppElementErrorCode
string
BTElementLocationParams
object
The location at which the new element should be inserted.
2 properties
BTDrawingParams
object
JSON schema for creating or updating a drawing.
52 properties
BTTranslateFormatParams
object
102 properties 1 required
GBTParasolidEncodingType
string
Export Parasolid in BINARY (.xb) or TEXT (.xt) mode.
BTZipFileInfo
object
1 property
BTBoundingBox-1052
object
An axis-aligned bounding box indicated by two opposite corners.
4 properties
BTBrokenOutEndCondition-1107
object
7 properties
GBTUrdfMeshFormat
string
BTApplicationTargetInfo
object
4 properties
BTBDrawingOperationParams
object
A single drawing entity creation or modification definition
4 properties 2 required
BTThumbnailInfo
object
4 properties
BTTranslationRequestInfo
object
15 properties
GBTElementType
string
BTAppModificationRequestState
string
BTDocumentElementInfo
object
31 properties
BTModelFormatInfo
object
3 properties
GBTPreProcessParasolidOption
string
Original geometry processing mode to improve results of translation to STEP.
BTTranslationRequestState
string
BTVector3d-389
object
4 properties
GBTAppElementReferenceType
string
BTAppDrawingViewInfo
object
54 properties
BTPartsExportFilter-4308
object
Skip mesh/curve foreign data creation in individual parts export
4 properties
GBTRhinoVersions
string
BTAppElementViewGeometryProperties-1100
object
2 properties
GBTStlEncodingType
string
STL encoding type, TEXT | BINARY
BTDrawingModificationParams
object
2 properties
BTAppModificationRequestInfo
object
15 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

onshape-drawing-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 Element API
Where this information came from

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