API policy
A 0.x API should say what it does not promise.
BaziRoute publishes a stable contract for documented public fields while the platform remains under development. This page explains compatibility, deprecation and support boundaries.
Current version
0.1.0
Status: development. Reviewed 2026-10-27. Next review due 2027-01-27.
Compatibility commitments
- · Document public request and response shapes in OpenAPI before adding a stable version.
- · Announce incompatible public changes in the changelog before removal when practical.
- · Keep deterministic engineVersion and Rule Profile identifiers in chart responses.
- · Avoid silently changing the meaning of an existing public path.
- · Use versioned model, prompt and response-schema identifiers for AI output.
Not promised
- · No uptime SLA or long-term support entitlement for the keyless API.
- · No API-key identity, quota dashboard or commercial support on public endpoints.
- · No stability guarantee for undocumented fields while the API remains 0.x.
- · No permission to access private account, report, event, billing or admin routes.
Deprecation sequence
- 1. Document. Record the affected path, field, replacement and migration impact in the changelog and OpenAPI spec.
- 2. Observe. Monitor response contracts and client-visible behavior before changing documented public fields.
- 3. Replace. Publish the replacement where possible and keep the old behavior for a defined transition when practical.
- 4. Remove. Remove only after the changelog and contract are updated; emergency security changes may be faster.
Use the published contract.
Validate against the OpenAPI specification and inspect response warnings rather than depending on undocumented fields.