Coveo Cloud V2 API Overview

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

As such, the Coveo Cloud platform exposes REST APIs which you can use to achieve anything you could do from the Coveo Cloud V2 Administration Console or from a JavaScript Search Framework page.

The Search, Usage Analytics Write, and Usage Analytics Read APIs work with both Coveo Cloud V1 and V2 organizations. However, aside from those three services, the Coveo Cloud V1 platform does not publicly expose any API endpoints.

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

Coveo Cloud V2 REST APIs

API name	Usage	Reference documentation	Guide
Search	Perform queries on an index. Manage search authentication providers (SharePoint claims and SAML) (see Claims Authentication and SAML Authentication). Create search tokens (see Search Token Authentication). Manage Coveo Cloud query pipelines.
Usage Analytics Write	Record Coveo Usage Analytics (Coveo UA) events (click, search, view, or custom events).
Usage Analytics Read	Access usage analytics data (statistics, reports, dimensions, metrics, etc.).
Platform	Create, update, or delete a Coveo Cloud organization. Access a Coveo Cloud organization status, login activity, license, and limit information. Access Crawling module, worker, and database versions.
Source	Manage sources and their related field mappings and pre- and post- conversion Coveo Cloud indexing pipeline extensions.
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 Cloud crawlers).
Index	Access the permission models of indexed items.
Fields	Manage fields in an index.
Extension	Manage and test pre- and post- conversion Coveo Cloud indexing pipeline extensions.
Source Logs	Access the Coveo Cloud indexing pipeline logs of a source.
Activity	Access the activity information of a Coveo Cloud organization.
Notification	Manage and test activity notification subscriptions for a Coveo Cloud organization.
Authorization Server	Manage SAML security identity providers for a Coveo Cloud organization. Manage groups, members, and API keys in a Coveo Cloud organization.
Security Cache	Manage non-SAML security identity providers for a Coveo Cloud organization. Manage security cache refresh schedules.

Generated Swagger UI Documentation Site

You can visualize the API reference documentation and test API calls using the generated Swagger UI Coveo Cloud API reference documentation site (see Coveo Cloud Platform API).