Open Source RoboticsRobots, software & learning

Onshape to robot

Software

Convert accessible Onshape robot assemblies into URDF, SDF or MuJoCo descriptions through the Onshape API. [1] [2] [3] [4]

Installation & first result →Official websiteGetting started

For
Robotics developers evaluating the selected source workflow [1] [2] [3] [4]
Source rights
Named licenses are documented by part. Review licenses
Unknowns
operating system, compute requirements not fully established. Review gaps

Source researched · Not tested by us
Sources checked · Research details

Licenses & related hardware

Requirements · Research details and dates

On this page

Overview

Onshape to robot converts an Onshape assembly into a robot description for URDF, SDF or MuJoCo. It is useful when a robot's mechanical assembly lives in Onshape and the next task is creating a simulation description. It supplies converter code rather than ownership of a robot design, an offline CAD editor or proof that an exported robot behaves correctly. [1] [4]

Is this for you?

Known limitations
  • Cloud access and credentials are separate from the MIT converter code.
  • Output geometry, joint conventions, inertias and downstream simulator behavior require model-specific validation.

Editorial source-scope assessment; no installation, execution or compatibility test.

[1] [2] [3] [4] · Editorial assessment

What you need

Dependencies
  • Onshape assembly access and API credentials
  • Python package and project config.json; current minimum Python version not established by selected evidence

[1] [2] [3] [4]

Installation & first result

Open the upstream getting-started guide [1] [2] [3] [4]

  • Inspect the pinned source instructions and select the documented configuration.
  • Install only the dependencies for the chosen route; validate against the selected robot or model before hardware integration.

Editorial source-scope assessment; no installation, execution or compatibility test.

[1] [2] [3] [4] · Editorial assessment

Project notes

Start with one accessible assembly

The pinned getting-started guide documents pip install onshape-to-robot. The selected evidence does not establish a minimum Python version or a reproduced dependency environment; a package installed today also need not equal the reviewed source revision. Review the pinned configuration and CLI before applying current-package instructions. No package installation was performed. [3] [4]

The workflow requires Onshape access. The guide describes API key/secret authentication through ONSHAPE_API, ONSHAPE_ACCESS_KEY and ONSHAPE_SECRET_KEY, supplied in shell environment variables or a project .env file. Its OAuth alternative uses ONSHAPE_SECRET_BEARER. Treat credentials as private configuration; neither the MIT license nor a public converter repository grants access to another person's assembly. [2] [3]

Create a directory such as my-robot, then its config.json with the selected assembly url and output_format, for example urdf. Copy the assembly tab's URL rather than an unrelated document tab. The documented invocation is onshape-to-robot my-robot. These are source instructions, not an export reproduced in this review. [3]

Know which operation the CLI is performing

The inspected entry point selects URDF, SDF or MuJoCo exporters from the configured output format. It exposes --retrieve to obtain robot data and produce robot.pkl, --save-pickle to retain that data, and --convert to load saved data for conversion. Those modes distinguish API retrieval from local conversion; they do not establish that any particular assembly was retrieved successfully here. [4]

The same entry point offers --safe to disable features involving custom commands or imports. Inspect configuration and processors before using someone else's project. The conversion route uses Python pickle loading, so saved robot data should also be treated as trusted executable input rather than a neutral CAD interchange file. This is a source-based integration precaution, not a security audit. [4]

The MIT notice covers the converter project. Onshape service access, input CAD, vendor parts, meshes and downstream simulator dependencies require their own rights and configuration review. Validate joint conventions, transforms, masses/inertias and geometry for the selected robot before relying on a simulation or attempting hardware control. No API authentication, retrieval, export, geometry comparison, simulation or physical operation was tested. [1] [2] [3] [4]

What we checked

Pinned source research only; selected implementation and setup text inspected. No dependency installation, upstream build, API export, robot simulation, hardware commissioning, timing or performance test performed.

Not yet established

  • Requirements: operating system, host computer
  • Version-specific hardware compatibility (ecosystem tags alone do not establish it)

Updates

Upstream last updated
Not established
Latest release
Not established
Profile updated
Nov 1, 2026
Sources last checked
Nov 1, 2026
Next review
Dec 1, 2026
Reviewed revision
80e7107

Source files and licenses

Distinct robotics software implementation with inspectable source, declared license and bounded initial workflow.

LayerAvailability / license
softwareavailable · MIT
Repository project notice; bundled/external dependencies and robot/model/CAD/hardware assets retain their separate terms. No whole-tree license audit or hardware rights clearance. [1] [2] [3] [4]
documentationavailable · MIT
Repository project notice; bundled/external dependencies and robot/model/CAD/hardware assets retain their separate terms. No whole-tree license audit or hardware rights clearance. [1] [2] [3] [4]

Software entry; no separate physical design, firmware distribution, training-weight or dataset claim selected.

References

Each source links to the exact revision we read. “Used for” shows where this page relies on it.

Correction guidance · Discussion is not enabled · Profile format 0.7.0-draft.5

Change history