Use the Framework with the on-premises Search API

This is for:

Developer
In this article

The on-premises Search API is officially deprecated since its May 2016 maintenance release (v8.0.1126).

Consequently, the latest Coveo JavaScript Search Framework version that officially supports the on-premises Search API is v1.0.420. This version of the Coveo JavaScript Search Framework version is bundled with the latest on-premises Search API package.

None of the newer Coveo JavaScript Search Framework features will ever be ported back to this version, and none of the more recent Coveo JavaScript Search Framework releases have been, or will be, officially tested with the on-premises Search API. This means that many features may not work when using a release of the Coveo JavaScript Search Framework whose version number is higher than 1.0.420 with the on-premises Search API.

If you have an on-premises Coveo index and want to upgrade to a more recent version of the Coveo JavaScript Search Framework, you need to have a hybrid deployment (an on-premises index that relies on the cloud version of the Search API). If this is what you want to do, contact Coveo Support.