Developers

re:solved API deprecation & sunset policy

This page is the authoritative deprecation policy for the public re:solved API and the re:solved MCP server. It exists so that an agent or an engineer can integrate against our surface knowing exactly how and when it may change.

Versioning

The API uses URL path versioning. The canonical form is /api/public/v1/<endpoint>; the current major version is v1 and the supported set is v1. Unversioned paths such as /api/public/ai-audit-submit are permanent aliases of the current major version; pin the versioned path in production. Every API response carries API-Version and API-Supported-Versions.

What can change without notice

  • New endpoints, new optional request fields, new response fields.
  • New MCP tools, and new optional properties on an existing tool input schema.
  • Wording of human-readable message strings.

Treat responses as open maps: ignore fields you do not recognise rather than failing.

What counts as breaking

  • Removing or renaming an endpoint, a field, an error code or an MCP tool.
  • Narrowing accepted input, or changing the type of an existing field.
  • Changing an HTTP status code or the structure of the error envelope.

Breaking changes never land inside an existing version. They ship under a new major path (for example /api/public/v2/…), and the previous version keeps working through the notice period below.

How removal is signalled

  • An endpoint scheduled for withdrawal responds with Deprecation: true (RFC 9745), a Sunset: <HTTP-date> header (RFC 8594) and Link: <https://re-solved.digital/deprecation-policy>; rel="deprecation".
  • Those headers appear at least 180 days before the endpoint stops working, and the endpoint keeps its documented behaviour for that whole period.
  • Every API response — deprecated or not — already carries Deprecation-Policy, Sunset-Policy and a Link … rel="deprecation-policy" header pointing at this page, so a client can discover the policy from any single call.
  • After the sunset date the path returns HTTP 410 with a structured JSON error whose hint names the replacement.

Machine-readable sources