openapi: 3.0.1
info:
title: Coveo Search API
description: Documentation for Coveo Search API
termsOfService: http://www.coveo.com/en/support/terms-agreements
contact:
name: [email protected]
license:
name: ''
version: 1.0.0
x-ApiVersion: V3
servers:
- url: https://platform.cloud.coveo.com
description: Coveo public API endpoint
tags:
- name: Search V3
x-displayName: Search V3
- name: Passages V3
x-displayName: Passages V3
- name: Analysis V3
x-displayName: Analysis V3
- name: Search V2
x-displayName: Search
- name: Statements V2
x-displayName: Statements
- name: Result rankings
x-displayName: Result rankings
- name: Machine learning associations
x-displayName: Machine learning associations
- name: Statement groups
x-displayName: Statement groups
- name: Pipelines
x-displayName: Pipelines
- name: Statements V1
x-displayName: Statements
- name: Conditions
x-displayName: Conditions
- name: Passages Alpha
x-displayName: Passages Alpha
- name: Organizations
x-displayName: Organizations
paths:
/rest/search/v3:
post:
tags:
- Search V3
summary: Send Search Request
description: 'See [Performing a Query](https://docs.coveo.com/en/1445/).
<details>
<summary>Privilege(s) required</summary>
```json
{"level":"NORMAL","owner":"SEARCH_API","targetDomain":"EXECUTE_QUERY","type":"ENABLE","targetId":"*"}
```
</details>'
operationId: searchUsingPostV3
parameters:
- $ref: '#/components/parameters/OrganizationIdQuery'
- $ref: '#/components/parameters/ViewAllContentQuery'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/RestQueryParameters'
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/RestQueryResponse'
application/xml:
schema:
$ref: '#/components/schemas/RestQueryResponse'
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet:
schema:
$ref: '#/components/schemas/RestQueryResponse'
security:
- oauth2:
- full
/rest/search/v3/facet:
post:
tags:
- Search V3
summary: Send Facet Search Request
description: 'Executes a facet search request.
<details>
<summary>Privilege(s) required</summary>
```json
{"level":"NORMAL","owner":"SEARCH_API","targetDomain":"EXECUTE_QUERY","type":"ENABLE","targetId":"*"}
```
</details>'
operationId: facetSearchV3
parameters:
- $ref: '#/components/parameters/OrganizationIdQuery'
- $ref: '#/components/parameters/ViewAllContentQuery'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/RestFacetSearchParameters'
required: true
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/RestFacetSearchResponse'
security:
- oauth2:
- full
/rest/search/v3/plan:
post:
tags:
- Search V3
summary: Plan Search Execution
description: 'See [Performing a Query](https://docs.coveo.com/en/1445/).
<details>
<summary>Privilege(s) required</summary>
```json
{"level":"NORMAL","owner":"SEARCH_API","targetDomain":"EXECUTE_QUERY","type":"ENABLE","targetId":"*"}
```
</details>'
operationId: planSearchUsingPostV3
parameters:
- $ref: '#/components/parameters/OrganizationIdQuery'
- $ref: '#/components/parameters/ViewAllContentQuery'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/RestQueryParameters'
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/PlanSearchResponse'
security:
- oauth2:
- full
/rest/search/v3/querySuggest:
post:
tags:
- Search V3
summary: Request Query Suggestions
description: 'See [Getting Query Suggestions](https://docs.coveo.com/en/1459/).
<details>
<summary>Privilege(s) required</summary>
```json
{"level":"NORMAL","owner":"SEARCH_API","targetDomain":"EXECUTE_QUERY","type":"ENABLE","targetId":"*"}
```
</details>'
operationId: querySuggestPostV3
parameters:
- $ref: '#/components/parameters/OrganizationIdQuery'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/RestQuerySuggestParameters'
responses:
'200':
description: The suggested completions for the query.
content:
application/json:
schema:
$ref: '#/components/schemas/QuerySuggestResponse'
security:
- oauth2:
- full
/rest/search/v3/values:
post:
tags:
- Search V3
summary: Get Values for One Field
description: 'Lists all values of the target field.
<details>
<summary>Privilege(s) required</summary>
```json
{"level":"NORMAL","owner":"SEARCH_API","targetDomain":"EXECUTE_QUERY","type":"ENABLE","targetId":"*"}
```
</details>'
operationId: valuesPostV3
parameters:
- $ref: '#/components/parameters/OrganizationIdQuery'
- $ref: '#/components/parameters/ViewAllContentQuery'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/RestListFieldValuesParameter'
required: true
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/ListFieldValuesResponse'
security:
- oauth2:
- full
/rest/search/v3/values/batch:
post:
tags:
- Search V3
summary: Get Values for Several Field
description: 'Lists all values of the target field.
<details>
<summary>Privilege(s) required</summary>
```json
{"level":"NORMAL","owner":"SEARCH_API","targetDomain":"EXECUTE_QUERY","type":"ENABLE","targetId":"*"}
```
</details>'
operationId: valuesBatchPostV3
parameters:
- $ref: '#/components/parameters/OrganizationIdQuery'
- $ref: '#/components/parameters/ViewAllContentQuery'
- $ref: '#/components/parameters/AnalyticsRequestParameters'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/RestListFieldValuesBatchParameter'
required: true
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/ListFieldValuesBatchResponse'
security:
- oauth2:
- full
/rest/search/v3/document:
get:
tags:
- Search V3
summary: Get Item in JSON Format
operationId: documentV3
parameters:
- name: primaryId
in: query
description: The primary ID of the document.
schema:
type: string
- name: uniqueId
in: query
description: '**Deprecated:** Use `primaryId` instead.
The unique ID of the document.'
deprecated: true
schema:
type: string
- $ref: '#/components/parameters/OrganizationIdQuery'
- $ref: '#/components/parameters/Pipeline'
- $ref: '#/components/parameters/SearchHub'
- $ref: '#/components/parameters/ViewAllContentQuery'
- $ref: '#/components/parameters/Locale'
- $ref: '#/components/parameters/Timezone'
- $ref: '#/components/parameters/IndexToken'
- $ref: '#/components/parameters/Index'
- $ref: '#/components/parameters/LogicalIndex'
- $ref: '#/components/parameters/Tab'
- $ref: '#/components/parameters/Referrer'
- $ref: '#/components/parameters/Context'
responses:
'200':
description: The document matching this uniqueId.
content:
application/json:
schema:
$ref: '#/components/schemas/RestQueryResult'
'404':
$ref: '#/components/responses/NotFound'
'429':
$ref: '#/components/responses/TooManyRequests'
security:
- oauth2:
- full
description: '<details>
<summary>Privilege(s) required</summary>
```json
{"level":"NORMAL","owner":"SEARCH_API","targetDomain":"EXECUTE_QUERY","type":"ENABLE","targetId":"*"}
```
</details>'
/rest/search/v3/datastream:
get:
tags:
- Search V3
summary: Get Item Data Stream
operationId: dataStreamV3
parameters:
- name: dataStream
in: query
description: The name of the data stream to request.
required: true
schema:
type: string
- name: primaryId
in: query
description: The primary ID of the document.
schema:
type: string
- name: uniqueId
in: query
description: '**Deprecated:** Use `primaryId` instead.
The unique ID of the document.'
deprecated: true
schema:
type: string
- $ref: '#/components/parameters/OrganizationIdQuery'
- $ref: '#/components/parameters/ViewAllContentQuery'
- name: contentType
in: query
description: 'The MIME type of the data stream to request.
**Default:** `application/binary`'
schema:
type: string
- $ref: '#/components/parameters/Pipeline'
- $ref: '#/components/parameters/SearchHub'
- $ref: '#/components/parameters/Locale'
- $ref: '#/components/parameters/Timezone'
- $ref: '#/components/parameters/IndexToken'
- $ref: '#/components/parameters/Index'
- $ref: '#/components/parameters/LogicalIndex'
- $ref: '#/components/parameters/Tab'
- $ref: '#/components/parameters/Referrer'
- $ref: '#/components/parameters/Context'
responses:
'200':
description: No response
content: {}
'404':
$ref: '#/components/responses/NotFound'
'429':
$ref: '#/components/responses/TooManyRequests'
security:
- oauth2:
- full
description: '<details>
<summary>Privilege(s) required</summary>
```json
{"level":"NORMAL","owner":"SEARCH_API","targetDomain":"EXECUTE_QUERY","type":"ENABLE","targetId":"*"}
```
</details>'
/rest/search/v3/html:
post:
tags:
- Search V3
summary: Get HTML Item Preview
operationId: htmlPostV3
parameters:
- name: uniqueId
in: query
description: The uniqueId of the document. Exactly one of uniqueId or primaryId is required.
schema:
type: string
- name: primaryId
in: query
description: The primaryId of the document. Exactly one of uniqueId or primaryId is required.
schema:
type: string
- $ref: '#/components/parameters/OrganizationIdQuery'
- $ref: '#/components/parameters/ViewAllContentQuery'
- name: findNext
in: query
schema:
type: integer
format: int32
- name: findPrevious
in: query
schema:
type: integer
format: int32
- name: page
in: query
schema:
type: integer
format: int32
- name: enableNavigation
in: query
schema:
type: boolean
- name: requestedOutputSize
in: query
description: The approximate number of bytes to request in the HTML response. **Default:** `0`, meaning that the entire
HTML document is requested.
schema:
type: integer
format: int32
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/RestQueryParameters'
required: true
responses:
'200':
description: No response
content: {}
'429':
$ref: '#/components/responses/TooManyRequests'
security:
- oauth2:
- full
description: '<details>
<summary>Privilege(s) required</summary>
```json
{"level":"NORMAL","owner":"SEARCH_API","targetDomain":"EXECUTE_QUERY","type":"ENABLE","targetId":"*"}
```
</details>'
/rest/search/v3/text:
get:
tags:
- Search V3
summary: Get Item in Text Format
operationId: textV3
parameters:
- name: primaryId
in: query
description: The primary ID of the document.
schema:
type: string
- name: uniqueId
in: query
description: '**Deprecated:** Use `primaryId` instead.
The unique ID of the document.'
deprecated: true
schema:
type: string
- $ref: '#/components/parameters/OrganizationIdQuery'
- $ref: '#/components/parameters/Pipeline'
- $ref: '#/components/parameters/SearchHub'
- $ref: '#/components/parameters/ViewAllContentQuery'
- $ref: '#/components/parameters/Locale'
- $ref: '#/components/parameters/Timezone'
- $ref: '#/components/parameters/IndexToken'
- $ref: '#/components/parameters/Index'
- $ref: '#/components/parameters/LogicalIndex'
- $ref: '#/components/parameters/Tab'
- $ref: '#/components/parameters/Referrer'
- $ref: '#/components/parameters/Context'
responses:
'200':
description: No response
content: {}
'404':
$ref: '#/components/responses/NotFound'
'429':
$ref: '#/components/responses/TooManyRequests'
security:
- oauth2:
- full
description: '<details>
<summary>Privilege(s) required</summary>
```json
{"level":"NORMAL","owner":"SEARCH_API","targetDomain":"EXECUTE_QUERY","type":"ENABLE","targetId":"*"}
```
</details>'
/rest/search/v3/fields:
get:
tags:
- Search V3
summary: List All Fields
description: 'Gets all fields in the target Coveo Cloud organization.
<details>
<summary>Privilege(s) required</summary>
```json
{"level":"NORMAL","owner":"SEARCH_API","targetDomain":"EXECUTE_QUERY","type":"ENABLE","targetId":"*"}
```
</details>'
operationId: fieldsV3
parameters:
- $ref: '#/components/parameters/OrganizationIdQuery'
- $ref: '#/components/parameters/Pipeline'
- $ref: '#/components/parameters/SearchHub'
- $ref: '#/components/parameters/ViewAllContentQuery'
- $ref: '#/components/parameters/Locale'
- $ref: '#/components/parameters/Timezone'
- $ref: '#/components/parameters/IndexToken'
- $ref: '#/components/parameters/Index'
- $ref: '#/components/parameters/LogicalIndex'
- $ref: '#/components/parameters/Tab'
- $ref: '#/components/parameters/Referrer'
- $ref: '#/components/parameters/Context'
responses:
'200':
description: The list of fields available for this organization.
content:
application/json:
schema:
$ref: '#/components/schemas/ListFieldsResponse'
security:
- oauth2:
- full
/rest/search/v3/fields/find:
post:
tags:
- Search V3
summary: Find Fields from Results of a Query Expression
description: 'Find fields name from results matching the `q` expression.
<details>
<summary>Privilege(s) required</summary>
```json
{"level":"NORMAL","owner":"SEARCH_API","targetDomain":"EXECUTE_QUERY","type":"ENABLE","targetId":"*"},
{"level":"NORMAL","owner":"SEARCH_API","targetDomain":"VIEW_ALL_CONTENT","type":"ENABLE","targetId":"*"}
```
</details>'
operationId: findFieldsFromExpressionV3
parameters:
- $ref: '#/components/parameters/OrganizationIdQuery'
requestBody:
description: The query to get the fields from.
content:
application/json:
schema:
$ref: '#/components/schemas/FindFieldsRequest'
responses:
'200':
description: The list of fields referenced by the requested expression.
content:
application/json:
schema:
$ref: '#/components/schemas/FindFieldsResponse'
security:
- oauth2:
- full
/rest/search/v3/token:
post:
tags:
- Search V3
summary: Create Search Token
description: 'Creates a temporary [JSON web token](https://jwt.io/) which can be used to impersonate one or several
security identities when authenticating a query (see [Search Token Authentication](https://docs.coveo.com/en/56/)).
<details>
<summary>Privilege(s) required</summary>
```json
{"level":"NORMAL","owner":"SEARCH_API","targetDomain":"IMPERSONATE_SEARCH_API","type":"ENABLE","targetId":"*"}
```
</details>'
operationId: tokenV3
parameters:
- $ref: '#/components/parameters/OrganizationIdQuery'
requestBody:
description: The search token information.
content:
application/json:
schema:
$ref: '#/components/schemas/RestTokenParams'
required: true
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/RestTokenResponse'
security:
- oauth2:
- full
/rest/search/v3/login/{provider}:
post:
tags:
- Search V3
summary: Log in to Authentication Provider
description: 'Directs the browser to URI of the target Search API authentication provider, and back to the origin search
page once the authentication process is complete. This authentication provider must be properly configured in the
Coveo Cloud organization.
<details>
<summary>Privilege(s) required</summary>
```json
```
</details>'
operationId: loginProviderPostV3
parameters:
- name: provider
in: path
description: The name of the Search API authentication provider to log in to.
example: My SharePoint Server
required: true
schema:
type: string
- $ref: '#/components/parameters/OrganizationIdQuery'
responses:
'200':
description: No response
content: {}
security:
- oauth2:
- full
/rest/search/v3/passages/retrieve:
post:
tags:
- Passages V3
summary: Retrieves the Passage(s) for a Particular Query.
operationId: retrievePassageV3
parameters:
- $ref: '#/components/parameters/OrganizationIdQuery'
security:
- oauth2:
- full
- apiKey: []
- platformTokens: []
- searchTokens: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/RetrievePassagesRequestV3'
responses:
'200':
description: OK
headers:
X-Request-Id:
description: A unique identifier for the request.
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/RetrievePassagesResponseV3'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'422':
$ref: '#/components/responses/PassageRetrievalUnprocessableEntity'
'429':
$ref: '#/components/responses/TooManyRequests'
'500':
$ref: '#/components/responses/InternalServerError'
'503':
$ref: '#/components/responses/PassageRetrievalServerUnavailable'
description: '<details>
<summary>Privilege(s) required</summary>
```json
{"level":"NORMAL","owner":"SEARCH_API","targetDomain":"EXECUTE_QUERY","type":"ENABLE","targetId":"*"}
```
</details>'
/rest/search/v3/analysis/expressions/structured:
post:
tags:
- Analysis V3
summary: Convert Query to Structured Expression
description: 'Parses a query expression written using the Coveo query syntax, and converts it into a structured expression.
to a structured expression.
<details>
<summary>Privilege(s) required</summary>
```json
{"level":"NORMAL","owner":"SEARCH_API","targetDomain":"EXPRESSION_VALIDATION_RESULT","type":"VIEW","targetId":"*"}
```
</details>'
operationId: parseExpressionToStructured
parameters:
- $ref: '#/components/parameters/OrganizationIdQuery'
requestBody:
description: The query expression to parse and convert
content:
application/json:
schema:
$ref: '#/components/schemas/ParseQueryExpressionToStructuredRequest'
required: true
responses:
'200':
description: Created
content:
application/json:
schema:
$ref: '#/components/schemas/ParseQueryExpressionToStructuredResponse'
example:
structured:
type: and
expressions:
- type: fieldExpression
fieldName: altpopulation
operator: greaterThanOrEqual
value:
type: unknown
value: '90000'
- type: fieldExists
fieldName: altcapital
- type: not
expression:
type: or
expressions:
- type: fieldExpression
fieldName: source
operator: isExactly
value:
type: string
value: Youtube
- type: fieldExpression
fieldName: author
operator: isExactly
value:
type: string
value: JohnSmith
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'419':
$ref: '#/components/responses/AuthenticationTimeout'
'422':
description: Unprocessable Entity
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetailResponse'
example:
status: 422
title: Invalid query expression
detail: Coveo wasn't able to parse your query. Make sure it follows the Coveo query syntax.
security:
- oauth2:
- full
/rest/search/v3/analysis/inspect/replay:
post:
tags:
- Analysis V3
summary: Replay a Query with Inspection Details
description: 'Replay a query that was already done and get inspection details.
**Note:** This API call can only be used with an OAuth token. API Keys and Search Token aren''t allowed.
<details>
<summary>Privilege(s) required</summary>
```json
{"level":"NORMAL","owner":"SEARCH_API","targetDomain":"EXECUTE_QUERY","type":"ENABLE","targetId":"*"},
{"level":"NORMAL","owner":"SEARCH_API","targetDomain":"REPLAY_ANY_QUERY","type":"VIEW","targetId":"*"}
```
</details>'
operationId: replay
parameters:
- $ref: '#/components/parameters/OrganizationIdQuery'
requestBody:
description: Inspection parameters
content:
application/json:
schema:
$ref: '#/components/schemas/InspectReplayRequest'
required: true
responses:
'200':
description: OK
content:
application/application+json:
schema:
$ref: '#/components/schemas/InspectReplayResponse'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/OriginalRequestNotFound'
'419':
$ref: '#/components/responses/AuthenticationTimeout'
'422':
$ref: '#/components/responses/UnsupportedRegion'
'429':
$ref: '#/components/responses/TooManyRequests'
'503':
$ref: '#/components/responses/ReplaySearchTooBroad'
security:
- oauth2:
- full
/rest/search/v2:
get:
tags:
- Search V2
summary: Send Search Request
description: 'See [Performing a Query](https://docs.coveo.com/en/1445/).
<details>
<summary>Privilege(s) required</summary>
```json
{"level":"NORMAL","owner":"SEARCH_API","targetDomain":"EXECUTE_QUERY","type":"ENABLE","targetId":"*"}
```
</details>'
operationId: searchUsingGet
parameters:
- $ref: '#/components/parameters/Q'
- $ref: '#/components/parameters/AQ'
- $ref: '#/components/parameters/CQ'
- $ref: '#/components/parameters/DQ'
- $ref: '#/components/parameters/LQ'
- $ref: '#/components/parameters/EnableDidYouMean'
- $ref: '#/components/parameters/MlDidYouMeanMaxCandidates'
- $ref: '#/components/parameters/MlDidYouMeanMinScore'
- $ref: '#/components/parameters/MlDidYouMeanUseFacetCount'
- $ref: '#/components/parameters/EnableMlDidYouMean'
- $ref: '#/components/parameters/PartialMatch'
- $ref: '#/components/parameters/PartialMatchKeywords'
- $ref: '#/components/parameters/PartialMatchThreshold'
- $ref: '#/components/parameters/LqPartialMatchMaxKeywords'
- $ref: '#/components/parameters/LqPartialMatchKeywords'
- $ref: '#/components/parameters/LqPartialMatchThreshold'
- $ref: '#/components/parameters/Wildcards'
- $ref: '#/components/parameters/QuestionMark'
- $ref: '#/components/parameters/EnableQuerySyntax'
- $ref: '#/components/parameters/LowerCaseOperators'
- $ref: '#/components/parameters/ExcerptLength'
- $ref: '#/components/parameters/RetrieveFirstSentences'
- $ref: '#/components/parameters/FieldsToInclude'
- $ref: '#/components/parameters/FieldsToExclude'
- $ref: '#/components/parameters/GroupBy'
- $ref: '#/components/parameters/Facets'
- $ref: '#/components/parameters/FacetOptions'
- $ref: '#/components/parameters/CategoryFacets'
- $ref: '#/components/parameters/SortCriteria'
- $ref: '#/components/parameters/RankingFunctions'
- $ref: '#/components/parameters/QueryFunctions'
- $ref: '#/components/parameters/FirstResult'
- $ref: '#/components/parameters/NumberOfResults'
- $ref: '#/components/parameters/EnableDuplicateFiltering'
- $ref: '#/components/parameters/FilterField'
- $ref: '#/components/parameters/ParentField'
- $ref: '#/components/parameters/ChildField'
- $ref: '#/components/parameters/FilterFieldRange'
- $ref: '#/components/parameters/SummaryLength'
- $ref: '#/components/parameters/SortField'
- $ref: '#/components/parameters/DisableQuerySyntax'
- $ref: '#/components/parameters/StaticQuery'
- $ref: '#/components/parameters/UserActionParameter'
- $ref: '#/components/parameters/CommerceParameters'
- $ref: '#/components/parameters/DictionaryFieldContext'
- $ref: '#/components/parameters/Pipeline'
- $ref: '#/components/parameters/MaximumAge'
- $ref: '#/components/parameters/SearchHub'
- $ref: '#/components/parameters/Tab'
- $ref: '#/components/parameters/Referrer'
- $ref: '#/components/parameters/Context'
- $ref: '#/components/parameters/ActionsHistory'
- $ref: '#/components/parameters/Recommendation'
- $ref: '#/components/parameters/Locale'
- $ref: '#/components/parameters/Timezone'
- $ref: '#/components/parameters/Format'
- $ref: '#/components/parameters/Debug'
- $ref: '#/components/parameters/IndexToken'
- $ref: '#/components/parameters/VisitorId'
- $ref: '#/components/parameters/IsGuestUser'
- $ref: '#/components/parameters/Language'
- $ref: '#/components/parameters/MlParameters'
- $ref: '#/components/parameters/IndexType'
- $ref: '#/components/parameters/Index'
- $ref: '#/components/parameters/LogicalIndex'
- $ref: '#/components/parameters/MaximumTimeoutMs'
- $ref: '#/components/parameters/AnalyticsRequestParameters'
- $ref: '#/components/parameters/OrganizationIdQuery'
- $ref: '#/components/parameters/ViewAllContentQuery'
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/RestQueryResponse'
application/xml:
schema:
$ref: '#/components/schemas/RestQueryResponse'
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet:
schema:
$ref: '#/components/schemas/RestQueryResponse'
security:
- oauth2:
- full
post:
tags:
- Search V2
summary: Send Search Request
description: 'See [Performing a Query](https://docs.coveo.com/en/1445/).
<details>
<summary>Privilege(s) required</summary>
```json
{"level":"NORMAL","owner":"SEARCH_API","targetDomain":"EXECUTE_QUERY","type":"ENABLE","targetId":"*"}
```
</details>'
operationId: searchUsingPost
parameters:
- $ref: '#/components/parameters/OrganizationIdQuery'
- $ref: '#/components/parameters/ViewAllContentQuery'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/RestQueryParameters'
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/RestQueryResponse'
application/xml:
schema:
$ref: '#/components/schemas/RestQueryResponse'
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet:
schema:
$ref: '#/components/schemas/RestQueryResponse'
security:
- oauth2:
- full
/rest/search/v2/plan:
get:
tags:
- Search V2
summary: Plan Search Execution
description: 'See [Performing a Query](https://docs.coveo.com/en/1445/).
<details>
<summary>Privilege(s) required</summary>
```json
{"level":"NORMAL","owner":"SEARCH_API","targetDomain":"EXECUTE_QUERY","type":"ENABLE","targetId":"*"}
```
</details>'
operationId: planSearchUsingGet
parameters:
- $ref: '#/components/parameters/Q'
- $ref: '#/components/parameters/AQ'
- $ref: '#/components/parameters/CQ'
- $ref: '#/components/parameters/DQ'
- $ref: '#/components/parameters/LQ'
- $ref: '#/components/parameters/EnableDidYouMean'
- $ref: '#/components/parameters/MlDidYouMeanMaxCandidates'
- $ref: '#/components/parameters/MlDidYouMeanMinScore'
- $ref: '#/components/parameters/MlDidYouMeanUseFacetCount'
- $ref: '#/components/parameters/EnableMlDidYouMean'
- $ref: '#/components/parameters/PartialMatch'
- $ref: '#/components/parameters/PartialMatchKeywords'
-
# --- truncated at 32 KB (658 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/coveo/refs/heads/main/openapi/coveo-search-openapi-original.yml