API reference

The public ArkitektHQ API ships with the v1.0 release. As of 2026, ArkitektHQ is in active pre-1.0 development and the surface area of the public API is still being shaped against real customer use. Publishing a contract we cannot keep would be worse than publishing nothing.

What is available today

For self-hosted operators and contributors, the current Express route layer is documented in DEVGUIDE.md section 12 ("HTTP routes"). That document is the source of truth for which endpoints exist, what they accept, and what they return. It is intentionally not promoted as a stable public API: routes may be renamed, consolidated, or replaced before v1.0 ships.

Authentication for the internal routes is session-cookie based, with CSRF tokens issued by the Express layer. There is no API key system yet.

What v1.0 will include

The planned public API surface for v1.0:

If you have a specific integration in mind and want to influence the v1.0 surface, the fastest path is to open an issue describing your use case. Concrete needs from real shops carry more weight than speculative wishlist items.