Versioning
Mailrith versions the public API in the path. This page covers what that means for client pinning, future upgrades, and schema diffing.
2 min read
Use the path version as the contract boundary
Public API URLs are versioned in the path. New breaking changes ship in a new top-level version rather than silently changing v1 behavior.
The initial public release ships only on the versioned v1 surface.
Pin your client to /v1 explicitly. New breaking changes will ship behind a new top-level version rather than mutating the current contract in place.
curl https://api.mailrith.com/v1Plan upgrades deliberately
Use the generated OpenAPI document to diff versions before you upgrade your SDK or integration client.
Because the spec is machine-readable, you can automate schema comparison in CI before adopting a future version.
Download the developer-site copy of the OpenAPI document or call the public GET /v1/openapi.json endpoint directly from your tooling.
Need help shipping an integration?
Reach the Mailrith team if you need help planning a sync, validating a webhook flow, or troubleshooting a request.
Related guides
Browse the generated endpoint reference and download the OpenAPI contract.
Run the local worker, generate a workspace key, exercise the endpoints, and execute automated integration coverage.
Create a workspace key and make the first authenticated request against Mailrith's public API.