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 V2 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 V2 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
Usage Analytics Write
Usage Analytics Read
Platform
  • Create, update, or delete a Coveo Cloud organization.
  • Access a Coveo Cloud V2 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 V2 indexing pipeline extensions.
Push
Index
  • Access the permission models of indexed items.
Fields
Extension
  • Manage and test pre- and post- conversion Coveo Cloud V2 indexing pipeline extensions.
Source Logs
Activity
  • Access the activity information of a Coveo Cloud V2 organization.
Notification
  • Manage and test activity notification subscriptions for a Coveo Cloud V2 organization.
Authorization Server
  • Manage SAML security identity providers for a Coveo Cloud V2 organization.
  • Manage groups, members, and API keys in a Coveo Cloud V2 organization.
Security Cache
  • Manage non-SAML security identity providers for a Coveo Cloud V2 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 V2 API reference documentation site (see Coveo Cloud Platform API).