---
title: "smry Public Reader API versioning policy"
description: "Compatibility, deprecation, sunset, and migration policy for the reader API."
canonical: "https://r.smry.ai/api/versioning.md"
last-updated: "2026-08-29"
---

# smry Public Reader API versioning policy

The current stable interface is version 1 at /api/v1/read. Backward-compatible
fields and media types may be added without changing that path. A breaking
request or response change requires a new major path such as /api/v2.

Before a stable version is removed, smry will publish a migration guide and
serve standard Deprecation and Sunset response headers plus a Link with
rel="deprecation". The announced sunset will be at least 90 days after the
deprecation notice. Existing versions remain documented in OpenAPI throughout
their migration window.