Introduction
Overview of the CircuitHub Platform CLI and API.
The CircuitHub Platform provides two ways to interact with your account programmatically:
- CLI — the
circuithubcommand-line tool. - API — a REST API at
api.circuithub.com/v1/.
Before you design a board to order through the platform, read design feedback: a few choices made at the start, such as board thickness, trace gaps and through-hole parts, decide whether small runs qualify for Grid Proto's large discount.
You can also connect an AI assistant, such as Claude, to work with your account for you.
The CLI and API expose the same operations. Throughout these docs you can switch between them using tabs:
circuithub project list --workspace acme-electronicscurl -H "Authorization: Bearer $CIRCUITHUB_API_KEY" \
"https://api.circuithub.com/v1/projects?workspace=acme-electronics"What can I do?
Today the platform supports:
| Operation | Description |
|---|---|
| Authentication | Browser login (API keys coming soon) |
| Workspaces | List workspaces you belong to |
| Projects | Create, upload revisions, and manage PCB projects |
| Revisions | List revisions of a project |
| Bill of Materials | Inspect BOM lines with resolution status |
| Parts search | Search parts by MPN or description |
| Board configuration | Review and update a revision's board settings and impedance requirements |
| Quoting | Get instant pricing for a revision at a quantity |
| Shipping addresses | Manage a workspace's delivery addresses |
| Billing | Billing details, payment methods, invoices, payments, statements and credit balance |
| Orders | Preview and place orders, and view and track them |
| Issues | Track and manage issues on manufacturing orders (coming soon) |
Base URL
All API requests go to:
https://api.circuithub.com/v1/Override this with the --api-url flag (CLI) or the CIRCUITHUB_API_URL environment variable.