Note: You must be an admin in your Onshape Professional/Company organization to complete these steps.
API keys
What are API keys? API keys provide a secure way for third-party applications to interact with your account. You define the scope of access when the key is created, and can modify or revoke that access at any time. What does MechAI use your Onshape API keys for? MechAI uses your API keys only to access, share, and edit the Onshape documents associated with tasks you explicitly request. We do not use your keys to browse unrelated documents, make purchases, manage users, modify account settings, or perform any actions outside the scope of your assigned work.1
Create an API key
In Onshape, navigate to Company settings > Developer. Click API keys then Create new API key.
2
Select owner & permissions
In Name, enter
MechAI. In User, select yourself or the team member in your organization who will work with the MechAI team.Select these permissions:- Application can read your documents
- Application can write to your documents
- Application can delete your documents and workspaces
- Application can share and unshare documents on your behalf
Note: MechAI uses delete and share permissions narrowly. We delete only temporary documents and workspaces generated by our agent and share only the specific documents required to carry out tasks you authorize.
3
Upload your API keys securely
After you create the API key, Onshape displays an Access key and Secret key. Open the secure portal below, then paste both values there.
Note: Onshape shows the Secret key only once at creation. Copy it before you close the dialog—you cannot view it again later.
Setup materials
1
Add your team
Send us the work email addresses of everyone who will be using MechAI. We will create an account for each user and provide onboarding instructions. Please also ensure all users join the designated Slack, Google Chat, or Microsoft Teams channel so they can receive product updates, share feedback, and communicate directly with our team.
2
Share drawing templates
In Onshape, share your organization’s DWT document in Onshape with team@trymechai.com. Please include templates for both parts and assemblies, as well as any size, process, or standards-specific variants currently used by your team.
3
Share representative drawing examples
In Onshape, share a set of examples that best reflect your organization’s drawing standards and engineering practices with team@trymechai.com. For each example, include both the part or assembly model and its corresponding drawing documents.We highly recommend providing examples that span a range of manufacturing processes, part complexities, GD&T requirements, FAI/KPC annotations, and single- and multi-sheet drawing packages.