Versioning

API Versioning Guidelines

At Ejento AI, we implement versioning to ensure a stable, predictable experience for all API consumers.
This allows you to upgrade at your own pace and protects your existing integrations as we enhance the platform.

Versioning Strategy

Our APIs follow semantic versioning, using the format MAJOR.MINOR.PATCH, where:

MAJOR — Introduced for breaking or incompatible changes.

MINOR — Introduced for backward-compatible enhancements and new features.

PATCH — Introduced for internal bug fixes or performance improvements that do not affect API contracts.

While the full MAJOR.MINOR.PATCH version is used internally, we only expose the MAJOR.MINOR version to API consumers.

Example public version: 2.0
(Internally this may correspond to 2.0.3, 2.0.4, etc.)

PATCH updates are fully backward-compatible and applied transparently, with no impact on client-side integrations.

⚠️ Note:
The versioning strategy described here — including the X-API-Version header and semantic MAJOR.MINOR.PATCH support is available only in the latest v2 APIs.
Earlier or legacy v2 endpoints may not support this version negotiation approach.

How to Specify an API Version

You can specify the API version you’d like to use by setting the X-API-Version header in your requests.

Example:
X-API-Version: 2.0

If the header is omitted or contains an invalid version, the API will default to the latest stable version.

Backward Compatibility

We aim to maintain backward compatibility within the same MAJOR version.
This means:

Older versions remain supported until they are explicitly deprecated.

Minor updates will not introduce breaking changes for existing clients.

Changelog & Version History

We document every change — additions, updates, and deprecations — so you can easily track API evolution over time.

👉 View our full changelog with each update.

Summary

Our versioning approach is designed to offer clarity, stability, and flexibility:

You decide when to adopt newer versions based on your integration needs.

Existing integrations remain stable through backward compatibility.

All changes are transparently documented in our changelog for easy reference.

If you have questions about versioning or need help upgrading, feel free to contact our support team — we’re here to help!

API Versioning Guidelines#

Versioning Strategy#

How to Specify an API Version#

Backward Compatibility#