API Versioning

The current AIFrame API version is v2.2.

We strive to maintain backward compatibility for our API. However, to innovate and introduce new features, we may occasionally need to release new versions that include breaking changes.

Versioning Scheme

Our API versions are indicated in the URL path, for example:

/api/v2/...

While the current base URL https://api.aiframe.ai might implicitly point to the latest stable version for some initial endpoints (like those documented as /api/process-video), future major versions or specific versioned endpoints will clearly include the version number in the path (e.g., /api/v2/some-new-feature).

Backward Compatibility & Deprecation

Minor versions (e.g., v2.1, v2.2) will typically introduce non-breaking changes, such as adding new optional parameters, new properties to existing responses, or new endpoints. Your existing integrations should continue to work with minor version updates.
Major versions (e.g., v3.0) may include breaking changes.

We are committed to providing a stable API. When we need to deprecate an API version or specific endpoints:

We will announce the deprecation well in advance, typically providing at least 6 months' notice before the old version is fully retired.
Notifications will be sent to the email addresses registered with API keys and potentially posted on our developer blog or community forum.
During the deprecation period, the old version will continue to function, but we will encourage migration to the new version.
After the deprecation period, requests to the retired version may result in errors or be automatically routed to a newer compatible version if possible (though this is not guaranteed for major breaking changes).

We recommend regularly checking our Changelog and developer communications for updates on API versions and features.