Overview

This is for:

Developer

In this article

Coveo REST APIs
Generated Swagger UI documentation site

Coveo is a native cloud SaaS/PaaS solution that provides a unified and secure way to query content across many enterprise systems. The platform relies on usage analytics data to yield Coveo Machine Learning-powered recommendations. Coveo embraces the concepts of micro-services and scalability, allowing users to expand their search solution as their business grows.

As such, Coveo exposes REST APIs which you can use to achieve anything you could do from the Coveo Administration Console or from an Atomic or Headless search interface.

The following diagram provides a visual overview of the main interactions between the REST API services and a Coveo organization.

You may want to use the Official Coveo APIs JavaScript Client to query Coveo APIs.

Coveo REST APIs

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.

API name	Usage	Guide
Activity	Access the activity information of a Coveo organization.	N/A
Authorization Server	Manage SAML security identity providers for a Coveo organization. Manage groups, members, and API keys in a Coveo organization.
Extension	Manage and test pre- and post-conversion indexing pipeline extensions.
Field	Manage fields in an index.
Index	Access the permission models of indexed items.
Machine Learning	Manage Coveo ML models in an organization.
Notification	Manage and test activity notification subscriptions for a Coveo organization.
Platform	Create, update, or delete a Coveo organization. Access a Coveo organization status, login activity, license, and limit information. Access Crawling Module, worker, and database versions.
Push	Push items and their respective permission models to a Push source, and push security identities to a security identity provider (as opposed to pulling content into a "standard" source using Coveo crawlers).
Schema	Manage Coveo for Salesforce schemas.	N/A
Search	Perform queries on an index. Manage search authentication providers (SharePoint claims and SAML) (see Configure claims authentication and Configure a SAML identity provider using the Search API). Create search tokens. Manage Coveo query pipelines.
Search Pages	Manage hosted search pages in a Coveo organization.	N/A
Search Usage Metrics	Review search consumption data.	N/A
Security Cache	Manage non-SAML security identity providers for a Coveo organization. Manage security cache refresh schedules.
Source	Manage sources and their related field mappings as well as pre- and post-conversion Coveo indexing pipeline extensions.
Source Logs	Access the Coveo indexing pipeline logs of a source.	N/A
Usage Analytics Read	Access usage analytics data (statistics, reports, dimensions, metrics, etc.).
Usage Analytics Write	Record Coveo Usage Analytics (Coveo UA) events (click, search, view, or custom events).

API name

Usage

Reference documentation

Guide

Activity

Access the activity information of a Coveo organization.

N/A

Authorization Server

Manage SAML security identity providers for a Coveo organization.
Manage groups, members, and API keys in a Coveo organization.

Extension

Manage and test pre- and post-conversion indexing pipeline extensions.

Field

Manage fields in an index.

Index

Access the permission models of indexed items.

Machine Learning

Manage Coveo ML models in an organization.

Notification

Manage and test activity notification subscriptions for a Coveo organization.

Platform

Create, update, or delete a Coveo organization.
Access a Coveo organization status, login activity, license, and limit information.
Access Crawling Module, worker, and database versions.

Push

Push items and their respective permission models to a Push source, and push security identities to a security identity provider (as opposed to pulling content into a "standard" source using Coveo crawlers).

Schema

Manage Coveo for Salesforce schemas.

N/A

Perform queries on an index.
Manage search authentication providers (SharePoint claims and SAML) (see Configure claims authentication and Configure a SAML identity provider using the Search API).
Create search tokens.
Manage Coveo query pipelines.

Search Pages

Manage hosted search pages in a Coveo organization.

N/A

Search Usage Metrics

Review search consumption data.

N/A

Security Cache

Manage non-SAML security identity providers for a Coveo organization.
Manage security cache refresh schedules.

Source

Manage sources and their related field mappings as well as pre- and post-conversion Coveo indexing pipeline extensions.

Source Logs

Access the Coveo indexing pipeline logs of a source.

N/A

Usage Analytics Read

Access usage analytics data (statistics, reports, dimensions, metrics, etc.).

Usage Analytics Write

Record Coveo Usage Analytics (Coveo UA) events (click, search, view, or custom events).

Generated Swagger UI documentation site

You can visualize the API reference documentation and test API calls using the generated Swagger UI (platform-ca | platform-eu | platform-au) Coveo API reference documentation site.