Alcove Docs
API reference

API reference

The Alcove REST API — one base URL, bearer auth, generated from the live OpenAPI spec.

The Alcove API is the headless spine behind every client. It speaks REST over a single base URL, with WorkOS bearer authentication and idempotent writes.

  • Base URLhttps://api.alcove.fi
  • AuthAuthorization: Bearer <token> (WorkOS)
  • Writes — send an Idempotency-Key header to make retries safe
  • Errors — a consistent envelope: { "error": { "message", "errors?" } }
  • Spec — the machine-readable OpenAPI document

The pages in this section are generated from that spec: each endpoint lists its parameters, request body, and every response shape. When the API changes, the reference is regenerated from a fresh snapshot of the spec.