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

Coveo Machine learning associations API

The Machine learning associations API from Coveo — 7 operation(s) for machine learning associations.

Coveo Machine learning associations 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 Machine learning associations. 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 16 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 16 schemas 1 DELETE3 GET4 POST2 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, HTTP Bearer, HTTP Bearer, HTTP Bearer
Contact
support@coveo.com
Terms of Service
Resource Areas
1

Authentication & Security 4

Coveo Machine learning associations 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 10

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

Machine learning associations 10
GET
/rest/search/v2/admin/pipelines/{pipelineId}/ml/model/associations
List Query Pipeline ML Model Associations
listAssociationsOfPipeline 5 params → 200400401403419429
POST
/rest/search/v2/admin/pipelines/{pipelineId}/ml/model/associations
Associate an Existing Machine Learning Model with an Existing Pipeline.
associateModel 2 params body → 200400401403419429
GET
/rest/search/v2/admin/pipelines/{pipelineId}/ml/model/associations/{associationId}
Get a ML Model Association
getAssociation 3 params → 200400401403419429
PUT
/rest/search/v2/admin/pipelines/{pipelineId}/ml/model/associations/{associationId}
Update ML Model Association
updateAssociation 3 params body → 200204400401403419429
DELETE
/rest/search/v2/admin/pipelines/{pipelineId}/ml/model/associations/{associationId}
Remove Query Pipeline ML Model Association
disassociate 3 params → 200204400401403419429
PUT
/rest/search/v2/admin/pipelines/{pipelineId}/ml/model/associations/{associationId}/position
Update ML Model Association Position
updateAssociationPosition 4 params → 200204400401403419429
POST
/rest/search/v2/admin/pipelines/{pipelineId}/ml/model/associations/bulkGet
List Query Pipeline ML Model Associations
bulkGetAssociationsOfPipeline 4 params body → 200400401403419429
POST
/rest/search/v2/admin/pipelines/{pipelineId}/ml/model/associations/validate
Validate a Single ML Model Association Operation.
validateMlAssociationOperation 2 params body → 200400401403419422429
POST
/rest/search/v2/admin/pipelines/{pipelineId}/ml/model/associations/validate/batch
Validate a Batch of ML Model Association Operations.
validateMlAssociationOperations 2 params body → 200400401403419422429503
GET
/rest/search/v2/admin/pipelines/ml/version
Returns the Version of ML Models Supported by the Organization in the Request.
mlVersion 1 param → 200400401403419429

Schemas 16

The contract defines 16 schemas that model the data the API accepts and returns. The most detailed are MlPipelineAssociationWithGroupAndCondition (24 properties), CreateAssociationRequest (19 properties), EditAssociationRequest (18 properties), RestOperationValidationResponse (4 properties). Each schema is shown below with its type and property counts.

CreateAssociationRequest
object
19 properties 1 required
EditAssociationRequest
object
18 properties
RestBatchOperationValidationResponse
object
1 property 1 required
AssociationBatchValidationRequest
object
1 property 1 required
AutomaticSelectionConfiguration
object
1 property
RestOperationValidationResponse
object
4 properties 2 required
PassageRetrievalConfiguration
object
1 property
RestSingleOperationValidationResponse
object
1 property 1 required
MlPipelineAssociationWithGroupAndCondition
object
24 properties 4 required
DynamicNavigationExperienceConfiguration
object
1 property
AssociationWithConditionResponseBody
object
3 properties 3 required
AssociationSingleValidationRequest
object
1 property 1 required
RestBulkGetRequest
object
1 property
RestOperationValidationError
object
1 property 1 required
AssociationValidationRequest
object
3 properties 1 required
ErrorMessage
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

coveo-machine-learning-associations-api-openapi.yml Raw ↑

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
Where this information came from

This is an independent, third-party profile of Coveo Machine learning associations 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.