---
title: Coveo REST APIs overview
slug: '143'
canonical_url: https://docs.coveo.com/en/143/
collection: apis
source_format: adoc
---
# Coveo REST APIs overview
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 [Coveo Analytics data](https://docs.coveo.com/en/259/) to yield [Coveo Machine Learning](https://docs.coveo.com/en/188/)-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](https://docs.coveo.com/en/183/) or from an [Atomic](https://docs.coveo.com/en/lcdf0264/) or [Headless](https://docs.coveo.com/en/lcdf0493/) [search interface](https://docs.coveo.com/en/2741/).

The following diagram provides a visual overview of the main interactions between the REST API services and a [Coveo organization](https://docs.coveo.com/en/185/).


![Visual overview of the main interactions between the REST API services and a Coveo organization](https://docs.coveo.com/en/assets/images/coveo-platform/api-overview.svg)

> **Tip**
>
> You may want to use the [Official Coveo APIs JavaScript Client](https://github.com/coveo/platform-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](https://docs.coveo.com/en/3074/).

To keep behavior consistent across the [Coveo Platform](https://docs.coveo.com/en/186/), the same value passed to different REST APIs must always be passed using the same case.
For example, if the [unique product identifier](https://docs.coveo.com/en/n73f0502#define-a-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.

[%header, cols="2,4,^1,^1"]
|===
|API name
|Usage
|Reference documentation
|Guide

|Activity
|Access the [activity](https://docs.coveo.com/en/173/) information of a Coveo organization.
|[code]
|N/A

|Authorization Server
a|* Manage SAML security identity providers for a Coveo organization.
* Manage groups, members, and API keys in a Coveo organization.
|[code]
|[guide]

|Extension
|Manage and test pre- and post-conversion indexing pipeline extensions.
|[code]
|[guide]

|Field
|Manage [fields](https://docs.coveo.com/en/200/) in an index.
|[code]
|[guide]

|Index
|Access the permission models of indexed items.
|[code]
|[guide]

|Machine Learning
|Manage Coveo ML models in an organization.
|[code]
|[guide]

|Notification
|Manage and test activity notification subscriptions for a Coveo organization.
|[code]
|[guide]

|Platform
a|* Create, update, or delete a [Coveo organization](https://docs.coveo.com/en/185/).
* Access a Coveo organization status, login activity, [license](https://docs.coveo.com/en/2864/), and [limit](https://docs.coveo.com/en/262/) information.
* Access Crawling Module, worker, and database versions.
|[code]
|[guide]

|Push
|Push [items](https://docs.coveo.com/en/210/) and their respective [permission models](https://docs.coveo.com/en/225/) to a Push source, and push [security identities](https://docs.coveo.com/en/240/) to a [security identity provider](https://docs.coveo.com/en/242/) (as opposed to **pulling** content into a "standard" source using Coveo crawlers).
|[code]
|[guide]

|Schema
|Manage Coveo for Salesforce schemas.
|[code]
|N/A

|Search
a|* Perform [queries](https://docs.coveo.com/en/231/) on an [index](https://docs.coveo.com/en/204/).
* Manage search authentication providers (SharePoint claims and SAML) (see [Configure claims authentication](https://docs.coveo.com/en/113/) and [Configure a SAML identity provider using the Search API](https://docs.coveo.com/en/91/)).
* Create [search tokens](https://docs.coveo.com/en/56/).
* Manage [Coveo query pipelines](https://docs.coveo.com/en/180/).
|[code]
|[guide]

|Search Pages
|Manage hosted search pages in a Coveo organization.
|[code]
|N/A

|Search Usage Metrics
|Review search consumption data.
|[code]
|N/A

|Security Cache
a|* Manage non-SAML security identity providers for a Coveo organization.
* Manage security cache refresh schedules.
|[code]
|[guide]

|Source
|Manage [sources](https://docs.coveo.com/en/246/) and their related field mappings as well as pre- and post-conversion Coveo indexing pipeline extensions.
|[code]
|[guide]

|Source Logs
|Access the [Coveo indexing pipeline](https://docs.coveo.com/en/184/) logs of a source.
|[code]
|N/A

|Usage Analytics Read
|Access usage analytics data (statistics, [reports](https://docs.coveo.com/en/266/), [dimensions](https://docs.coveo.com/en/258/), [metrics](https://docs.coveo.com/en/263/), etc.).
|[code]
|[guide]

|Usage Analytics Write
|Record [Coveo Analytics](https://docs.coveo.com/en/182/) events (click, search, view, or custom [events](https://docs.coveo.com/en/260/)).
|[code]
|[guide]
|===

## Generated Swagger UI documentation site

You can visualize the API reference documentation and test API calls using the generated [Swagger UI](https://platform.cloud.coveo.com/docs) ([platform-ca](https://platform-ca.cloud.coveo.com/docs) | [platform-eu](https://platform-eu.cloud.coveo.com/docs) | [platform-au](https://platform-au.cloud.coveo.com/docs)) Coveo API reference documentation site.