How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Coveo Setup API

The Setup API from Coveo — 1 operation(s) for setup.

Coveo Setup API is one of 152 APIs that Coveo publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 34 JSON Schema definitions.

Tagged areas include Setup. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a JSON-LD context, and 34 JSON Schemas.

This API exposes 1 operation across 1 path, and defines 12 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0.

Requests are made against a single base URL, https://platform.cloud.coveo.com.

1 operations 1 paths 12 schemas 1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.0
Base URL
https://platform.cloud.coveo.com
Authentication
OAuth 2.0
Contact
Terms of Service
Resource Areas
1

Authentication & Security 1

Coveo Setup API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (oauth2) using the authorizationCode flow, exposing 1 scope. By default, every request must be authenticated.

Paths & Operations 1

Across 1 path, the API surfaces 1 operation — 1 POST. Each is listed below with its method, path, parameters, and response codes.

Setup 1
POST
/rest/organizations/{organizationId}/commerce/v2/setup
Create CMH Scaffolding
setup 1 param body → 200

Schemas 12

The contract defines 12 schemas that model the data the API accepts and returns. The most detailed are TrackingIdToCatalogMappingModel (6 properties), TrackingIdToCatalogMappingCatalogModel (5 properties), QueryPipelineConfigurationModel (4 properties), TrackingIdToCatalogMappingSetupModel (4 properties). Each schema is shown below with its type and property counts.

SetupRequestModel
object
The scaffolding to setup.
3 properties 1 required
SetupResponseModel
object
3 properties
TrackingIdToCatalogMappingCatalogModelCatalogConfiguration
object
The configuration of the catalog
2 properties
GlobalConfigurationUpdatedModel
object
The list of updated global configurations.
2 properties
TrackingIdToCatalogMappingCatalogModel
object
This will contain the full catalog info as per the catalog resource
5 properties
TrackingIdToCatalogMappingSetupModel
object
The mappings related to the supplied tracking IDs
4 properties 4 required
TrackingIdToCatalogMappingCatalogModelCatalogConfigurationProduct
object
1 property
QueryPipelineConfigurationModel
object
The list of query pipeline configurations created or modified.
4 properties
ProductGrouping
object
Indicates whether the pipeline should be grouped. Use this option to control the aggregation behavior of the pipeline. If null, the grouping will not be change…
2 properties 1 required
TrackingIdToCatalogMappingCatalogModelCatalogConfigurationAvailability
object
1 property
PipelineSetup
object
List of pipeline setups to configure
3 properties 1 required
TrackingIdToCatalogMappingModel
object
6 properties 5 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

coveo-setup-api-openapi.yml Raw ↑

Other APIs Coveo publishes across the network.

Coveo Activities API
Coveo Administration API - Version 15 API
Coveo Advanced Model Configurations API
Coveo Agent Configuration API API
Coveo Agent Orchestration API API
Coveo Analysis V3 API
Coveo Analytics API - Version 14 API
Coveo Analytics API - Version 15 API
Coveo Answer API
Coveo Api Keys API
Coveo Atlassian Connect App API
Coveo Badges API
Where this information came from

This is an independent, third-party profile of Coveo Setup API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.