Skip to documentation
Browse documentation
Public developer documentation

Build on governed product data

Use one typed REST and MCP contract to explore the Hyran entity graph, compare BOM yield history, and create bounded exports. Credentials remain organization-bound and PostgreSQL forced RLS enforces the final tenant boundary.

What the API exposes

Entity graph

Search styles, SKUs, materials, suppliers, and immutable BOM publications.

Historical BOM yields

Compare completed snapshots with stable temporal and provenance semantics.

Governed exports

Create asynchronous CSV exports without exposing SQL or direct database access.

Authenticate safely

Ask an authorized Hyran operator for a scoped API credential. Send it only in the Authorization header over HTTPS.

Read authentication guide
Use generated contracts

OpenAPI 3.1 is canonical. Import it into Postman or generate a client without copying endpoint definitions.