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
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Coveo

Coveo Synonym Preview API

The Synonym Preview API from Coveo — 1 operation(s) for synonym preview.

Documentation Provider Profile APIs.io OpenAPI GitHub

Coveo Synonym Preview 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 Synonym Preview. 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 17 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 17 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
Coveo
Terms of Service
View terms
Resource Areas
1

Authentication & Security 1

Coveo Synonym Preview 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.

Synonym Preview 1
POST
/rest/organizations/{organizationId}/commerce/v2/search/preview/synonyms/new
Preview the Impact of a Synonym Rule
previewSynonym 3 params body → 200

Schemas 17

The contract defines 17 schemas that model the data the API accepts and returns. The most detailed are SynonymPreviewRequestModel_V2ProductView (9 properties), PaginationResponseModel_V2ProductView (6 properties), PreviewResponseModel_V2ProductView (6 properties), SynonymModel_V2ProductView (6 properties). Each schema is shown below with its type and property counts.

PreviewResponseExecutionReportsModel_V2ProductView
object
The execution reports for a preview query.
PreviewResponseIdsModel_V2ProductView
object
The unique identifiers of the API responses for a preview request.
2 properties
SynonymPreviewRequestModel_V2ProductView
object
9 properties 4 required
PreviewResult_V2ProductView
object
Preview result item that can be a product or spotlight content (including placeholders)
1 property 1 required
Product_V2ProductView
object
PaginationResponseModel_V2ProductView
object
Contextual pagination information about the query.
6 properties
ProductForPreview_V2ProductView
object
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
PreviewResponseModel_V2ProductView
object
6 properties
WordCorrection_V2ProductView
object
The word correction suggestions.
4 properties
SynonymModel_V2ProductView
object
The synonym rule to preview.
6 properties 2 required
BadgePlacementViewModel_V2ProductView
object
The list of badge placements associated with this product.
2 properties
ChildProduct_V2ProductView
object
QueryCorrectionResponse_V2ProductView
object
The query correction response, if the query was corrected.
3 properties
Result_V2ProductView
object
List of results including products and spotlight content
1 property 1 required
RuleLocaleModel_V2ProductView
object
The list of locales the rule applies to. When empty, the rule applies to all locales.
3 properties
BadgeViewModel_V2ProductView
object
The list of badges associated with this placement
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

coveo-synonym-preview-api-openapi.yml Raw ↑

Other APIs Coveo publishes across the network.

Coveo Activities API
AE Profile APIs.io
Coveo Administration API - Version 15 API
AE Profile APIs.io
Coveo Advanced Model Configurations API
AE Profile APIs.io
Coveo Agent Configuration API API
AE Profile APIs.io
Coveo Agent Orchestration API API
AE Profile APIs.io
Coveo Analysis V3 API
AE Profile APIs.io
Coveo Analytics API - Version 14 API
AE Profile APIs.io
Coveo Analytics API - Version 15 API
AE Profile APIs.io
Coveo Answer API
AE Profile APIs.io
Coveo Api Keys API
AE Profile APIs.io
Coveo Atlassian Connect App API
AE Profile APIs.io
Coveo Badges API
AE Profile APIs.io
#Synonym Preview
← Back to C APIs
API Details
ID
coveo:coveo-synonym-preview-api
Base URL
https://platform.cloud.coveo.com
Docs
https://docs.coveo.com/en/124/
Provider
Coveo
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=coveo-synonym-preview-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/coveo-synonym-preview-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of Coveo Synonym Preview 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.