Use the Search API

This is for:

Developer

The Search API exposes services which let you create and manage search authentication providers and query pipelines. Most importantly, the Search API lets you perform queries on an index.

Search pages based on the Coveo JavaScript Search Framework are powered by the Search API.

Notes

  • Search integrations with the Coveo Platform typically rely on the JavaScript Search Framework rather than directly on the Search API (and other APIs).

    If, for some legitimate reason, you can’t use the JavaScript Search Framework in your custom search integration with the Coveo Platform, see Use the REST APIs to build a search UI.

  • All REST API string fields are case-sensitive unless otherwise specified. For example, search queries aren’t case-sensitive.

    To keep behavior consistent across the Coveo Platform, the same value passed to different REST APIs must always be passed using the same case. For example, if the unique product identifier, such as ec_product_id, is passed to the Commerce API in lowercase, then it should also be passed to the Usage Analytics Write API in lowercase.

In the Coveo Administration Console, the Content Browser (platform-ca | platform-eu | platform-au) page, and all of the pages under the Search section use the Search API extensively (see Tune relevance).

The articles in this section cover various Search API concepts and use cases:

Interactive generated reference documentation is also available through Swagger UI.