API versioning and deprecation policy
Synorb keeps the public REST contract stable while allowing additive improvements. This page is the durable policy link for agents and integrators.
Compatibility
- Existing endpoints, request fields, response fields, and documented meanings remain compatible unless a breaking change is announced.
- New response fields and endpoints may be added without a version bump. Clients should ignore unknown fields.
- The live OpenAPI contract and REST guide are the authoritative implementation references.
Deprecation and sunset
When a breaking change or retirement is necessary, Synorb marks the affected response with the standardized Deprecation and Sunset headers and provides a deprecation link. We target at least 90 days' notice before removal, except for urgent security, legal, or provider failures.
Agents should log and surface these headers, follow the linked migration guidance, and migrate before the sunset date. A deprecation header is a migration signal, not permission to keep retrying an obsolete route.
Agent integration guidance
Use the agent guide for exact request and failure recipes. Keep credentials server-side, preserve source citations, and treat machine-readable error_code values as the stable error interface.