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/.
Both interfaces 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 |
| Orders | View and track manufacturing orders |
| Quoting | Get instant pricing at different quantities and lead times (coming soon) |
| Issues | Track and manage issues on manufacturing orders (coming soon) |
| Billing | View invoices, payments, statements, and credit balance (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.