Skip to content

Public API Surface

Consystence has one public programmatic entry point: the cell-direct /api surface at an org’s own subdomain. {slug}.consystence.com CNAMEs directly to the cell that hosts the org and serves both the interactive, server-driven UI and the /api surface — this is what external integrations and the CLI, the supported public client, call. The API overview describes how the surface is grouped; the rendered API reference documents the supported public (CLI-exposed) endpoints.

A site is a path under the org (/sites/{code}), never a hostname — see the org and site model for how organisations, tenants, and sites nest.

Earlier revisions of these docs described a future versioned gateway at api.consystence.com/v1 — a reverse proxy that would have fronted the cells with a flat, versioned public API. That surface was retired before it was ever deployed, as a deliberate product decision: no deployment ever fronted traffic with it, and the cells serve no /v1 routes. There is nothing to migrate from — the host never existed in production.

If Consystence introduces a versioned public API in the future, it will arrive as a new, deliberate product decision with its own contract — not a revival of the retired design. Until then:

  • Address all API traffic to https://{slug}.consystence.com/api/....
  • Authenticate per the authentication model — CIAM bearer, tenant API key (csk_), or site-PIN.
  • Treat the rendered API reference as the supported public endpoint catalogue.