Using the API
Versioning
The API's version is in its path; what changes within a version and what doesn't.
The API's version is the first segment of every path: https://api.anyrow.ai/v1/.... Everything
in these docs is v1.
Within a versionLink to section
A version only grows. These changes can happen in v1 at any time, so write clients that
accept them:
- New endpoints and new resources.
- New optional request parameters and body fields.
- New fields in responses, and new keys inside objects you already read.
- New values in a field whose values are listed, such as a status or an
error_key. - New permissions for new endpoints, and new webhook event types.
In practice: ignore response fields you don't know, treat an unknown status or error_key as
its HTTP status says, and subscribe webhooks to the events you handle by name.
These would change what working code sees, so they take a new version instead:
- Removing or renaming an endpoint, a parameter or a response field.
- Changing a field's type, or making an optional parameter required.
- Changing which permission an endpoint needs, or what its errors mean.
SDKsLink to section
The SDKs, the CLI and the MCP server are generated from the same OpenAPI document, so a new endpoint or field reaches each of them in its next release.
What changedLink to section
The OpenAPI changelog (opens in a new tab) lists every release of the document: the operations and schemas each one added or changed.