Be the first to get access to new connectors. Get early access →
ConnectorBay Early access

Onshape (BYOK) — connector documentation

  • MCP endpoint: https://byok-onshape.connectorbay.com/mcp
  • REST API: POST https://byok-onshape.connectorbay.com/v1/tools/{tool_name}, described by the OpenAPI 3.1 spec at https://byok-onshape.connectorbay.com/openapi.json
  • Transport: Streamable HTTP, stateless, MCP specification 2025-06-18 or later
  • Authentication: your own Onshape Onshape API access key, sent in the X-Upstream-Key header and the Onshape API secret key in X-Upstream-Key-2 of every request (never stored, logged or cached)
  • Health: https://byok-onshape.connectorbay.com/health · Tool schemas: https://byok-onshape.connectorbay.com/tools.json
  • Publisher: Unify Dynamics LLC · connectorbay.com/byok-onshape · agent@connectorbay.com

What Onshape (BYOK) is for

Onshape (BYOK) lets an AI assistant read your own Onshape data through the Onshape API with a key you supply (Onshape API access key). Read-only: 11 tools (get_session_info, list_documents, get_document, list_workspaces, list_versions, list_elements, list_parts, get_part_mass_properties, get_bill_of_materials, list_companies, list_revisions). The BYOK key travels with each request, is used for that one call only and is never stored, logged or cached; it is only ever sent to cad.onshape.com. Unofficial connector by Unify Dynamics LLC: not affiliated with, endorsed by or sponsored by Onshape. Onshape and its logos are trademarks of their owners and are used only to say which service the connector works with.

Ask your assistant things like:

  • "Which Onshape account is this API key for"
  • "Which Onshape documents do I have about gearboxes"
  • "Show details of Onshape document e60c4803eaf2ac8be492c18e"
  • "Which workspaces does document e60c4803eaf2ac8be492c18e have"
  • "Which versions has document e60c4803eaf2ac8be492c18e been saved at"
  • "What part studios and assemblies are in document e60c4803eaf2ac8be492c18e"

What it does

  • get_session_info: Show which Onshape account the API key belongs to: user id, name, plan group and roles.
  • list_documents: List or search Onshape documents you can access: name, description, owner, created and modified dates. Sorted and paged.
  • get_document: Get one document's details: name, description, owner, default workspace, creation and modification dates, counts of copies and references.
  • list_workspaces: List a document's workspaces (branches) with name, last modified time and microversion.
  • list_versions: List the saved versions of a document with name, description and creation time.
  • list_elements: List the elements (tabs) of a document at a workspace, version or microversion: part studios, assemblies, drawings, blobs. Filter by type.
  • list_parts: List the parts of a document at a workspace, version or microversion with part number, name, description, material, vendor, revision and state. Optionally limited to one element.
  • get_part_mass_properties: Get a part's mass, volume, centroid and moments of inertia as computed from its geometry and material.
  • get_bill_of_materials: Get the bill of materials table of an assembly element, as Onshape reports it: items, quantities, part numbers, descriptions and materials. Single level by default.
  • list_companies: List the companies (teams and enterprises) your Onshape account belongs to, with id, name and domain prefix.
  • list_revisions: List released part and drawing revisions of a company: part number, revision letter, release name, state and release date.

BYOK key

You bring your own Onshape Onshape API access key (https://dev-portal.onshape.com/keys). Your assistant sends it in the X-Upstream-Key header with each request. ConnectorBay uses it for that one call only: it is never stored, logged or cached, never shown in an answer, and it is only sent to cad.onshape.com over https, with no redirects followed. Create a key with the fewest permissions the tools need (read-only if the provider offers it), and revoke it at the provider whenever you like.

Data sources

Live from the Onshape API (cad.onshape.com) with a BYOK key; documentation: https://onshape-public.github.io/docs/. Endpoints checked against that documentation on 2026-10-16.

What it is not

Unofficial connector by Unify Dynamics LLC: not affiliated with, endorsed by or sponsored by Onshape. Onshape and its logos are trademarks of their owners and are used only to say which service the connector works with. It is read-only: it never creates, changes, sends or deletes anything in your Onshape account.

Built for: Worldwide. Languages: English.