Call any Onshape API endpoint
onshape_api_requestCall any Onshape REST endpoint directly to perform operations not covered by dedicated tools, passing HTTP method, API path, query parameters, and optional JSON body.
Instructions
Escape hatch: call any Onshape REST endpoint directly. Use it for things the dedicated tools do not cover. WARNING: this is the raw API - lengths are in METERS (no unit conversion), POST/DELETE can change or destroy data, and in read-only mode only GET is allowed. Large responses are truncated.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"method": "<method>",
"path": "<path>"
},
"name": "onshape_api_request"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| body | No | JSON request body for POST. | |
| path | Yes | API path relative to /api/vNN, e.g. '/documents' or '/partstudios/d/<did>/w/<wid>/e/<eid>/featurespecs'. See the Onshape API Explorer: https://cad.onshape.com/glassworks/explorer | |
| query | No | Query-string parameters. | |
| method | Yes | HTTP method. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||