What the /api/v1 REST API can do: projects, build, CAD, flows, artifacts
The HIIE REST API under /api/v1 is the customer and agent surface for the platform. It runs the same underlying functions as the web app, so anything done through the API behaves identically to the UI and is scoped to your account.
Authentication
All calls use Bearer authentication with a developer hk_live_ key. The base URL is /api/v1.
Endpoint groups
The API is organized into five areas (matching the OpenAPI tags Projects, Build, CAD, Flows, and Artifacts):
- Projects — list your projects (GET) and create new ones (POST).
- Build — start the autonomous builder for a project and poll its status.
- CAD — generate a manufacturable part from a prompt and list designs. CAD generation drives the real server-side build123d engine and returns STEP, STL, and a colored GLB archived into the project's Design folder.
- Flows — run a flow (a built-in template or a custom definition) and list the available templates.
- Artifacts — list every file a project holds with per-file download URLs, and bulk-write files into a project.
Owner-scoped and metered
Every request resolves to your account and only touches your data. Operations that consume credits require the build scope, and on the free tier programmatic (API/MCP) spend is held under a monthly sub-cap.
Documentation
The full machine-readable description lives at /.well-known/openapi.json (OpenAPI 3.1), with human-readable docs at /api.md. Each operation also declares the scope it requires via an x-required-scope extension in the spec.