Coveo Search V2 API
The Search V2 API from Coveo — 16 operation(s) for search v2.
Coveo Search V2 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 Search (v2). The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a JSON-LD context, and 34 JSON Schemas.
This API exposes 23 operations across 16 paths, and defines 120 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.
23 operations
16 paths
120 schemas
12 GET11 POST
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 4
Coveo Search V2 API declares
4 security schemes
for authenticating requests.
It supports OAuth 2.0 (oauth2) using the implicit flow, exposing 1 scope.
It accepts HTTP bearer tokens (JWT) (platformTokens).
It accepts HTTP bearer tokens (JWT) (searchTokens).
It accepts HTTP bearer tokens (apiKey).
oauth2— This API uses OAuth 2 with the implicit grant flow.platformTokens— Platform tokens are used to authenticate requests to the platform as a specific user. See [Use platform token authentication](https://docs.coveo.com/en/n3ge002…searchTokens— Search tokens are used to authenticate search-related API requests. See [Use search token authentication](https://docs.coveo.com/en/56).apiKey— API keys are used to authenticate requests to the platform as a specific user. See [Use API key authentication with the Search API](https://docs.coveo.com/en/1…
Paths & Operations 23
Across 16 paths, the API surfaces 23 operations — 12 GET, 11 POST. Each is listed below with its method, path, parameters, and response codes.
Search V2 23
GET
/rest/search/v2
Send Search Request
POST
/rest/search/v2
Send Search Request
GET
/rest/search/v2/plan
Plan Search Execution
POST
/rest/search/v2/plan
Plan Search Execution
GET
/rest/search/v2/querySuggest
Request Query Suggestions
POST
/rest/search/v2/querySuggest
Request Query Suggestions
POST
/rest/search/v2/facet
Send Facet Search Request
GET
/rest/search/v2/fields
List All Fields
GET
/rest/search/v2/values
Get Values for One Field
POST
/rest/search/v2/values
Get Values for One Field
GET
/rest/search/v2/values/batch
Get Values for Several Field
POST
/rest/search/v2/values/batch
Get Values for Several Field
GET
/rest/search/v2/html
Get HTML Item Preview
POST
/rest/search/v2/html
Get HTML Item Preview
GET
/rest/search/v2/text
Get Item in Text Format
GET
/rest/search/v2/datastream
Get Item Data Stream
GET
/rest/search/v2/document
Get Item in JSON Format
POST
/rest/search/v2/token
Create Search Token
GET
/rest/search/v2/login/{provider}
Log in to Authentication Provider
POST
/rest/search/v2/login/{provider}
Log in to Authentication Provider
GET
/rest/search/v2/extensions
List Available Query Extensions
POST
/rest/search/v2/ratingdeprecated
Update User Rating
POST
/rest/search/v2/fields/find
Find Fields from Results of a Query Expression
Schemas 120
The contract defines 120 schemas that model the data the API accepts and returns. The most detailed are RestQueryParametersBase (49 properties), RestQueryResult (37 properties), RestQueryResponse (29 properties), RestCommonQueryParameters (23 properties). Each schema is shown below with its type and property counts.
FindFieldsRequest
object
2 properties
FindFieldsResponse
object
1 property
1 required
RestFacetValueNumericalRangeBase
object
2 properties
2 required
RestListFieldValuesBatchParameterBase
object
1 property
1 required
CommerceParameters
object
3 properties
RestQueryCorrection
object
2 properties
2 required
RestFacetRequestSpecificSortCriteriaExplicitAlphanumeric
object
2 properties
1 required
Debug
booleannull
Whether to force a successful response to include debug information. Notes: - Debug information can only appear in responses in the JSON format (see the format…
RestFieldAliases
object
A key-value store where each pair corresponds to the name of an alias, along with the key to target within which dictionary field to query. Note: This cannot b…
RestFacetResultDomain
object
The domain of the facet. It represents the lowest and highest values possible for this facet. Note: This property is only populated when the facet is a range f…
2 properties
RestFacetResult
object
8 properties
4 required
DQ
string
The disjunction query expression, typically populated by Coveo ML Automatic Relevance Tuning (ART) models to ensure that relevant items are included in the que…
RestQuerySuggestParameters
RestGroupByValue
object
11 properties
6 required
RestFacetRequestSpecificBaseAllowedValues
RestFacetRequestNumericalRange
Locale
stringnull
The locale of the current user. Must comply with IETF's [BCP 47](http://www.rfc-editor.org/rfc/bcp/bcp47.txt) definition. Coveo Machine Learning models use thi…
RestQuestionAnswer
object
7 properties
6 required
SearchHub
stringnull
The first level of origin of the request, typically the identifier of the graphical search interface from which the request originates. Coveo Machine Learning…
RestFacetResultValue
object
8 properties
2 required
RestFacetRequestSpecificBaseAllowedValuesSimple
object
The field values allowed in the facet operation results. If you do not explicitly specify an array of allowedValues, or if you specify an empty array, all fiel…
2 properties
2 required
RestFacetSearchParametersHierarchical
object
11 properties
1 required
RestFacetRequestSpecific
Pipeline
stringnull
The name of the query pipeline to use for this request (bypassing its conditions, if it has any). You can pass an empty pipeline value to use an empty query pi…
RestFacetRequestNumericalRangeBase
object
3 properties
1 required
RestFacetValueBase
object
3 properties
RestListFieldValuesBatchParameter
RestComputedField
object
2 properties
2 required
RestListFieldValuesParameterBase
object
12 properties
1 required
AQ
string
The advanced query expression, typically generated by code (e.g., when toggling facet values). Note: When logging a Search usage analytics event for a query, t…
CQ
string
The constant query expression, typically populated with expressions that must apply to all queries sent from a specific search interface (e.g., from a specific…
RestFacetValueNumericalRange
RestQueryParameters
Timezone
stringnull
The [tz database](https://en.wikipedia.org/wiki/Listoftzdatabasetimezones) identifier of the time zone to use to correctly interpret dates in the query express…
RestQueryFunction
object
4 properties
2 required
RestFacetSearchResultValue
object
3 properties
3 required
RestAutomaticFacetScope
object
To determine which fields are relevant for the current query, we consider all facet and multi-value facet fields that have the parameter "automaticFacetsCandid…
2 properties
RestFacetRequestSpecificBase
object
7 properties
Format
stringnull
The format of a successful response. - Use json to get the response in the JSON format. - Use xlsx to generate an Excel file containing the results (binary). N…
RestRankingFunction
object
3 properties
1 required
RestTokenResponse
object
1 property
ListFieldValuesValuesResponse
object
3 properties
3 required
IndexToken
stringnull
The Base64 encoded identifier of the index mirror to forward the request to. See also the index parameter. If you do not specify an indexToken (or index) value…
Recommendation
stringnull
The identifier of the recommendation interface from which the request originates (see [CoveoRecommendation](https://coveo.github.io/search-ui/components/recomm…
ActionsHistory
arraynull
The query and page view actions previously made by the current user. Coveo Machine Learning event recommendations models use this information to provide contex…
RestFacetValueHierarchicalBase
object
4 properties
1 required
Context
objectnull
The custom context information to send along with the request. Must be a dictionary of key-value pairs (JSON) where each key is a string, and each value is eit…
RestRangeValue
object
4 properties
2 required
RestHierarchicalFacetResponseValue
object
8 properties
4 required
RestFacetRequestSpecificSortCriteriaExplicitAlphanumericNatural
object
2 properties
1 required
AnalyticsRequestParameters
objectnull
14 properties
RestFacetRequestSpecificSortCriteria
LogicalIndex
stringnull
The identifier for a logical group of indexes that have been configured to include documents from the same sources. If you do not specify a logicalIndex value,…
RestFacetRequestDateRangeBase
object
2 properties
1 required
RestTriggerResponse
object
2 properties
2 required
RestCommerceParameters
object
3 properties
RestUserId
object
6 properties
6 required
RestFacetRequestHierarchicalBase
object
7 properties
1 required
RestGroupByResult
object
5 properties
3 required
RestFacetRequestSpecificSortCriteriaString
string
The sort criterion to apply to the returned facet values. Allowed values: - score: Sort values in descending score order. Facet value scores are based on the n…
RestCategoryFacetRequest
object
6 properties
1 required
RestFacetValueDateRangeBase
object
2 properties
2 required
RestContentId
object
2 properties
2 required
PlanSearchResponse
object
2 properties
1 required
RestFacetValueSpecificBase
object
1 property
1 required
RestQueryParametersBase
object
49 properties
ParsedQueryResponse
object
6 properties
Language
stringnull
This parameter is exposed for backward compatibility reasons. Use the locale parameter instead.
RestFacetValueRangeBase
object
1 property
RestAllowedDictionaryFieldKeys
object
The [dictionary field](https://docs.coveo.com/en/2036/) keys to allow access to when authenticating a query with this search token. This value controls which f…
RestFacetValueDateRange
RestQueryParentResult
RestSuggestedFacet
object
2 properties
2 required
RestFacetRequestRangeBase
object
4 properties
MlParameters
objectnull
A map of options to pass to the Coveo ML models associated with the request's target query pipeline. Available parameters: - considerUserContext (boolean): Whe…
RestCategoryFacetValue
array
ActionHistory
object
3 properties
LQ
string
The large query expression, typically populated with a case description, long textual query, or any other form of text that can help refine a query. The Coveo…
RestFacetOptions
objectnull
2 properties
RestFacetRequest
RestFacetRequestHierarchical
RestHighlightResponse
object
2 properties
2 required
RestQuerySuggestParametersBase
object
4 properties
RestFacetRequestSpecificSortCriteriaExplicitOccurences
object
1 property
1 required
Referrer
stringnull
The third level of origin of the request, typically the URL of the page that linked to the search interface from which the request originates (e.g., in JavaScr…
VisitorId
stringnull
A GUID which represents the current user, who can either be authenticated or anonymous. visitorId is deprecated and has been replaced by [clientId](https://doc…
Q
string
The basic query expression, typically the keywords entered by the end user in a query box. Note: When logging a Search usage analytics event for a query, the q…
MaximumAge
integernull
The maximum age of cached results, in milliseconds. If the results of a specific request are available in the cache, and if those results are no older than the…
RestGroupBy
object
17 properties
1 required
RestWordCorrection
object
4 properties
4 required
IndexType
stringnull
The type of index against which to execute the query. Must correspond to an index that has been configured for the target Coveo Cloud organization. Default: co…
RestQueryResult
object
37 properties
29 required
QuerySuggestResponse
object
3 properties
2 required
ListFieldValuesBatchResponse
object
1 property
1 required
RestFacetRequestSpecificSortCriteriaExplicitCustomSort
object
The customSort sortCriteria has been deprecated. You should leverage the customSort attribute of the facet request.
2 properties
2 required
RestFacetRequestSpecificSortCriteriaExplicitScore
object
1 property
1 required
RestSuggestedFacetValue
object
2 properties
1 required
RestException
object
2 properties
1 required
Index
stringnull
The identifier of the index mirror to forward the request to. See also the indexToken parameter. If you do not specify an index (or indexToken) value, any inde…
RestFacetSearchParametersSpecific
object
9 properties
1 required
Tab
stringnull
The second level of origin of the request, typically the identifier of the selected tab in the graphical search interface from which the request originates. Co…
ListFieldsResponse
object
1 property
RestUserActionParameter
object
1 property
MaximumTimeoutMs
integernull
The maximum number of milliseconds to allow the request to last before timing out. Maximum: 10000 Minimum/Default: 0, meaning that Coveo determines the most ap…
RestListFieldValuesParameter
RestCommonQueryParameters
object
23 properties
RestFacetSearchResponse
object
2 properties
2 required
PreprocessingOutput
object
1 property
1 required
RestFacetSearchParameters
RestFacetRequestSpecificSortCriteriaExplicit
RestFacetRequestBase
object
8 properties
1 required
RestFacetValueHierarchical
RestFacetRequestDateRange
RestQueryResponse
object
29 properties
18 required
RestTokenParams
object
19 properties
1 required
ListFieldValuesResponse
object
1 property
1 required
PipelineRuleParameters
objectnull
This defines generic parameters to be used by rules. It defines the "scopes", or in other words, the rules in which the parameters should be used. The generic…
RestCategoryFacetResponse
object
3 properties
ErrorMessage
object
3 properties
RestFacetSpecificValue
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Coveo 12
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
#Search (v2)
Where this information came from
This is an independent, third-party profile of Coveo Search V2 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.