Skip to main content

API reference

Not yet written

There is no published Automentic API at the time of writing, so there is no reference to document.

This page exists so the structure is in place — not as a stub to be filled with plausible-looking endpoints. Fabricated API documentation is actively harmful: an engineer who writes an integration against POST /v1/agents because it appeared here has lost a day, and lost confidence in everything else on this site.

What will go here​

When the control plane ships, this section should cover:

  • Authentication — how a caller presents credentials, and token lifetimes.
  • Agents — register, list, inspect, suspend, revoke, rotate.
  • Policies — attach, evaluate, version.
  • Audit — query and export the trail, including filters and pagination.
  • Usage — signed-action and identity counts for the current period.
  • Webhooks — event delivery, signing and replay.

How it should be generated​

Publish an OpenAPI description from the source of truth and render it here, rather than hand-writing the reference. Hand-written API docs drift from the implementation within one release; generated docs cannot.

Docusaurus renders OpenAPI through a plugin, or the specification can be served alongside these pages.

In the meantime​

The Concepts section describes the model precisely enough to evaluate the approach, and the customer portal built for this project shows the data shapes the API is expected to return — see src/lib/api/types.ts in the portal. Those types are the working contract.