Versioning and deprecation
How Probably's API is versioned, which changes ship without notice and how breaking changes are announced.
Probably's API carries its major version in its address, /api/v1, and every event says its version. Within a version, changes only add.
Changes that ship without notice
These can arrive at any time, so write clients that ignore what they don't recognise:
- new tools and endpoints;
- new optional input fields, and new values where an input accepts a choice;
- new fields in an answer or an event;
- new event types;
- new refusal outcomes: when you meet one you don't know, act on its HTTP status;
- new permissions a connection can be given.
Breaking changes
Removing or renaming a tool, field or event type, making an optional input required, or changing what a field means ships as a new version beside the old one: /api/v2 for the API, version: 2 for events. We announce it in these docs at least six months before the old version stops answering, and the old version keeps working, unchanged, until then.
Deprecation
Nothing is deprecated today. When a tool or field is on its way out, these docs will say so on this page, with what replaces it and the date it goes, at least six months before a new version removes it.
The MCP server follows the same rules for its tools. The MCP protocol version itself is negotiated by your client and the server when they connect.