Coveo Machine Learning Configuration API — Model Listing

naftiko: 1.0.0-alpha2
info:
  label: Coveo Machine Learning Configuration API — Model Listing
  description: 'Coveo Machine Learning Configuration API — Model Listing. 2 operations. Lead operation: List Models. Self-contained
    Naftiko capability covering one Coveo business surface.'
  tags:
  - Coveo
  - Machine Learning Configuration
  - Model Listing
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    COVEO_API_KEY: COVEO_API_KEY
capability:
  consumes:
  - type: http
    namespace: ml-config-model-listing
    baseUri: https://platform.cloud.coveo.com
    description: Coveo Machine Learning Configuration API — Model Listing business capability. Self-contained, no shared references.
    authentication:
      type: bearer
      token: '{{env.COVEO_API_KEY}}'
    resources:
    - name: rest-organizations-organizationId-machinelearning-configuration-modellisting
      path: /rest/organizations/{organizationId}/machinelearning/configuration/modellisting
      operations:
      - name: getmodels
        method: GET
        description: List Models
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: organizationId
          in: path
          type: string
          description: The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br />**Example:**
            `mycoveocloudv2organizationg8tp8wu3`
          required: true
        - name: engineIds
          in: query
          type: array
          description: The engine identifiers of the machine learning models to request.
      - name: getmodels1
        method: POST
        description: List Models
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: organizationId
          in: path
          type: string
          description: The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br />**Example:**
            `mycoveocloudv2organizationg8tp8wu3`
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
  exposes:
  - type: rest
    namespace: ml-config-model-listing-rest
    port: 8080
    description: REST adapter for Coveo Machine Learning Configuration API — Model Listing. One Spectral-compliant resource
      per consumed operation, prefixed with /v1.
    resources:
    - path: /v1/organizations/{organizationid}/machinelearning/configuration/modellisting
      name: rest-organizations-organizationid-machinelearning-configuration-modellisting
      description: REST surface for rest-organizations-organizationId-machinelearning-configuration-modellisting.
      operations:
      - method: GET
        name: getmodels
        description: List Models
        call: ml-config-model-listing.getmodels
        with:
          organizationId: rest.organizationId
          engineIds: rest.engineIds
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: getmodels1
        description: List Models
        call: ml-config-model-listing.getmodels1
        with:
          organizationId: rest.organizationId
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: ml-config-model-listing-mcp
    port: 9090
    transport: http
    description: MCP adapter for Coveo Machine Learning Configuration API — Model Listing. One tool per consumed operation,
      routed inline through this capability's consumes block.
    tools:
    - name: list-models
      description: List Models
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: ml-config-model-listing.getmodels
      with:
        organizationId: tools.organizationId
        engineIds: tools.engineIds
      outputParameters:
      - type: object
        mapping: $.
    - name: list-models-2
      description: List Models
      hints:
        readOnly: true
        destructive: false
        idempotent: false
      call: ml-config-model-listing.getmodels1
      with:
        organizationId: tools.organizationId
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.