API Reference
Versioning
API version policy and deprecation.
Overview
The current stable version is v1, embedded in the URL path (https://api.zof.ai/v1). Non-breaking additions ship without version bumps.
Breaking changes are announced via changelog and minimum 90-day deprecation for enterprise contracts unless security-critical.
Who should read this
- QA engineers, SREs, platform teams, and developers operating Zof Console and APIs.
When to use this workflow
- Onboarding new team members to Zof terminology and workflows
- Authoring internal runbooks aligned with Console labels
- Designing CI/CD or webhook integrations against documented behavior
Step-by-step procedure
Pin version in URL
Always call /v1/ paths explicitly in integrations.
Monitor announcements
Review /docs/changelog monthly.
Staging validation
Run integration tests after SDK or API updates before production cutover.
Key concepts
- Non-breaking change
- New optional JSON fields, new endpoints, or expanded enum values.
- Breaking change
- Removed fields, changed semantics, or deleted endpoints requiring migration.
- Sunset header
- Deprecated endpoints may return Sunset HTTP header with retirement date.
Best practices
- Pin integrations to /v1 explicitly
- Subscribe to release notes for API changes
- Test pipeline integrations in staging before key rotation events
Was this page helpful?
