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 Recommendations API

The Recommendations API from Coveo — 2 operation(s) for recommendations.

Coveo Recommendations 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 Recommendations. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a JSON-LD context, and 34 JSON Schemas.

This API exposes 2 operations across 2 paths, and defines 23 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.

2 operations 2 paths 23 schemas 2 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 Recommendations 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 2

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

Recommendations 2
POST
/rest/organizations/{organizationId}/commerce/v2/recommendations
Execute a Recommendations Query
recommendations 1 param body → 200
POST
/rest/organizations/{organizationId}/commerce/v2/recommendations/preview
Preview a Recommendations Query
recommendationsPreview 1 param body → 200

Schemas 23

The contract defines 23 schemas that model the data the API accepts and returns. The most detailed are RecommendationsPreviewRequestModel_V2ProductView (11 properties), RecommendationsRequestModel_V2ProductView (10 properties), RecommendationsContextModel_V2ProductView (9 properties), PaginationResponseModel_V2ProductView (6 properties). Each schema is shown below with its type and property counts.

ProductForPreview_V2ProductView
object
WordCorrection_V2ProductView
object
The word correction suggestions.
4 properties
BadgePlacementViewModel_V2ProductView
object
The list of badge placements associated with this product.
2 properties
RecommendationsRequestModel_V2ProductView
object
The recommendations query to be executed.
10 properties 6 required
PreviewResponseExecutionReportsModel_V2ProductView
object
The execution reports for a preview query.
PaginationResponseModel_V2ProductView
object
Contextual pagination information about the query.
6 properties
Result_V2ProductView
object
List of results including products and spotlight content
1 property 1 required
QueryCorrection_V2ProductView
object
If the query wasn't automatically corrected, this property contains the basic query expression (q) keyword corrections provided by the Did You Mean index featu…
2 properties
BadgeViewModel_V2ProductView
object
The list of badges associated with this placement
4 properties
Product_V2ProductView
object
TriggerModel_V2ProductView
object
The actions for the client to perform based on the Trigger statements defined.
2 properties
RecommendationsContextModel_V2ProductView
object
Contextual information about the query.
9 properties 1 required
ProductItemModel_V2ProductView
object
The product ID used to generate the recommendations.
1 property
ChildProduct_V2ProductView
object
CartItemModel_V2ProductView
object
A purchased item.
2 properties
PreviewResponseIdsModel_V2ProductView
object
The unique identifiers of the API responses for a preview request.
2 properties
ViewModel_V2ProductView
object
A collection of data points describing the view. Note: The term 'view' is used instead of 'page' to accommodate usage in contexts such as mobile apps.
2 properties 1 required
RecommendationsResponseModel_V2ProductView
object
5 properties
PreviewResult_V2ProductView
object
Preview result item that can be a product or spotlight content (including placeholders)
1 property 1 required
UserModel_V2ProductView
object
The user information.
1 property
PreviewResponseModel_V2ProductView
object
6 properties
RecommendationsPreviewRequestModel_V2ProductView
object
The recommendations query to be executed.
11 properties 5 required
QueryCorrectionResponse_V2ProductView
object
The query correction response, if the query was corrected.
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

coveo-recommendations-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 Recommendations 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.