Default behaviour
- Header:
X-API-Version - Default value:
1
Opting into a preview
When we announce a new API version, set the header to the preview identifier to test the changes:Rolling out updates
Before we promote a preview to the default version, we provide:- A changelog entry summarising what changed.
- A deprecation timeline for the previous default.
- A reminder in the Mintlify documentation.
Tips for clients
- Set the header once in your HTTP client or API gateway to keep versioning consistent across requests.
- Monitor your logs for warnings about upcoming API changes—we emit diagnostics when we detect mismatched expectations.
- Coordinate with MedDRA versions: API versions and MedDRA releases are independent. You can classify narratives against MedDRA 28.0 while testing API
X-API-Version: 2in the same workflow.