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.0.1, 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 target version.
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.
BTFeatureState-1688
object
3 properties
BTVector2d-1812
object
3 properties
BTFSValue-1888
object
2 properties
1 required
BTExportModelEdge-1782
object
5 properties
BTEntityGeometry-35
object
7 properties
BTMFeature-134
object
17 properties
BTTreeEdit-13
object
4 properties
GBTUiSelectionType
string
BTExportModelLoop-1182
object
4 properties
BTUiSelection-1185
object
6 properties
BTPFunctionDeclaration-246
object
24 properties
BTAppearanceOverride-2517
object
6 properties
BTExportModelProperties-3216
object
3 properties
BTPTypeName-290
object
1 property
BTPartWithConfiguredProperties-2163
object
7 properties
AnimationSampler
object
5 properties
GBTTableTextAlignment
string
BTQueryFilter-183
object
1 property
BTUiFeatureStudioChecksum-2438
object
3 properties
BTApiTable-2300
object
6 properties
BTPExpression-9
object
1 property
BTGraphicsBuffer-2668
object
8 properties
BTIdTranslationInfo
object
5 properties
CameraPerspective
object
6 properties
BTBoundingBox-1052
object
An axis-aligned bounding box indicated by two opposite corners.
4 properties
BTDocumentWithVersionAndElementId
object
10 properties
GBTUrdfMeshFormat
string
BTApiConfiguration
object
6 properties
BTMModel-141
object
1 property
GBTConfigurationParameterType
string
Sampler
object
3 properties
BTApiTableList-1223
object
2 properties
BTConfigurableTreeNode
object
5 properties
BTMicroversionIdAndConfiguration-2338
object
6 properties
GBTExportUnit
string
Units to export the model with.
BTNotice-227
object
10 properties
BTInsertableDisplayData-2405
object
9 properties
MaterialNormalTextureInfo
object
5 properties
BTModelAnnotations-3945
object
1 property
GBTElementType
string
GBTAppearanceType
string
BTUpdateFeaturesResponse-1333
object
8 properties
BTFeatureApiBase-1430
object
6 properties
BTExportTessellatedFacesResponse-898
object
12 properties
GBTPartVisibility
string
BTPModule-234
object
1 property
BTDefaultFeatures-119
object
2 properties
GBTMeshState
string
BTVector3d-389
object
4 properties
AccessorData
object
3 properties
GBTPDefinitionType
string
BTMParameterQueryList-148
object
1 property
GBTMetadataSourceType
string
Buffer
object
5 properties
AccessorSparseValues
object
4 properties
Interpolation
string
BTModelElementParams
object
1 property
BTConfiguredPartProperties-2645
object
5 properties
BTExportModelCoedge-1342
object
3 properties
BTBasePartColorCycle-2614
object
1 property
GBTStlEncodingType
string
STL encoding type, TEXT | BINARY
TextureInfo
object
4 properties
GBTRhinoVersions
string
BTDocumentWithVersionId
object
2 properties
BTElementReference-725
object
10 properties
ObjectId
object
2 properties
Camera
object
6 properties
BTEditingLogic-2350
object
6 properties
BTPNode-7
object
10 properties
BTMParameterReferenceWithConfiguration-3028
object
16 properties
BTMicroversionIdInterval-367
object
4 properties
BTMVariableStudioReference-2764
object
1 property
Scene
object
4 properties
BTBObjExportParams
object
Options for exporting elements to OBJ.
12 properties
BTElementDisplayData-326
object
12 properties
BTMicroversionId-366
object
4 properties
BTPartStudioDisplayData-346
object
40 properties
BTFeatureDefinitionCall-1406
object
7 properties
BTMNode-19
object
3 properties
BTTranslateFormatParams
object
102 properties
1 required
BTPartMaterialProperty-1453
object
8 properties
BTBaseEntityAppearanceSettings-1391
object
3 properties
Image
object
6 properties
BTBExportAdvancedParams
object
Advanced element export options.
9 properties
AccessorSparse
object
5 properties
BTLazilyParsedFeatureScript
object
11 properties
BTShadedViewsInfo
object
Images are returned as base64-encoded strings.
1 property
BTFeatureListResponse-2457
object
List of features instantiated within the Part Studio.
12 properties
AccessorModel
object
12 properties
BTExportTessellatedEdgesResponse-327
object
3 properties
BTMRollback-150
object
1 property
BTPTopLevelImport-285
object
1 property
BTExportModelBody-1272
object
10 properties
BTSketchEntityDisplayData-354
object
2 properties
BTThumbnailInfo
object
4 properties
BTModelProperties-1258
object
3 properties
GBTTessellationSettingEnum
string
BTBaseEntityAppearanceEntry-3607
object
4 properties
BTImmutableByteArray
object
1 property
BTBoundingBoxInfo
object
6 properties
BTExportTessellatedBody-3398
object
4 properties
BTDiffInfoCollectionType
string
BTPModuleId-235
object
1 property
MaterialPbrMetallicRoughness
object
7 properties
GBTPreProcessParasolidOption
string
Original geometry processing mode to improve results of translation to STEP.
BTSetFeatureRollbackResponse-1042
object
8 properties
BTMUnitsDefault-160
object
1 property
BufferModel
object
4 properties
BTMParameterArray-2025
object
1 property
GBTExportResolution
string
Determines export resolution of fine, medium, or coarse
BTPartsExportFilter-4308
object
Skip mesh/curve foreign data creation in individual parts export
4 properties
BTBStepExportParams
object
Options for exporting elements to STEP.
14 properties
BTRootDiffInfo
object
17 properties
BTFeatureScriptEvalCall-2377
object
8 properties
BTGraphicsSectionPlaneData-1429
object
4 properties
BTSingleReferenceDisplayData-1943
object
11 properties
BTMArrayParameterItem-1843
object
1 property
BTFeatureSpec-129
object
35 properties
BTExportBodyProperties-3559
object
1 property
BTExportModelFace-1363
object
11 properties
BTPartMetadataSource-2895
object
3 properties
GBTPType
string
BTBSMatrix-386
object
18 properties
BTSurfaceDescription-1564
object
5 properties
GBTPartStudioDisplayDataVersion
string
BTThumbnailSizeInfo
object
7 properties
BTParameterSpec-6
object
16 properties
BTDimensionDisplayData-323
object
25 properties
BTImageMapping-3821
object
3 properties
BTMConfigurationParameter-819
object
1 property
BTUpdateFeaturesCall-1748
object
8 properties
BTClosedConstituentPartData-2911
object
5 properties
BTPArgumentDeclaration-232
object
1 property
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
BTCoordinateSystem-387
object
6 properties
BTPTopLevelNode-286
object
1 property
BTOnePartProperties-230
object
18 properties
BTPLiteralString-259
object
1 property
BTMImport-136
object
1 property
GBTValueUse
string
GBTSurfaceTypeEnum
string
Mesh
object
5 properties
BTZipFileInfo
object
1 property
BTBGltfExportParams
object
Options for exporting elements to GLTF.
12 properties
GBTDisplayDataUsage
string
BTPartProperties-293
object
7 properties
BTTessellationProperties-927
object
5 properties
GBTErrorStringEnum
string
BTPStatement-269
object
1 property
BTApplicationTargetInfo
object
4 properties
BTDomainSpecificMetadata-961
object
1 property
BTNamedViewInfo
object
6 properties
GBTUIHint
string
BTParameterGroupSpec-3469
object
10 properties
MaterialOcclusionTextureInfo
object
5 properties
GBTQuantityType
string
BTCacheDataPath-191
object
11 properties
BTParameterExpressionErrorInfo-2037
object
3 properties
BTMatrix3x3-340
object
10 properties
BTDocumentVersionElementIds-1897
object
4 properties
BTPLiteralNumber-258
object
13 properties
AccessorSparseIndices
object
5 properties
BTPAnnotation-231
object
11 properties
BTPLiteralMap-256
object
13 properties
GBTNodeStatusType
string
BTBCloudStorageOptions
object
Options for exporting elements to cloud storage.
2 properties
2 required
BTAnnotationElementDisplayData-894
object
3 properties
GBTGraphicsPrimitiveType
string
BTDocumentElementInfo
object
31 properties
BTMassPropertiesInfo
object
Mass properties information.
9 properties
GBTTolerancePrecision
string
Texture
object
5 properties
EditType
string
BTObjectId
object
1 property
BTFullElementId-756
object
6 properties
MeshPrimitive
object
7 properties
BTPLiteralMapEntry-257
object
1 property
GBTToleranceType
string
GBTCurveTypeEnum
string
BTBaseEntityData-33
object
10 properties
GBTAnnotationAttachmentLocation
string
BTGraphicsSectionViewStateData-4379
object
6 properties
BTCurveDescription-1583
object
5 properties
GBTGraphicsBufferTarget
string
BufferView
object
8 properties
GBTAnnotationType
string
AnimationChannelTarget
object
4 properties
CameraOrthographic
object
6 properties
BTPIdentifier-8
object
1 property
BTMIndividualQueryBase-139
object
1 property
BTBExportMeshParams
object
Options for an element export to mesh format.
5 properties
GBTBodyType
string
BTDecal-2404
object
3 properties
GBTSMApplicationType
string
Lines
object
BTBAssemblyExportParams
object
Options for exporting assemblies.
1 property
BTElementLibraryReferenceData-3133
object
6 properties
BTPartMaterial-1445
object
7 properties
BTPartData-16
object
30 properties
Skin
object
6 properties
BTPLiteral-253
object
1 property
BTPPropertyAccessor-23
object
1 property
BTLocationInfo-226
object
18 properties
BTSketchImageDisplayData-1379
object
10 properties
GBTNoticeLevel
string
GBTParasolidEncodingType
string
Export Parasolid in BINARY (.xb) or TEXT (.xt) mode.
BTMassPropertiesBulkInfo
object
2 properties
GlTF
object
19 properties
AnimationChannel
object
4 properties
BTAnnotationDisplayData-3225
object
19 properties
BTExportModelBodiesResponse-734
object
5 properties
BTFeatureSpecsResponse-664
object
7 properties
BTValueAndUse-4696
object
3 properties
GBTParameterLibraryRelationType
string
BTExportModelEdgeGeometry-1125
object
8 properties
GBTNodeChange
string
BTPartDisplayData-17
object
28 properties
Material
object
11 properties
BufferViewModel
object
7 properties
BTPSpace-10
object
4 properties
BTTreeNode-20
object
2 properties
BTParameterVisibilityCondition-177
object
2 properties
GBTNoticeType
string
BTNodeReference-21
object
3 properties
BTMAnnotation-4664
object
1 property
BTImport
object
2 properties
BTPStatementBlock-271
object
1 property
BTTranslationRequestInfo
object
15 properties
BTApiTableColumn-3141
object
4 properties
BTApiTableRow-2915
object
4 properties
ElementType
string
Animation
object
5 properties
BTMSuppressionState-1924
object
1 property
GBTPartFaultVisibility
string
Asset
object
6 properties
BTOneConfigurationPartProperties-1661
object
6 properties
BTPartCustomProperties-1338
object
12 properties
BTGraphicsAppearance-1152
object
8 properties
GBTBSFeatureVisibility
string
BTTranslationRequestState
string
BTFeatureScriptEvalResponse-1859
object
9 properties
BTMicroversionIdAndConfigurationInterval-2364
object
5 properties
BTDiffInfo
object
8 properties
BTFeatureDefinitionResponse-1617
object
8 properties
BTNamedViewsInfo
object
1 property
BTSectionPlaneInfo
object
3 properties
BTCosmeticThreadMetadata-3248
object
1 property
BTExportModelVertex-858
object
3 properties
BTAssemblyReferencesDisplayData-1562
object
13 properties
BTMConfigurationData-1560
object
1 property
BTIdTranslationResultInfo
object
3 properties
Node
object
12 properties
BTBEmailExportOptions
object
Options for exporting elements as a link in an email.
9 properties
3 required
BTOccurrence-74
object
7 properties
BTIdTranslationParams
object
5 properties
Accessor
object
12 properties
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 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
#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.