Developers

Versioning and deprecation

Vitals Vault Educational API versioning: URL versions, a six-month deprecation notice, and Sunset/Deprecation response headers.

URL versioning

The Educational Biomarker API is versioned in the URL path. The current public surface is /api/v1. A future breaking release would ship as /api/v2 rather than silently changing v1. Additive, backwards-compatible fields may appear on v1 without a new version.

Deprecation notice

If we retire a versioned URL or a documented field, we will give at least six months of notice on the developer portal and in the OpenAPI document. During that window the old URL keeps working.

Sunset and Deprecation headers

Deprecated endpoints will send HTTP Deprecation and Sunset headers (RFC 8594 / RFC 9745) so agents can detect a coming break without scraping this page. No Educational API route is deprecated today, so those headers are not present on current v1 responses.

Contract: /openapi.json. Auth: /auth.md.