Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.trymechai.com/llms.txt

Use this file to discover all available pages before exploring further.

These steps require an admin in the Onshape Enterprise.

​
Setup

​
API keys

What is an API key? An Onshape API key lets MechAI perform the specific Onshape actions you approve. You create it in Onshape, choose its permissions, and can revoke it at any time. What do we use your API key for? Only to share and retrieve task-related documents with the MechAI agent account. This includes the document you queue and any external references needed to complete that assigned task. We do not use it to browse unrelated documents, make purchases, manage users, or change account settings.
1

Create an API key

Navigate to “Enterprise Settings > Developer”. Then click “API Keys”. Create a customer-owned Onshape API key (access & secret key) from an admin account. Onshape API open page
2

Select permissions

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
You do not need Application can read your profile information or Application can request purchases on your behalf.MechAI deletes only documents created by the agent and uses sharing permissions only for task-specific documents.Onshape API key permissions with required document permissions selected

​
Enterprise Connection

1

Start the Enterprise Connection

Send us your Enterprise ID (see Enterprise Settings > Connections). Then, we’ll send you an invite for an Enterprise Connection.
2

Configure the Enterprise Connection

Once you accept that invite, complete the following steps:
  • Add all users who will use MechAI to the Enterprise Connection.
    Accepted Enterprise Connection in OnshapeAdd users screen for an Onshape Enterprise Connection
  • Enable Enterprise settings > Global permissions > Export files for all those users and our MechAI account team@trymechai.com. Onshape Enterprise global permissions with Export files enabled

​
Share Resources

1

Share drawing templates

Share your standard drawing-template DWTs with the MechAI account, team@trymechai.com.Share each drawing template MechAI should support, such as part drawings, assembly drawings, customer-specific title blocks, and size variants.
2

Share approved template documents

If your enterprise has Enterprise settings > Preferences > Drawings > Require users to utilize approved drawing templates enabled, share the linked drawing-template document with team@trymechai.com.Onshape Enterprise drawing preferences with approved drawing templates enabled
3

Share representative examples

Share representative examples that show your drawing standards and best practices along with their source models. Ideally, include a useful variety, such as assembly/drawing pairs, part/drawing pairs, simple parts, detailed parts with GD&T, assemblies, BOM or balloon drawings, and multi-sheet drawings.

​
Need help?

Email team@trymechai.com with any setup questions.