Skip to content
ConsystenceConsystence Docs

Public API Surface

Consystence has one public programmatic entry point: the cell-direct /api surface at a tenant’s own subdomain. {slug}.consystence.com (or {slug}.consystence.dev for Integrator tenants and sandboxes) CNAMEs directly to the cell that hosts the tenant 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. A site server serves the same /api surface at its own address on your network. The API overview describes how the surface is grouped; the rendered API reference lists the endpoints the CLI and its client library call, with the credentials each accepts.

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.

The retired /v1 gateway

Section titled “The retired /v1 gateway”

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 hosted API traffic to your tenant’s subdomain, https://{slug}.consystence.com/api/... (or .consystence.dev), and site server traffic to the site server’s own address.
  • Authenticate per the authentication model — an organisation sign-in (Bearer) token or a tenant API key (csk_); a site server also accepts site-PIN tokens.
  • The rendered API reference covers the endpoints the CLI and its client library call, not every route the server maps; platform-operator and server-to-server endpoints are not in it.
Section titled “Related”