Use the Source API

This is for:

Developer System Administrator

The Source API exposes services which let you create and manage sources and their corresponding mapping configuration and indexing pipeline extensions (IPEs) in a Coveo organization.

In the Coveo Administration Console, the Sources (platform-ca | platform-eu | platform-au) page uses the Source API extensively.

Note

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.

The articles in this section cover various Source API use cases:

Interactive generated reference documentation is also available through the Swagger UI.