API v1Stable major · additive within v1

API versioning policy

Contract-first REST for builders and agents. Same control plane as Fat Heron products — documented here for the developer surface.

Fat Heron for Developers versions the HTTP API by URL major. The current major is v1 under /v1/….

  • Additive fields, new endpoints, and new optional parameters are non-breaking within a major.
  • Removing or renaming fields, changing semantics, or tightening validation in a breaking way requires a new major (/v2).
  • Deprecated behaviour stays available for a documented window before removal.
  • When capacity bursts across internal backends, we translate at the edge so client contracts stay stable.
  • Contract source of truth: OpenAPI in the platform contracts package; live schema at /openapi.json on the API host.

← Back to docs

Versioning · Fat Heron Developers