Api And Mcp
11 articles
Creating and revoking developer API keys (hk_live_)
Create, list, and revoke hk_live_ developer API keys from Account > Developer. The raw key is shown once at creation and stored only as a one-way hash.
Why your API secret is shown only once at creation
HIIE stores only a one-way hash of your API key, never the raw secret, so it can show the full key just once. Lost keys can't be recovered; revoke and re-mint.
API key scopes: read, write, and build
Developer API keys carry read, write, and build scopes (all three by default). Build is the scope that spends credits; each operation checks the scope it needs.
Authenticating requests with a Bearer hk_live_ key
Send your hk_live_ key as an Authorization: Bearer header to /api/v1 or /api/mcp. Auth runs first on every request, is owner-scoped, and fails closed.
What the /api/v1 REST API can do: projects, build, CAD, flows, artifacts
The /api/v1 REST API covers projects, build, CAD, flows, and artifacts, running the same owner-scoped logic as the UI behind Bearer hk_live_ key auth.
Generating CAD through the v1 API
Generate real B-rep CAD parts via the v1 API: it drives the build123d engine, runs a vision quality loop, and archives STEP, STL, and GLB. Needs the build scope.
Listing and writing project artifacts via the API
List a project's full file manifest with download URLs (read scope), and bulk-write up to 600 text or base64 files (write scope), all owner-scoped.
Connecting to the HIIE MCP server at /api/mcp
Connect MCP clients to /api/mcp (Streamable HTTP, JSON-RPC 2.0, protocol 2025-06-18) using an hk_live_ Bearer key. POST-only; discovery via the MCP server card.
The 8 MCP tools and the scopes each one needs
The MCP server exposes 8 tools: list_projects, create_project, generate_cad, list_flow_templates, run_flow, start_build, get_build_status, and list_artifacts, each gated by read, write, or build.
Rate limits and the free-tier programmatic spend cap
API and MCP calls are rate-limited per tenant; the free tier caps programmatic spend at $0.20/month within a $2/month ceiling. BYO OpenRouter keys run unmetered.
Where to find the OpenAPI spec and API docs
Find the OpenAPI 3.1 spec at /.well-known/openapi.json and docs at /api.md, plus standards-based discovery surfaces under /.well-known/ (served in production).