BriteAI API Versions

Accessing API Versions

You can access the latest version of the API docs using the base docs URL:

https://docs.britelink.io

This URL will always direct you to the most recent version of the BriteAI API.

API Upgrades and Changes

Keeping Track of Changes and Upgrades to the BriteAI API

Your API version (e.g., v1) controls the API behavior you experience (e.g., what properties you see in responses, what parameters you're allowed to send in requests, etc.). When we introduce changes to the API that are not backward-compatible, we release a new version. To prevent breaking your existing integrations, we support older versions for a reasonable period and assist users in migrating to the latest version. We won't remove older versions without ensuring that all customers have fully migrated. However, we encourage you to stay updated with the newer versions to benefit from enhancements and new features.

Backwards-Compatible Changes

BriteAI considers the following changes to be backwards-compatible:

• Adding new API resources.
• Introducing new optional request parameters to existing API methods.
• Adding new properties to existing API responses.
• Modifying the order of properties in existing API responses.
• Altering the length or format of opaque strings, like error messages and other human-readable strings.
• Enhancing the relevance or ordering of search results.

You can rest assured that object IDs will not change in length and will always be under 255 characters.

Upgrading Your API Version

If you’re using an older version of the API, upgrading to the latest version allows you to access new functionalities and streamline responses, enhancing the API's performance for your use. Upgrading your API version can impact:

• The parameters you can send and the structure of objects you receive.
• The parameters in headers that are required and returned.
• The computation of request tallies for billing purposes.
• The method of authentication.
• The availability of endpoints. Some endpoints may be deprecated with major version changes.

To upgrade, simply modify the version number in your API requests (e.g., change “v0” to “v1”). It’s also possible to use two versions of the API concurrently, enabling iterative upgrades.

When performing an API upgrade, thoroughly review the change log below on the next page. Ensure that your tests pass against the endpoints you utilize in your application. You can test the new version while continuing to use the previous version in your production environment.