Learn how to specify which API version to use whenever you make a request to the API.
About API versioning#
The Anakin.ai API is versioned. The API version name is based on the date when the API version was released. For example, the API version 2024-05-08 was released on Tue, 8 May 2024.Any breaking changes will be released in a new API version. Breaking changes are changes that can potentially break an integration.removing an entire operation
removing or renaming a parameter
removing or renaming a response field
adding a new required parameter
making a previously optional parameter required
changing the type of a parameter or response field
adding a new validation rule to an existing parameter
changing authentication or authorization requirements
adding an optional parameter
adding an optional request header
Specifying an API version#
You should use the X-Anakin-Api-Version header to specify an API version. For example:Requests without the X-Anakin-Api-Version header will default to use the 2024-05-08 version.If you specify an API version that is no longer supported, you will receive a 422 error.
Supported API versions#
The following API versions are currently supported:You can also make an API request to get all of the supported API versions. For more information, see "Get all API versions".