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 Case Assist API

The Case Assist API from Coveo — 7 operation(s) for case assist.

Documentation Provider Profile APIs.io OpenAPI GitHub

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

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

10 operations 7 paths 21 schemas 1 DELETE3 GET5 POST1 PUT

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
support@coveo.com
Terms of Service
View terms
Resource Areas
1

Authentication & Security 1

Coveo Case Assist API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (oauth2) using the implicit flow, exposing 1 scope.

  • oauth2 — OAuth2

Paths & Operations 10

Across 7 paths, the API surfaces 10 operations — 1 DELETE, 3 GET, 5 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Case Assist 10
GET
/rest/organizations/{organizationId}/caseassists/{caseAssistId}
Show Case Assist Configuration
getCaseAssistConfiguration 2 params → 200
PUT
/rest/organizations/{organizationId}/caseassists/{caseAssistId}
Update Case Assist Configuration
updateCaseAssistConfiguration 2 params body → 204
DELETE
/rest/organizations/{organizationId}/caseassists/{caseAssistId}
Delete Case Assist Configuration
deleteCaseAssistConfiguration 2 params → 204
POST
/rest/organizations/{organizationId}/caseassists/{caseAssistId}/classify
Request Classifications
postClassify 3 params body → 200
POST
/rest/organizations/{organizationId}/caseassists/preview/classify
Request Classifications Preview
postClassifyPreview 2 params body → 200
POST
/rest/organizations/{organizationId}/caseassists/{caseAssistId}/documents/suggest
Request Document Suggestions
getSuggestDocument 4 params body → 200
POST
/rest/organizations/{organizationId}/caseassists/preview/documents/suggest
Request Document Suggestions Preview
getSuggestDocumentPreview 3 params body → 200
GET
/rest/organizations/{organizationId}/caseassists
List Case Assist Configurations
getAllCaseAssistConfigurations 3 params → 200
POST
/rest/organizations/{organizationId}/caseassists
Create Case Assist Configuration
createCaseAssistConfiguration 1 param body → 200
GET
/rest/organizations/{organizationId}/caseassists/projects/get
Get Case Assist Configurations by Project
getCaseAssistConfigurationsByProject 4 params → 200

Schemas 21

The contract defines 21 schemas that model the data the API accepts and returns. The most detailed are Analytics (16 properties), RestCaseAssistContext (6 properties), RestCaseAssistConfigurationResponse (4 properties), RestCaseAssistConfigurationRequest (3 properties). Each schema is shown below with its type and property counts.

RestListOfCaseAssistConfigurationsWithProjects
object
3 properties 1 required
RestCaseAssistConfigurationWithProject
PreviewDocumentSuggestionRequest
object
2 properties 2 required
RestCaseAssistConfigurationResponse
object
A case assist configuration.
4 properties 3 required
visitorId
string
A GUID which represents the current user, who can either be authenticated or anonymous. visitorId is deprecated and has been replaced by clientId in newer vers…
Fields
object
A dictionary where each key is the name of a field that pertains to the target case, and each value is an object that describes the content of that field. Exam…
RestClassificationConfiguration
object
A document classification configuration.
3 properties 3 required
DocumentSuggestionConfiguration
object
A mock case assist configuration to test a document suggestions configuration.
2 properties 1 required
locale
string
The locale of the current user. Must comply with IETF's BCP 47 definition. Coveo Machine Learning models use this information to provide contextually relevant…
RestCaseAssistConfigurationWithProjectResponse
Analytics
objectnull
16 properties
RestListOfCaseAssistConfigurations
object
3 properties 1 required
RestDocumentSuggestions
object
3 properties 3 required
RestDocumentSuggestionConfiguration
object
A document suggestions configuration.
3 properties 3 required
PreviewClassificationRequest
object
2 properties 2 required
ContextAttributes
object
A dictionary where each key is the name of a context attribute that pertains to the target case, and each value is a string that describes the content of that…
RestCaseAssistContext
object
6 properties
clientId
string
The clientId identifies a user on a browser of a Coveo-powered search page and provides insight into the events they performed
RestCaseAssistConfigurationRequest
object
A case assist configuration.
3 properties 1 required
CaseClassificationConfiguration
object
A mock case assist configuration to test a case classification configuration.
2 properties 1 required
RestClassification
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

coveo-case-assist-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
#Case Assist
← Back to C APIs
API Details
ID
coveo:coveo-case-assist-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-case-assist-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/coveo-case-assist-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 Case Assist 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.