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

Create, read, update, and delete comments.

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

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

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

10 operations 6 paths 15 schemas 2 DELETE3 GET5 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 Comment 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 10

Across 6 paths, the API surfaces 10 operations — 2 DELETE, 3 GET, 5 POST. Each is listed below with its method, path, parameters, and response codes.

Comment 10

Create, read, update, and delete comments.

GET
/comments
Get a list of comments in a document.
getComments 10 params → default
POST
/comments
Update a document with a new comment.
createComment body → default
GET
/comments/{cid}
Get details for a comment.
getComment 1 param → default
POST
/comments/{cid}
Update the content of an existing comment.
updateComment 1 param body → default
DELETE
/comments/{cid}
Delete a comment from a document.
deleteComment 1 param → default
POST
/comments/{cid}/attachment
Add an attachment to a comment.
addAttachment 1 param body → default
DELETE
/comments/{cid}/attachment
Delete all attachments from a comment.
deleteAttachments 1 param → default
GET
/comments/{cid}/attachment/{fdid}.{ext}
Get the attachment with the specified file extension that is associated with the specified comment.
getAttachment 3 params → default
POST
/comments/{cid}/reopen
Reopen a resolved comment.
reopen 1 param → default
POST
/comments/{cid}/resolve
Resolve a comment.
resolve 1 param → default

Schemas 15

The contract defines 15 schemas that model the data the API accepts and returns. The most detailed are BTCommentInfo (43 properties), BTCommentParams (24 properties), GlobalPermissionInfo (23 properties), BTCompanySummaryInfo (15 properties). Each schema is shown below with its type and property counts.

BTUserBasicSummaryInfo
object
1 property 1 required
BTCommentInfo
object
43 properties
BTCompanySummaryInfo
object
15 properties
BTListResponseBTCommentInfo
object
A list of resources that typically supports paging.
4 properties
BTBaseInfo
object
4 properties
CoordinatesParams
object
3 properties
CoordinatesInfo
object
3 properties
BTCommentAttachmentInfo
object
7 properties
BTCommentParams
object
24 properties
BTBFileUpload
object
1 property
BTViewDataInfo
object
4 properties
BTUserDetailSummaryInfo
object
GlobalPermissionInfo
object
23 properties
BTViewDataParams
object
4 properties
BTUserSummaryInfo
object

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

onshape-comment-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 Company API
Onshape Document API
Onshape Drawing API
Onshape Element API
Where this information came from

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