Coveo Machine Learning Configuration API — Smart Snippets Configuration

naftiko: 1.0.0-alpha2
info:
  label: Coveo Machine Learning Configuration API — Smart Snippets Configuration
  description: 'Coveo Machine Learning Configuration API — Smart Snippets Configuration. 3 operations. Lead operation: Get
    SS Content Fields. Self-contained Naftiko capability covering one Coveo business surface.'
  tags:
  - Coveo
  - Machine Learning Configuration
  - Smart Snippets Configuration
  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-smart-snippets-configuration
    baseUri: https://platform.cloud.coveo.com
    description: Coveo Machine Learning Configuration API — Smart Snippets Configuration business capability. Self-contained,
      no shared references.
    authentication:
      type: bearer
      token: '{{env.COVEO_API_KEY}}'
    resources:
    - name: rest-organizations-organizationId-machinelearning-configuration-smartsnippets-co
      path: /rest/organizations/{organizationId}/machinelearning/configuration/smartsnippets/contentfields
      operations:
      - name: getcontentfields
        method: POST
        description: Get SS Content Fields
        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
    - name: rest-organizations-organizationId-machinelearning-configuration-smartsnippets-do
      path: /rest/organizations/{organizationId}/machinelearning/configuration/smartsnippets/documenttypes
      operations:
      - name: getdocumenttypes
        method: POST
        description: Get SS Document Types
        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
    - name: rest-organizations-organizationId-machinelearning-configuration-smartsnippets-pr
      path: /rest/organizations/{organizationId}/machinelearning/configuration/smartsnippets/preview
      operations:
      - name: getdocumentscountpreview
        method: POST
        description: Get Preview for Building an SS Model.
        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-smart-snippets-configuration-rest
    port: 8080
    description: REST adapter for Coveo Machine Learning Configuration API — Smart Snippets Configuration. One Spectral-compliant
      resource per consumed operation, prefixed with /v1.
    resources:
    - path: /v1/organizations/{organizationid}/machinelearning/configuration/smartsnippets/contentfields
      name: rest-organizations-organizationid-machinelearning-configuration-smartsnippets-co
      description: REST surface for rest-organizations-organizationId-machinelearning-configuration-smartsnippets-co.
      operations:
      - method: POST
        name: getcontentfields
        description: Get SS Content Fields
        call: ml-config-smart-snippets-configuration.getcontentfields
        with:
          organizationId: rest.organizationId
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/organizations/{organizationid}/machinelearning/configuration/smartsnippets/documenttypes
      name: rest-organizations-organizationid-machinelearning-configuration-smartsnippets-do
      description: REST surface for rest-organizations-organizationId-machinelearning-configuration-smartsnippets-do.
      operations:
      - method: POST
        name: getdocumenttypes
        description: Get SS Document Types
        call: ml-config-smart-snippets-configuration.getdocumenttypes
        with:
          organizationId: rest.organizationId
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/organizations/{organizationid}/machinelearning/configuration/smartsnippets/preview
      name: rest-organizations-organizationid-machinelearning-configuration-smartsnippets-pr
      description: REST surface for rest-organizations-organizationId-machinelearning-configuration-smartsnippets-pr.
      operations:
      - method: POST
        name: getdocumentscountpreview
        description: Get Preview for Building an SS Model.
        call: ml-config-smart-snippets-configuration.getdocumentscountpreview
        with:
          organizationId: rest.organizationId
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: ml-config-smart-snippets-configuration-mcp
    port: 9090
    transport: http
    description: MCP adapter for Coveo Machine Learning Configuration API — Smart Snippets Configuration. One tool per consumed
      operation, routed inline through this capability's consumes block.
    tools:
    - name: get-ss-content-fields
      description: Get SS Content Fields
      hints:
        readOnly: true
        destructive: false
        idempotent: false
      call: ml-config-smart-snippets-configuration.getcontentfields
      with:
        organizationId: tools.organizationId
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: get-ss-document-types
      description: Get SS Document Types
      hints:
        readOnly: true
        destructive: false
        idempotent: false
      call: ml-config-smart-snippets-configuration.getdocumenttypes
      with:
        organizationId: tools.organizationId
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: get-preview-building-ss-model
      description: Get Preview for Building an SS Model.
      hints:
        readOnly: true
        destructive: false
        idempotent: false
      call: ml-config-smart-snippets-configuration.getdocumentscountpreview
      with:
        organizationId: tools.organizationId
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.