Coveo Customer Service API Service
Documentation for Coveo Customer Service API Service
OpenAPI Specification
openapi: 3.0.1
info:
title: Coveo Customer Service API Service
description: Documentation for Coveo Customer Service API Service
termsOfService: http://www.coveo.com/en/support/terms-agreements
contact:
name: support@coveo.com
version: 1.0.0
servers:
- url: https://platform.cloud.coveo.com
description: Coveo public API endpoint
tags:
- name: Answer
x-displayName: Answer
- name: Case Assist
x-displayName: Case Assist
- name: Insight Panel
x-displayName: Insight Panel
- name: CRGA For Cases
x-displayName: CRGA For Cases
paths:
/rest/organizations/{organizationId}/answer/cases/v1/configs/{configId}:
post:
tags:
- CRGA For Cases
summary: Create CRGA for Cases Configuration
description: Add a CRGA For Cases configuration to the answer configuration
operationId: createLfcaConfiguration
parameters:
- $ref: '#/components/parameters/OrganizationIdPath'
- $ref: '#/components/parameters/ConfigIdPath'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/LfcaConfiguration'
responses:
'201':
description: Created
content:
application/json:
schema:
$ref: '#/components/schemas/LfcaConfiguration'
security:
- oauth2:
- full
get:
tags:
- CRGA For Cases
summary: Get CRGA for Cases Configuration
description: Get the CRGA For Cases configuration associated to the answer configuration.
operationId: getLfcaConfiguration
parameters:
- $ref: '#/components/parameters/OrganizationIdPath'
- $ref: '#/components/parameters/ConfigIdPath'
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/LfcaConfiguration'
security:
- oauth2:
- full
patch:
tags:
- CRGA For Cases
summary: Update CRGA for Cases Configuration Attributes
description: Update attributes of the CRGA For Cases configuration.
operationId: patchLfcaConfiguration
parameters:
- $ref: '#/components/parameters/OrganizationIdPath'
- $ref: '#/components/parameters/ConfigIdPath'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/LfcaConfigurationPatchRequest'
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/LfcaConfiguration'
security:
- oauth2:
- full
delete:
tags:
- CRGA For Cases
summary: Delete CRGA for Cases Configuration
description: Delete the CRGA For Cases configuration associated to the answer configuration.
operationId: deleteLfcaConfiguration
parameters:
- $ref: '#/components/parameters/OrganizationIdPath'
- $ref: '#/components/parameters/ConfigIdPath'
responses:
'204':
description: No content
security:
- oauth2:
- full
/rest/organizations/{organizationId}/answer/v1/configs/{configId}/generate:
post:
tags:
- Answer
summary: Get Answer
description: Get an answer for a question
operationId: getAnswer
parameters:
- $ref: '#/components/parameters/OrganizationIdPath'
- $ref: '#/components/parameters/ConfigIdPath'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/AnswerSearchRequest'
responses:
'200':
description: OK
content:
text/event-stream:
schema:
$ref: '#/components/schemas/GenQAResponse'
examples:
HeaderMessage:
$ref: '#/components/examples/HeaderMessage'
AnswerMessage:
$ref: '#/components/examples/AnswerMessage'
CitationsMessage:
$ref: '#/components/examples/CitationsMessage'
EndOfStreamMessage:
$ref: '#/components/examples/EndOfStreamMessage'
security:
- oauth2:
- full
/rest/organizations/{organizationId}/caseassists/{caseAssistId}:
get:
tags:
- Case Assist
summary: Show Case Assist Configuration
description: Shows a case assist configuration in a [Coveo Cloud organization](https://docs.coveo.com/en/185/).<br /><br
/><b>Required privilege:</b> Customer Service - Case assist configuration - View
operationId: getCaseAssistConfiguration
parameters:
- name: organizationId
in: path
description: The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br /><b>Example:</b>
`mycoveocloudv2organizationg8tp8wu3`
required: true
schema:
type: string
- name: caseAssistId
in: path
description: The unique identifier of the target case assist configuration.<br /><b>Example:</b> `812efd5e-a7e3-49d5-8f1d-81be8e739b70`
required: true
schema:
type: string
responses:
'200':
description: OK
content:
'*/*':
schema:
$ref: '#/components/schemas/RestCaseAssistConfigurationResponse'
deprecated: false
security:
- oauth2:
- full
put:
tags:
- Case Assist
summary: Update Case Assist Configuration
description: Updates a case assist configuration in a [Coveo Cloud organization](https://docs.coveo.com/en/185/).<br
/><br /><b>Required privilege:</b> Customer Service - Case assist configuration - Edit
operationId: updateCaseAssistConfiguration
parameters:
- name: organizationId
in: path
description: The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br /><b>Example:</b>
`mycoveocloudv2organizationg8tp8wu3`
required: true
schema:
type: string
- name: caseAssistId
in: path
description: The unique identifier of the target case assist configuration.<br /><b>Example:</b> `812efd5e-a7e3-49d5-8f1d-81be8e739b70`
required: true
schema:
type: string
requestBody:
content:
'*/*':
schema:
$ref: '#/components/schemas/RestCaseAssistConfigurationRequest'
required: true
responses:
'204':
description: No Content
content: {}
deprecated: false
security:
- oauth2:
- full
x-codegen-request-body-name: body
delete:
tags:
- Case Assist
summary: Delete Case Assist Configuration
description: Deletes a case assist configuration in a [Coveo Cloud organization](https://docs.coveo.com/en/185/).<br
/><br /><b>Required privilege:</b> Customer Service - Case assist configuration - Edit
operationId: deleteCaseAssistConfiguration
parameters:
- name: organizationId
in: path
description: The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br /><b>Example:</b>
`mycoveocloudv2organizationg8tp8wu3`
required: true
schema:
type: string
- name: caseAssistId
in: path
description: The unique identifier of the target case assist configuration.<br /><b>Example:</b> `812efd5e-a7e3-49d5-8f1d-81be8e739b70`
required: true
schema:
type: string
responses:
'204':
description: No Content
content: {}
deprecated: false
security:
- oauth2:
- full
/rest/organizations/{organizationId}/caseassists/{caseAssistId}/classify:
post:
tags:
- Case Assist
summary: Request Classifications
description: Requests field value suggestions for a case.<br /><br /><b>Required privilege:</b> Customer Service - Use
case assist - Allowed<br/>
operationId: postClassify
parameters:
- name: organizationId
in: path
description: The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br /><b>Example:</b>
`mycoveocloudv2organizationg8tp8wu3`
required: true
schema:
type: string
- name: caseAssistId
in: path
description: The unique identifier of the target case assist configuration.<br /><b>Example:</b> `812efd5e-a7e3-49d5-8f1d-81be8e739b70`
required: true
schema:
type: string
- name: debug
in: query
description: Whether to include an execution report for debugging purposes.
schema:
type: boolean
default: false
requestBody:
content:
'*/*':
schema:
$ref: '#/components/schemas/RestCaseAssistContext'
required: true
responses:
'200':
description: OK
content:
'*/*':
schema:
$ref: '#/components/schemas/RestClassification'
deprecated: false
security:
- oauth2:
- full
x-codegen-request-body-name: body
/rest/organizations/{organizationId}/caseassists/preview/classify:
post:
tags:
- Case Assist
summary: Request Classifications Preview
description: Requests field value suggestions preview for a case and configuration.<br /><br /><b>Required privilege:</b><ul><li>Customer
Service - Use case assist - Allowed</li><li>Customer Service - Case assist configuration - Edit</li><li>Search - All
Content - View</li></ul>
operationId: postClassifyPreview
parameters:
- name: organizationId
in: path
description: The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br /><b>Example:</b>
`mycoveocloudv2organizationg8tp8wu3`
required: true
schema:
type: string
- name: debug
in: query
description: Whether to include an execution report for debugging purposes.
schema:
type: boolean
default: false
requestBody:
content:
'*/*':
schema:
$ref: '#/components/schemas/PreviewClassificationRequest'
required: true
responses:
'200':
description: OK
content:
'*/*':
schema:
$ref: '#/components/schemas/RestClassification'
deprecated: false
security:
- oauth2:
- full
x-codegen-request-body-name: body
/rest/organizations/{organizationId}/caseassists/{caseAssistId}/documents/suggest:
post:
tags:
- Case Assist
summary: Request Document Suggestions
description: Requests document suggestions for a case.<br /><br /><b>Required privilege:</b> Customer Service - Use
case assist - Allowed
operationId: getSuggestDocument
parameters:
- name: organizationId
in: path
description: The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br /><b>Example:</b>
`mycoveocloudv2organizationg8tp8wu3`
required: true
schema:
type: string
- name: caseAssistId
in: path
description: The unique identifier of the target case assist configuration.<br /><b>Example:</b> `812efd5e-a7e3-49d5-8f1d-81be8e739b70`
required: true
schema:
type: string
- name: debug
in: query
description: Whether to include an execution report for debugging purposes.
schema:
type: boolean
default: false
- name: numberOfResults
in: query
description: The maximum number of results to return.<br />**Must be in range:** `[1, 100]`
schema:
type: integer
format: int32
default: 5
requestBody:
content:
'*/*':
schema:
$ref: '#/components/schemas/RestCaseAssistContext'
required: true
responses:
'200':
description: OK
content:
'*/*':
schema:
$ref: '#/components/schemas/RestDocumentSuggestions'
deprecated: false
security:
- oauth2:
- full
x-codegen-request-body-name: body
/rest/organizations/{organizationId}/caseassists/preview/documents/suggest:
post:
tags:
- Case Assist
summary: Request Document Suggestions Preview
description: Requests document suggestions preview for a case and configuration.<br /><br /><b>Required privilege:</b><ul><li>Customer
Service - Use case assist - Allowed</li><li>Customer Service - Case assist configuration - Edit</li></ul>
operationId: getSuggestDocumentPreview
parameters:
- name: organizationId
in: path
description: The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br /><b>Example:</b>
`mycoveocloudv2organizationg8tp8wu3`
required: true
schema:
type: string
- name: debug
in: query
description: Whether to include an execution report for debugging purposes.
schema:
type: boolean
default: false
- name: numberOfResults
in: query
description: The maximum number of results to return.<br />**Must be in range:** `[1, 100]`
schema:
type: integer
format: int32
default: 5
requestBody:
content:
'*/*':
schema:
$ref: '#/components/schemas/PreviewDocumentSuggestionRequest'
required: true
responses:
'200':
description: OK
content:
'*/*':
schema:
$ref: '#/components/schemas/RestDocumentSuggestions'
deprecated: false
security:
- oauth2:
- full
x-codegen-request-body-name: body
/rest/organizations/{organizationId}/caseassists:
get:
tags:
- Case Assist
summary: List Case Assist Configurations
description: Lists all case assist configurations in a [Coveo Cloud organization](https://docs.coveo.com/en/185/).<br
/><br /><b>Required privilege:</b> Customer Service - Case assist configuration - View
operationId: getAllCaseAssistConfigurations
parameters:
- name: organizationId
in: path
description: The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br /><b>Example:</b>
`mycoveocloudv2organizationg8tp8wu3`
required: true
schema:
type: string
- name: page
in: query
description: The 0-based number of the page of configurations to list.<br /><b>Default:</b> `0`
schema:
type: integer
format: int32
- name: perPage
in: query
description: The maximum number of configurations to include per page.<br /><b>Default:</b> `100`
schema:
type: integer
format: int32
responses:
'200':
description: OK
content:
'*/*':
schema:
$ref: '#/components/schemas/RestListOfCaseAssistConfigurations'
deprecated: false
security:
- oauth2:
- full
post:
tags:
- Case Assist
summary: Create Case Assist Configuration
description: Creates a case assist configuration in a [Coveo Cloud organization](https://docs.coveo.com/en/185/).<br/><br/><b>Required
privilege:</b><ul><li>Customer Service - Case assist configuration - Edit</li><li>Search - All Content - View</li></ul>
operationId: createCaseAssistConfiguration
parameters:
- name: organizationId
in: path
description: The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br /><b>Example:</b>
`mycoveocloudv2organizationg8tp8wu3`
required: true
schema:
type: string
requestBody:
content:
'*/*':
schema:
$ref: '#/components/schemas/RestCaseAssistConfigurationRequest'
required: true
responses:
'200':
description: OK
content:
'*/*':
schema:
$ref: '#/components/schemas/RestCaseAssistConfigurationResponse'
deprecated: false
security:
- oauth2:
- full
x-codegen-request-body-name: body
/rest/organizations/{organizationId}/caseassists/projects/get:
get:
tags:
- Case Assist
summary: Get Case Assist Configurations by Project
description: Retrieves case assist configurations associated with a specific project in a [Coveo Cloud organization](https://docs.coveo.com/en/185/).<br
/><br /><b>Required privilege:</b> Customer Service - Case assist configuration - View
operationId: getCaseAssistConfigurationsByProject
parameters:
- name: organizationId
in: path
description: The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br /><b>Example:</b>
`mycoveocloudv2organizationg8tp8wu3`
required: true
schema:
type: string
- name: projectId
in: query
description: The unique identifier of the project for which to retrieve case assist configurations.
required: true
schema:
type: string
- name: page
in: query
description: The 0-based number of the page of configurations to list.<br /><b>Default:</b> `0`
schema:
type: integer
format: int32
- name: perPage
in: query
description: The maximum number of configurations to include per page.<br /><b>Default:</b> `100`
schema:
type: integer
format: int32
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/RestListOfCaseAssistConfigurationsWithProjects'
deprecated: false
security:
- oauth2:
- full
/rest/organizations/{organizationId}/insightconfig/v1/configs:
get:
tags:
- Insight Panel
summary: List Insight Panel Configurations
description: Gets a list of Insight Panel configurations.
operationId: insight-panel-configuration-list
parameters:
- name: organizationId
in: path
description: The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br /><b>Example:</b>
`mycoveocloudv2organizationg8tp8wu3`
required: true
schema:
type: string
- name: page
in: query
description: The 0-based number of the page of configurations to list.
schema:
type: integer
format: Int32
default: 0
- name: perPage
in: query
description: The number of configurations to list per page. Must be equal to or greater than <code>1</code>.
schema:
type: integer
format: Int32
default: 10
- name: filter
in: query
description: A filter that only retrieves matching Insight Panel configurations.
schema:
type: string
- name: order
in: query
description: 'The order in which the configurations are listed. The available values are: <ul> <li><i>empty</i>: items
are not sorted in any specific order.</li> <li><code>asc</code>: items are sorted in ascending order.</li> <li><code>desc</code>:
items are sorted in descending order.</li> </ul>'
schema:
type: string
responses:
'200':
description: OK
content:
'*/*':
schema:
type: object
properties:
items:
type: array
description: List of Insight Panel configurations
items:
$ref: '#/components/schemas/RestInsightPanelConfiguration'
totalEntries:
type: integer
description: The total number of items that match the <code>filter</code> parameter.
totalPages:
type: integer
description: The total number of item pages according to the <code>perPage</code> parameter.
deprecated: false
security:
- oauth2:
- full
post:
tags:
- Insight Panel
summary: Create an Insight Panel Configuration
description: Creates a new Insight Panel configuration.
operationId: insight-panel-configuration-create
parameters:
- name: organizationId
in: path
description: The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br /><b>Example:</b>
`mycoveocloudv2organizationg8tp8wu3`
required: true
schema:
type: string
requestBody:
content:
'*/*':
schema:
$ref: '#/components/schemas/RestInsightPanelConfigurationCreate'
required: true
responses:
'201':
description: Created
content:
'*/*':
schema:
$ref: '#/components/schemas/RestInsightPanelConfiguration'
deprecated: false
security:
- oauth2:
- full
x-codegen-request-body-name: body
/rest/organizations/{organizationId}/insightconfig/v1/configs/ids:
post:
tags:
- Insight Panel
summary: List Insight Panel Configurations by Ids.
description: Gets a list of Insight Panel configurations by ids.
operationId: insight-panel-configuration-list-ids
parameters:
- name: organizationId
in: path
description: The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br /><b>Example:</b>
`mycoveocloudv2organizationg8tp8wu3`
required: true
schema:
type: string
- name: page
in: query
description: The 0-based number of the page of configurations to list.
schema:
type: integer
format: Int32
default: 0
- name: perPage
in: query
description: The number of configurations to list per page. Must be equal to or greater than <code>1</code>.
schema:
type: integer
format: Int32
default: 10
- name: filter
in: query
description: A filter that only retrieves matching Insight Panel configurations.
schema:
type: string
- name: order
in: query
description: 'The order in which the configurations are listed. The available values are: <ul> <li><i>empty</i>: items
are not sorted in any specific order.</li> <li><code>asc</code>: items are sorted in ascending order.</li> <li><code>desc</code>:
items are sorted in descending order.</li> </ul>'
schema:
type: string
requestBody:
content:
'*/*':
schema:
$ref: '#/components/schemas/RestInsightPanelConfigurationListIds'
required: true
responses:
'200':
description: OK
content:
'*/*':
schema:
type: object
properties:
items:
type: array
description: List of Insight Panel configurations
items:
$ref: '#/components/schemas/RestInsightPanelConfiguration'
totalEntries:
type: integer
description: The total number of items that match the <code>filter</code> parameter.
totalPages:
type: integer
description: The total number of item pages according to the <code>perPage</code> parameter.
deprecated: false
security:
- oauth2:
- full
x-codegen-request-body-name: body
/rest/organizations/{organizationId}/insightconfig/v1/configs/{configId}:
get:
tags:
- Insight Panel
summary: Get an Insight Panel Configuration
description: Gets a single Insight Panel configuration.
operationId: insight-panel-configuration-get
parameters:
- name: organizationId
in: path
description: The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br /><b>Example:</b>
`mycoveocloudv2organizationg8tp8wu3`
required: true
schema:
type: string
- name: configId
in: path
description: The unique identifier of the target Insight Panel configuration.
required: true
schema:
type: string
responses:
'200':
description: OK
content:
'*/*':
schema:
$ref: '#/components/schemas/RestInsightPanelConfiguration'
'404':
description: When the specified Insight Panel configuration does not exist.
content: {}
deprecated: false
security:
- oauth2:
- full
put:
tags:
- Insight Panel
summary: Update an Insight Panel Configuration
description: Updates an existing Insight Panel configuration.
operationId: insight-panel-configuration-update
parameters:
- name: organizationId
in: path
description: The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br /><b>Example:</b>
`mycoveocloudv2organizationg8tp8wu3`
required: true
schema:
type: string
- name: configId
in: path
description: The unique identifier of the target Insight Panel configuration.
required: true
schema:
type: string
requestBody:
content:
'*/*':
schema:
$ref: '#/components/schemas/RestInsightPanelConfigurationUpdate'
required: false
responses:
'200':
content:
'*/*':
schema:
$ref: '#/components/schemas/RestInsightPanelConfiguration'
'404':
description: When the specified Insight Panel configuration does not exist.
content: {}
deprecated: false
security:
- oauth2:
- full
x-codegen-request-body-name: body
delete:
tags:
- Insight Panel
summary: Delete an Insight Panel Configuration
description: Deletes an existing Insight Panel configuration.
operationId: insight-panel-configuration-delete
parameters:
- name: organizationId
in: path
description: The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br /><b>Example:</b>
`mycoveocloudv2organizationg8tp8wu3`
required: true
schema:
type: string
- name: configId
in: path
description: The unique identifier of the target Insight Panel configuration.
required: true
schema:
type: string
responses:
'204':
description: No Content
content: {}
'404':
description: When the specified Insight Panel configuration does not exist.
content: {}
deprecated: false
security:
- oauth2:
- full
/rest/organizations/{organizationId}/insight/v1/configs/{configId}/interface:
get:
tags:
- Insight Panel
summary: Get an Insight Panel Interface
description: Gets a specific Insight Panel interface.
operationId: insight-panel-interface-get
parameters:
- name: organizationId
in: path
description: The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br /><b>Example:</b>
`mycoveocloudv2organizationg8tp8wu3`
required: true
schema:
type: string
- name: configId
in: path
description: The unique identifier of the target Insight Panel configuration.
required: true
schema:
type: string
responses:
'200':
content:
'*/*':
schema:
type: object
properties:
contextFields:
type: object
properties: {}
example:
subject: case_subject
description: case_description
searchHub:
type: string
interface:
$ref: '#/components/schemas/RestInsightPanelInterface'
deprecated: false
security:
- oauth2:
- full
/rest/organizations/{organizationId}/insight/v1/configs/{configId}/search:
post:
tags:
- Insight Panel
summary: Search for Items
description: Searches for items using a specific Insight Panel configuration.
operationId: insight-panel-search
parameters:
- name: organizationId
in: path
description: The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br /><b>Example:</b>
`mycoveocloudv2organizationg8tp8wu3`
required: true
schema:
type: string
- name: configId
in: path
description: The unique identifier of the Insight Panel configuration.
required: true
schema:
type: string
requestBody:
content:
'*/*':
schema:
$ref: '#/components/schemas/RestInsightPanelSearchRequest'
required: false
responses:
'200':
content:
'*/*':
schema:
$ref: '#/components/schemas/RestInsightPanelSearchResponse'
deprecated: false
security:
- oauth2:
- full
x-codegen-request-body-name: body
/rest/organizations/{organizationId}/insight/v1/configs/{configId}/querysuggest:
post:
tags:
- Insight Panel
summary: Retrieve Query Suggestions
description: Retrieves query suggestions using a specific Insight Panel configuration.
operationId: insight-panel-query-suggest
parameters:
- name: organizationId
in: path
description: The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br /><b>Example:</b>
`mycoveocloudv2organizationg8tp8wu3`
required: true
schema:
type: string
- name: configId
in: path
description: The unique identifier of the Insight Panel configuration.
required: true
schema:
type: string
requestBody:
content:
'*/*':
schema:
$ref: '#/components/schemas/RestInsightPanelQuerySuggestRequest'
required: false
responses:
'200':
description: OK
content:
'*/*':
schema:
$ref: '#/components/schemas/RestInsightPanelQuerySuggestResponse'
deprecated: false
security:
- oauth2:
- full
x-codegen-request-body-name: body
/rest/organizations/{organizationId}/insight/v1/configs/{configId}/quickview:
get:
tags:
- Insight Panel
summary: Retrieve Item Quickview
description: Retrieves an item Quickview using a specific Insight Panel configuration.
operationId: insight-panel-quickview
parameters:
- name: organizationId
in: path
description: The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br /><b>Example:</b>
`mycoveocloudv2organizationg8tp8wu3`
required: true
schema:
type: string
- name: configId
in: path
description: The unique identifier of the target Insight Panel configuration.
required: true
schema:
type: strin
# --- truncated at 32 KB (139 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/coveo/refs/heads/main/openapi/coveo-customer-service-openapi-original.yml