Coveo Machine Learning API — Machine Learning Models

naftiko: 1.0.0-alpha2
info:
  label: Coveo Machine Learning API — Machine Learning Models
  description: 'Coveo Machine Learning API — Machine Learning Models. 8 operations. Lead operation: Delete a Model. Self-contained
    Naftiko capability covering one Coveo business surface.'
  tags:
  - Coveo
  - Machine Learning
  - Machine Learning Models
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    COVEO_API_KEY: COVEO_API_KEY
capability:
  consumes:
  - type: http
    namespace: machine-learning-machine-learning-models
    baseUri: https://platform.cloud.coveo.com
    description: Coveo Machine Learning API — Machine Learning Models business capability. Self-contained, no shared references.
    authentication:
      type: bearer
      token: '{{env.COVEO_API_KEY}}'
    resources:
    - name: rest-organizations-organizationId-machinelearning-engines-engineId-models-modelN
      path: /rest/organizations/{organizationId}/machinelearning/engines/{engineId}/models/{modelName}
      operations:
      - name: unregister
        method: DELETE
        description: Delete a Model
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: organizationId
          in: path
          type: string
          description: The unique identifier of the target Coveo Cloud organization
          required: true
        - name: engineId
          in: path
          type: string
          description: The id of the engine
          required: true
        - name: modelName
          in: path
          type: string
          description: The model name
          required: true
    - name: rest-organizations-organizationId-machinelearning-model
      path: /rest/organizations/{organizationId}/machinelearning/model
      operations:
      - name: register
        method: POST
        description: Create a New Model
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: organizationId
          in: path
          type: string
          description: The unique identifier of the target Coveo Cloud organization
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: rest-organizations-organizationId-machinelearning-models
      path: /rest/organizations/{organizationId}/machinelearning/models
      operations:
      - name: listmodels
        method: GET
        description: List All Models
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: organizationId
          in: path
          type: string
          description: The unique identifier of the target Coveo Cloud organization
          required: true
        - name: engines
          in: query
          type: array
          description: A list of engine ids
    - name: rest-organizations-organizationId-machinelearning-models-details
      path: /rest/organizations/{organizationId}/machinelearning/models/details
      operations:
      - name: listmodelswithdetails
        method: GET
        description: Get Detailed Information About All Models
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: organizationId
          in: path
          type: string
          description: The unique identifier of the target Coveo Cloud organization
          required: true
    - name: rest-organizations-organizationId-machinelearning-models-modelId
      path: /rest/organizations/{organizationId}/machinelearning/models/{modelId}
      operations:
      - name: getmodel
        method: GET
        description: View a Model
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: organizationId
          in: path
          type: string
          description: The unique identifier of the target Coveo Cloud organization
          required: true
        - name: modelId
          in: path
          type: string
          description: The unique identifier of the target model
          required: true
      - name: updatemodelinformationbyid
        method: PUT
        description: Update the Configuration of a Model
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: organizationId
          in: path
          type: string
          description: The unique identifier of the target Coveo Cloud organization
          required: true
        - name: modelId
          in: path
          type: string
          description: The unique identifier of the target model
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: unregisterbyid
        method: DELETE
        description: Delete a Model
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: organizationId
          in: path
          type: string
          description: The unique identifier of the target Coveo Cloud organization
          required: true
        - name: modelId
          in: path
          type: string
          description: The unique identifier of the target model
          required: true
    - name: rest-organizations-organizationId-machinelearning-models-modelId-details
      path: /rest/organizations/{organizationId}/machinelearning/models/{modelId}/details
      operations:
      - name: getmodeldetailsbyid
        method: GET
        description: Get detailed information about a specific model<br /><br /><details><summary>Privilege required</summary>
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: organizationId
          in: path
          type: string
          description: The unique identifier of the target Coveo Cloud organization
          required: true
        - name: modelId
          in: path
          type: string
          description: The unique identifier of the target model
          required: true
  exposes:
  - type: rest
    namespace: machine-learning-machine-learning-models-rest
    port: 8080
    description: REST adapter for Coveo Machine Learning API — Machine Learning Models. One Spectral-compliant resource per
      consumed operation, prefixed with /v1.
    resources:
    - path: /v1/organizations/{organizationid}/machinelearning/engines/{engineid}/models/{modelname}
      name: rest-organizations-organizationid-machinelearning-engines-engineid-models-modeln
      description: REST surface for rest-organizations-organizationId-machinelearning-engines-engineId-models-modelN.
      operations:
      - method: DELETE
        name: unregister
        description: Delete a Model
        call: machine-learning-machine-learning-models.unregister
        with:
          organizationId: rest.organizationId
          engineId: rest.engineId
          modelName: rest.modelName
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/organizations/{organizationid}/machinelearning/model
      name: rest-organizations-organizationid-machinelearning-model
      description: REST surface for rest-organizations-organizationId-machinelearning-model.
      operations:
      - method: POST
        name: register
        description: Create a New Model
        call: machine-learning-machine-learning-models.register
        with:
          organizationId: rest.organizationId
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/organizations/{organizationid}/machinelearning/models
      name: rest-organizations-organizationid-machinelearning-models
      description: REST surface for rest-organizations-organizationId-machinelearning-models.
      operations:
      - method: GET
        name: listmodels
        description: List All Models
        call: machine-learning-machine-learning-models.listmodels
        with:
          organizationId: rest.organizationId
          engines: rest.engines
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/organizations/{organizationid}/machinelearning/models/details
      name: rest-organizations-organizationid-machinelearning-models-details
      description: REST surface for rest-organizations-organizationId-machinelearning-models-details.
      operations:
      - method: GET
        name: listmodelswithdetails
        description: Get Detailed Information About All Models
        call: machine-learning-machine-learning-models.listmodelswithdetails
        with:
          organizationId: rest.organizationId
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/organizations/{organizationid}/machinelearning/models/{modelid}
      name: rest-organizations-organizationid-machinelearning-models-modelid
      description: REST surface for rest-organizations-organizationId-machinelearning-models-modelId.
      operations:
      - method: GET
        name: getmodel
        description: View a Model
        call: machine-learning-machine-learning-models.getmodel
        with:
          organizationId: rest.organizationId
          modelId: rest.modelId
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: updatemodelinformationbyid
        description: Update the Configuration of a Model
        call: machine-learning-machine-learning-models.updatemodelinformationbyid
        with:
          organizationId: rest.organizationId
          modelId: rest.modelId
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: unregisterbyid
        description: Delete a Model
        call: machine-learning-machine-learning-models.unregisterbyid
        with:
          organizationId: rest.organizationId
          modelId: rest.modelId
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/organizations/{organizationid}/machinelearning/models/{modelid}/details
      name: rest-organizations-organizationid-machinelearning-models-modelid-details
      description: REST surface for rest-organizations-organizationId-machinelearning-models-modelId-details.
      operations:
      - method: GET
        name: getmodeldetailsbyid
        description: Get detailed information about a specific model<br /><br /><details><summary>Privilege required</summary>
        call: machine-learning-machine-learning-models.getmodeldetailsbyid
        with:
          organizationId: rest.organizationId
          modelId: rest.modelId
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: machine-learning-machine-learning-models-mcp
    port: 9090
    transport: http
    description: MCP adapter for Coveo Machine Learning API — Machine Learning Models. One tool per consumed operation, routed
      inline through this capability's consumes block.
    tools:
    - name: delete-model
      description: Delete a Model
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: machine-learning-machine-learning-models.unregister
      with:
        organizationId: tools.organizationId
        engineId: tools.engineId
        modelName: tools.modelName
      outputParameters:
      - type: object
        mapping: $.
    - name: create-new-model
      description: Create a New Model
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: machine-learning-machine-learning-models.register
      with:
        organizationId: tools.organizationId
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: list-all-models
      description: List All Models
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: machine-learning-machine-learning-models.listmodels
      with:
        organizationId: tools.organizationId
        engines: tools.engines
      outputParameters:
      - type: object
        mapping: $.
    - name: get-detailed-information-about-all
      description: Get Detailed Information About All Models
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: machine-learning-machine-learning-models.listmodelswithdetails
      with:
        organizationId: tools.organizationId
      outputParameters:
      - type: object
        mapping: $.
    - name: view-model
      description: View a Model
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: machine-learning-machine-learning-models.getmodel
      with:
        organizationId: tools.organizationId
        modelId: tools.modelId
      outputParameters:
      - type: object
        mapping: $.
    - name: update-configuration-model
      description: Update the Configuration of a Model
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: machine-learning-machine-learning-models.updatemodelinformationbyid
      with:
        organizationId: tools.organizationId
        modelId: tools.modelId
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-model-2
      description: Delete a Model
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: machine-learning-machine-learning-models.unregisterbyid
      with:
        organizationId: tools.organizationId
        modelId: tools.modelId
      outputParameters:
      - type: object
        mapping: $.
    - name: get-detailed-information-about-specific
      description: Get detailed information about a specific model<br /><br /><details><summary>Privilege required</summary>
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: machine-learning-machine-learning-models.getmodeldetailsbyid
      with:
        organizationId: tools.organizationId
        modelId: tools.modelId
      outputParameters:
      - type: object
        mapping: $.