Onshape PartStudio API
Access and modify Part Studios.
Onshape PartStudio API is one of 42 APIs that Onshape publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include PartStudio. The published artifact set on APIs.io includes an OpenAPI specification and an API reference.
This API exposes 27 operations across 25 paths, and defines 256 schemas. It is described by OpenAPI 3.2.0, at version 1.218.84032-34acba44be17.
Requests are made against a single base URL, https://cad.onshape.com/api/v16.
27 operations
25 paths
256 schemas
1 DELETE15 GET11 POST
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 2
Onshape PartStudio 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 25 paths, the API surfaces 27 operations — 1 DELETE, 15 GET, 11 POST. Each is listed below with its method, path, parameters, and response codes.
PartStudio 27
Access and modify Part Studios.
GET
/partstudios/d/{did}/e/{eid}/namedViews
Get a list of all named views that exist in the Part Studio
POST
/partstudios/d/{did}/w/{wid}
Create a new Part Studio in a document
POST
/partstudios/d/{did}/w/{wid}/e/{eid}/features/featureid/{fid}
Update the definition of a Part Studio feature
DELETE
/partstudios/d/{did}/w/{wid}/e/{eid}/features/featureid/{fid}
Delete a Part Studio feature
POST
/partstudios/d/{did}/w/{wid}/e/{eid}/features/rollback
Move the Feature List rollback bar in the Part Studio
POST
/partstudios/d/{did}/w/{wid}/e/{eid}/features/updates
Update multiple features in a Part Studio
GET
/partstudios/d/{did}/{wvm}/{wvmid}/e/{eid}/bodydetails
Get the body details for a Part Studio
GET
/partstudios/d/{did}/{wvm}/{wvmid}/e/{eid}/boundingboxes
Get the bounding boxes for a Part Studio
GET
/partstudios/d/{did}/{wvm}/{wvmid}/e/{eid}/compare
Get the differences between two Part Studios in a single document
GET
/partstudios/d/{did}/{wvm}/{wvmid}/e/{eid}/features
Get a list of features instantiated in the Part Studio
POST
/partstudios/d/{did}/{wvm}/{wvmid}/e/{eid}/features
Add a feature to the Part Studio's Feature List
POST
/partstudios/d/{did}/{wvm}/{wvmid}/e/{eid}/featurescript
Evaluate the FeatureScript snippet for a Part Studio
GET
/partstudios/d/{did}/{wvm}/{wvmid}/e/{eid}/featurescriptrepresentation
Get the FeatureScript representation of a Part Studio
GET
/partstudios/d/{did}/{wvm}/{wvmid}/e/{eid}/featurespecs
Get the specs for a Part Studio feature
GET
/partstudios/d/{did}/{wvm}/{wvmid}/e/{eid}/fstable
Compute and return a FeatureScript table for a Part Studio
GET
/partstudios/d/{did}/{wvm}/{wvmid}/e/{eid}/gltf
Synchronously export a Part Studio to a glTF file
POST
/partstudios/d/{did}/{wvm}/{wvmid}/e/{eid}/idtranslations
Find corresponding deterministic IDs from a source document microversion at the…
GET
/partstudios/d/{did}/{wvm}/{wvmid}/e/{eid}/massproperties
Get the mass properties for a Part Studio
GET
/partstudios/d/{did}/{wvm}/{wvmid}/e/{eid}/parasolid
Synchronously export a Part Studio to a Parasolid file
GET
/partstudios/d/{did}/{wvm}/{wvmid}/e/{eid}/shadedviews
Get a list of shaded views for a Part Studio
GET
/partstudios/d/{did}/{wvm}/{wvmid}/e/{eid}/stl
Synchronously export a Part Studio to an STL file
GET
/partstudios/d/{did}/{wvm}/{wvmid}/e/{eid}/tessellatededges
Get a list of all edges in a Part Studio
GET
/partstudios/d/{did}/{wvm}/{wvmid}/e/{eid}/tessellatedfaces
Get a list of all faces in a Part Studio
POST
/partstudios/d/{did}/{wv}/{wvid}/e/{eid}/export/gltf
Asynchronously export a Part Studio to glTF
POST
/partstudios/d/{did}/{wv}/{wvid}/e/{eid}/export/obj
Asynchronously export a Part Studio to OBJ
POST
/partstudios/d/{did}/{wv}/{wvid}/e/{eid}/export/step
Asynchronously export a Part Studio to STEP
POST
/partstudios/d/{did}/{wv}/{wvid}/e/{eid}/translations
Asynchronously export a Part Studio to another format
Schemas 256
The contract defines 256 schemas that model the data the API accepts and returns. The most detailed are BTTranslateFormatParams (102 properties), BTPartStudioDisplayData-346 (40 properties), BTFeatureSpec-129 (35 properties), BTDocumentElementInfo (31 properties). Each schema is shown below with its type and property counts.
BTMSuppressionState-1924
object
1 property
GBTAnnotationAttachmentLocation
string
Asset
object
6 properties
BTExportModelCoedge-1342
object
3 properties
BTPModule-234
object
1 property
BTConfiguredPartProperties-2645
object
5 properties
BTModelElementParams
object
1 property
BTPLiteralMapEntry-257
object
1 property
BTMParameterReferenceWithConfiguration-3028
object
16 properties
BTBaseEntityAppearanceSettings-1391
object
3 properties
GBTPType
string
BTPartStudioDisplayData-346
object
40 properties
BTMNode-19
object
3 properties
GBTTableTextAlignment
string
ObjectId
object
2 properties
Image
object
6 properties
GBTSMApplicationType
string
Texture
object
5 properties
GBTNodeStatusType
string
BTMicroversionIdInterval-367
object
4 properties
BTNamedViewInfo
object
6 properties
BTPartWithConfiguredProperties-2163
object
7 properties
BTVector2d-1812
object
3 properties
GBTBodyType
string
BTMUnitsDefault-160
object
1 property
BTDocumentElementInfo
object
31 properties
GBTMetadataSourceType
string
GBTExportUnit
string
Units to export the model with.
BTPFunctionDeclaration-246
object
24 properties
BTBAssemblyExportParams
object
Options for exporting assemblies.
1 property
Animation
object
5 properties
BTApiTableRow-2915
object
4 properties
GBTNoticeType
string
BTFeatureScriptEvalCall-2377
object
8 properties
BTPartMaterialProperty-1453
object
8 properties
BufferViewModel
object
7 properties
BTElementLibraryReferenceData-3133
object
6 properties
AnimationChannelTarget
object
4 properties
BTImmutableByteArray
object
1 property
BTExportTessellatedEdgesResponse-327
object
3 properties
CameraOrthographic
object
6 properties
BTExportModelLoop-1182
object
4 properties
ElementType
string
BTOccurrence-74
object
7 properties
GBTPartStudioDisplayDataVersion
string
BTPExpression-9
object
1 property
GBTGraphicsBufferTarget
string
Camera
object
6 properties
BTPartsExportFilter-4308
object
Skip mesh/curve foreign data creation in individual parts export
4 properties
BTImageMapping-3821
object
3 properties
BTCacheDataPath-191
object
11 properties
BTCoordinateSystem-387
object
6 properties
AccessorData
object
3 properties
GBTToleranceType
string
GBTCurveTypeEnum
string
BTCurveDescription-1583
object
5 properties
Buffer
object
5 properties
GBTBSFeatureVisibility
string
BTPLiteral-253
object
1 property
BTPartMaterial-1445
object
7 properties
BTFeatureDefinitionResponse-1617
object
8 properties
BTPIdentifier-8
object
1 property
GBTUiSelectionType
string
GBTUIHint
string
BTExportModelProperties-3216
object
3 properties
GBTValueUse
string
AccessorSparseValues
object
4 properties
BTPartCustomProperties-1338
object
12 properties
BTMRollback-150
object
1 property
BTMicroversionIdAndConfigurationInterval-2364
object
5 properties
BTMIndividualQueryBase-139
object
1 property
Lines
object
Accessor
object
12 properties
BTElementDisplayData-326
object
12 properties
BTUiFeatureStudioChecksum-2438
object
3 properties
BTFSValue-1888
object
2 properties
1 required
BTNodeReference-21
object
3 properties
BTIdTranslationInfo
object
5 properties
BTSetFeatureRollbackResponse-1042
object
8 properties
BTNotice-227
object
10 properties
GBTNodeChange
string
BTOneConfigurationPartProperties-1661
object
6 properties
BTExportBodyProperties-3559
object
1 property
GBTPartVisibility
string
BTPStatementBlock-271
object
1 property
BTExportModelEdgeGeometry-1125
object
8 properties
CameraPerspective
object
6 properties
MeshPrimitive
object
7 properties
BTGraphicsBuffer-2668
object
8 properties
BTAssemblyReferencesDisplayData-1562
object
13 properties
BTIdTranslationResultInfo
object
3 properties
BTExportModelFace-1363
object
11 properties
BTMicroversionId-366
object
4 properties
BTDocumentWithVersionAndElementId
object
10 properties
BTBGltfExportParams
object
Options for exporting elements to GLTF.
12 properties
BTThumbnailSizeInfo
object
7 properties
BTLazilyParsedFeatureScript
object
11 properties
MaterialPbrMetallicRoughness
object
7 properties
BTParameterExpressionErrorInfo-2037
object
3 properties
BTEditingLogic-2350
object
6 properties
BTPartDisplayData-17
object
28 properties
BTTreeEdit-13
object
4 properties
BTBSMatrix-386
object
18 properties
GBTNoticeLevel
string
BTEntityGeometry-35
object
7 properties
BTSingleReferenceDisplayData-1943
object
11 properties
BTPArgumentDeclaration-232
object
1 property
BTParameterSpec-6
object
16 properties
BTMConfigurationParameter-819
object
1 property
BTAnnotationDisplayData-3225
object
19 properties
BTLocationInfo-226
object
18 properties
BTValueAndUse-4696
object
3 properties
BTZipFileInfo
object
1 property
BufferModel
object
4 properties
BTParameterGroupSpec-3469
object
10 properties
BTMArrayParameterItem-1843
object
1 property
BTBStepExportParams
object
Options for exporting elements to STEP.
14 properties
BTMImport-136
object
1 property
GBTGraphicsPrimitiveType
string
BTImport
object
2 properties
BTThumbnailInfo
object
4 properties
BTBaseEntityData-33
object
10 properties
GBTConfigurationParameterType
string
GBTRhinoVersions
string
BTExportTessellatedFacesResponse-898
object
12 properties
GBTAnnotationType
string
BTParameterVisibilityCondition-177
object
2 properties
BTMAnnotation-4664
object
1 property
BTTranslationRequestInfo
object
15 properties
BTConfigurableTreeNode
object
5 properties
BTPLiteralNumber-258
object
13 properties
GBTUrdfMeshFormat
string
BTExportModelVertex-858
object
3 properties
BTClosedConstituentPartData-2911
object
5 properties
BTPSpace-10
object
4 properties
BTSectionPlaneInfo
object
3 properties
BTTranslationRequestState
string
BTModelAnnotations-3945
object
1 property
BTMConfigurationData-1560
object
1 property
BTFullElementId-756
object
6 properties
BTMicroversionIdAndConfiguration-2338
object
6 properties
Sampler
object
3 properties
BTBoundingBox-1052
object
An axis-aligned bounding box indicated by two opposite corners.
4 properties
BTDiffInfoCollectionType
string
BTUiSelection-1185
object
6 properties
BTOnePartProperties-230
object
18 properties
GBTExportResolution
string
Determines export resolution of fine, medium, or coarse
BTMassPropertiesInfo
object
Mass properties information.
9 properties
BTFeatureApiBase-1430
object
6 properties
BTBoundingBoxInfo
object
6 properties
BTShadedViewsInfo
object
Images are returned as base64-encoded strings.
1 property
BTDiffInfo
object
8 properties
BTBaseEntityAppearanceEntry-3607
object
4 properties
BTVector3d-389
object
4 properties
Interpolation
string
Material
object
11 properties
GBTAppearanceType
string
BTUpdateFeaturesCall-1748
object
8 properties
BTDomainSpecificMetadata-961
object
1 property
BTApiTableColumn-3141
object
4 properties
BTElementReference-725
object
10 properties
BTPNode-7
object
10 properties
BTModelProperties-1258
object
3 properties
EditType
string
GBTPDefinitionType
string
BTBExportMeshParams
object
Options for an element export to mesh format.
5 properties
MaterialNormalTextureInfo
object
5 properties
GBTParasolidEncodingType
string
Export Parasolid in BINARY (.xb) or TEXT (.xt) mode.
BTFeatureListResponse-2457
object
List of features instantiated within the Part Studio.
12 properties
BTFeatureSpec-129
object
35 properties
BTPStatement-269
object
1 property
BTObjectId
object
1 property
BTFeatureDefinitionCall-1406
object
7 properties
BTMatrix3x3-340
object
10 properties
BTSketchEntityDisplayData-354
object
2 properties
BTQueryFilter-183
object
1 property
BTPTopLevelImport-285
object
1 property
BTFeatureScriptEvalResponse-1859
object
9 properties
BTBExportAdvancedParams
object
Advanced element export options.
9 properties
GBTParameterLibraryRelationType
string
GBTMeshState
string
GBTPreProcessParasolidOption
string
Original geometry processing mode to improve results of translation to STEP.
Skin
object
6 properties
BTDimensionDisplayData-323
object
25 properties
BTAnnotationElementDisplayData-894
object
3 properties
BTPAnnotation-231
object
11 properties
BTApiTableList-1223
object
2 properties
BTTreeNode-20
object
2 properties
BTMassPropertiesBulkInfo
object
2 properties
AccessorModel
object
12 properties
BTPartProperties-293
object
7 properties
BTPartData-16
object
30 properties
Mesh
object
5 properties
BTBasePartColorCycle-2614
object
1 property
GBTTessellationSettingEnum
string
BTGraphicsSectionPlaneData-1429
object
4 properties
BTApiTable-2300
object
6 properties
TextureInfo
object
4 properties
BTExportTessellatedBody-3398
object
4 properties
BTPTopLevelNode-286
object
1 property
BTBEmailExportOptions
object
Options for exporting elements as a link in an email.
9 properties
3 required
BTNamedViewsInfo
object
1 property
AnimationSampler
object
5 properties
BTFeatureState-1688
object
3 properties
BTApiConfiguration
object
6 properties
BTIdTranslationParams
object
5 properties
BTDocumentVersionElementIds-1897
object
4 properties
BTSurfaceDescription-1564
object
5 properties
BTBObjExportParams
object
Options for exporting elements to OBJ.
12 properties
BTPLiteralString-259
object
1 property
BTPPropertyAccessor-23
object
1 property
BTTessellationProperties-927
object
5 properties
Node
object
12 properties
MaterialOcclusionTextureInfo
object
5 properties
BTApplicationTargetInfo
object
4 properties
BTInsertableDisplayData-2405
object
9 properties
BTRootDiffInfo
object
17 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
AccessorSparseIndices
object
5 properties
BTMVariableStudioReference-2764
object
1 property
AccessorSparse
object
5 properties
BTGraphicsAppearance-1152
object
8 properties
BufferView
object
8 properties
GBTErrorStringEnum
string
Scene
object
4 properties
BTPTypeName-290
object
1 property
BTExportModelEdge-1782
object
5 properties
BTFeatureSpecsResponse-664
object
7 properties
BTGraphicsSectionViewStateData-4379
object
6 properties
BTMFeature-134
object
17 properties
BTDefaultFeatures-119
object
2 properties
BTPModuleId-235
object
1 property
BTPLiteralMap-256
object
13 properties
BTDecal-2404
object
3 properties
BTExportModelBodiesResponse-734
object
5 properties
BTCosmeticThreadMetadata-3248
object
1 property
BTTranslateFormatParams
object
102 properties
1 required
GBTSurfaceTypeEnum
string
AnimationChannel
object
4 properties
GBTQuantityType
string
GBTTolerancePrecision
string
BTDocumentWithVersionId
object
2 properties
BTPartMetadataSource-2895
object
3 properties
BTSketchImageDisplayData-1379
object
10 properties
BTExportModelBody-1272
object
10 properties
GBTElementType
string
GBTDisplayDataUsage
string
GlTF
object
19 properties
BTUpdateFeaturesResponse-1333
object
8 properties
BTBCloudStorageOptions
object
Options for exporting elements to cloud storage.
2 properties
2 required
BTMModel-141
object
1 property
BTMParameterQueryList-148
object
1 property
BTAppearanceOverride-2517
object
6 properties
BTMParameterArray-2025
object
1 property
GBTStlEncodingType
string
STL encoding type, TEXT | BINARY
GBTPartFaultVisibility
string
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Onshape 12
Other APIs Onshape publishes across the network.
Onshape Account API
Onshape Alias 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
Onshape Element API
#PartStudio
Where this information came from
This is an independent, third-party profile of Onshape PartStudio 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.