Getting started

The public read API is anonymous — every read endpoint returns project data without a sign-in, which is what lets the project square work for a logged-out visitor. Here is the path from nothing to your first request.

  1. Pick your origin. The API is served from the application host. Every path below is relative to it.
  2. Read the reference. The API reference lists every endpoint, its parameters and its status codes, generated from the served OpenAPI document.
  3. Make an anonymous read. GET /api/public/explore returns the public project square with no token.
  4. Sign in for writes. Account-bound operations carry a bearer token; reads stay open.
  5. Respect the contract version. Breaking changes bump the version — see Stability & deprecation.