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 Professional/Company.

​
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

Create a customer-owned Onshape API key (access & secret key) from an admin account, owner account, or service account in “Company settings > Developer”. Click “API Keys”.
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

​
Share Resources

1

Share drawing templates

Share the DWTs for your standard drawing templates 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

Examples

Share representative examples that show your drawing standards and best practices. 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.