Versioning
The API is v0.1 and path-unversioned — how that works today, and how breaking changes are communicated until a stable v1.0.
The Minctrl API is v0.1 and path-unversioned.
Path-unversioned
There is no version prefix in the URL. You call endpoints directly — /process-runs,
/process-runs/{id}/resume, /auth/register, and so on — with no /v1 segment. A single
live surface is served; there is no side-by-side versioned path today.
Pre-1.0 — expect change
At v0.1 the API is pre-1.0 and should be treated as such. The surface can still change as endpoints are hardened. Only the endpoints listed as rate-limited in Rate limits are treated as hardened; assume anything else may still change shape.
How breaking changes are communicated
Until a stable v1.0 is cut:
| Change type | Examples | How it's handled |
|---|---|---|
| Breaking | Removing or renaming a field, changing a response shape, tightening a request contract | Recorded in the Changelog, dated, with a migration note before it lands wherever possible |
| Additive | New endpoints, new optional fields, new verticals | Not treated as breaking; may land at any time and surface automatically in the generated SDKs |
When the API stabilizes, a formal versioning scheme and deprecation policy will be published here before anything is removed.