12-Month Advance Notice Commitment

BrowserKit API Deprecation & Versioning Policy

Autonomous AI agents, production pipelines, and enterprise workflows require reliable API surfaces. BrowserKit provides a transparent versioning model and a strict 12-month deprecation timeline using standard RFC 8594 HTTP headers.

12-Month Notice

No public API endpoint will be removed or altered in a backwards-incompatible manner without a minimum 12-month advance deprecation notice.

Semantic Versioning

Major versions are isolated by URL path (/api/v1/) and tracked via the API-Version response header.

RFC 8594 Headers

Deprecation status is signaled machine-to-machine via standard Deprecation, Sunset, and Link headers.

Machine-Readable Deprecation Signaling (RFC 8594)

When an endpoint enters its 12-month deprecation phase, BrowserKit returns three machine-readable HTTP headers on every request to that endpoint:

  • Deprecation: Indicates the resource has been deprecated, formatted as a boolean (true) or date timestamp (@1763769600).
  • Sunset: Contains the exact HTTP-date timestamp when the endpoint will be permanently shut down (e.g. Wed, 31 Dec 2026 23:59:59 GMT).
  • Link: Points to deprecation documentation or successor endpoints: <https://browserkit.run/deprecation-policy>; rel="deprecation".

Autonomous agents inspecting response headers can trigger automated warnings or switch to successor API versions without workflow interruption.

Current API v1 Lifecycle Status

Method Path Current Version Lifecycle Status Scheduled Sunset
GET /api/v1 1.0.0 Active None scheduled
POST /api/v1/format-json 1.0.0 Active None scheduled
POST /api/v1/base64 1.0.0 Active None scheduled
POST /api/v1/jwt-decode 1.0.0 Active None scheduled
GET /api/v1/uuid 1.0.0 Active None scheduled
POST /api/v1/hash 1.0.0 Active None scheduled
POST /api/v1/timestamp 1.0.0 Active None scheduled
POST /api/v1/url 1.0.0 Active None scheduled
POST /api/v1/regex 1.0.0 Active None scheduled