Coveo Machine Learning Configuration API — Dynamic Navigation Experience Configuration

naftiko: 1.0.0-alpha2
info:
  label: Coveo Machine Learning Configuration API — Dynamic Navigation Experience Configuration
  description: 'Coveo Machine Learning Configuration API — Dynamic Navigation Experience Configuration. 9 operations. Lead
    operation: List Fields. Self-contained Naftiko capability covering one Coveo business surface.'
  tags:
  - Coveo
  - Machine Learning Configuration
  - Dynamic Navigation Experience 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-dynamic-navigation-experience-configuration
    baseUri: https://platform.cloud.coveo.com
    description: Coveo Machine Learning Configuration API — Dynamic Navigation Experience Configuration business capability.
      Self-contained, no shared references.
    authentication:
      type: bearer
      token: '{{env.COVEO_API_KEY}}'
    resources:
    - name: rest-organizations-organizationId-machinelearning-configuration-dne-autoselectio
      path: /rest/organizations/{organizationId}/machinelearning/configuration/dne/autoselectionfieldcandidates
      operations:
      - name: getautoselectionfieldcandidates
        method: GET
        description: List 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: filter
          in: query
          type: string
          description: A substring that must appear in the `name` property of a [field](https://docs.coveo.com/en/200/) in
            order for this field to be included in the results.<br />**E
        - name: page
          in: query
          type: integer
          description: 'The 0-based number of the page of results to list.<br />Minimum: `0`<br />**Default:** `0`'
        - name: perPage
          in: query
          type: integer
          description: The maximum number of results to include per page.<br />**Must be in range:** `[1, 1000]`<br />**Default:**
            `100`
    - name: rest-organizations-organizationId-machinelearning-configuration-dne-documentextr
      path: /rest/organizations/{organizationId}/machinelearning/configuration/dne/documentextractionpreview
      operations:
      - name: getdocumentextractionpreview
        method: GET
        description: Show Document Extraction Preview
        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: fields
          in: query
          type: array
          description: The names of the fields to consider for the document extraction preview. Documents for which at least
            one of these fields is defined will be included in the pre
          required: true
        - name: maximumNumberOfSources
          in: query
          type: integer
          description: The maximum number of sources to return.<br />**Example:** `10`
        - name: viewAllContent
          in: query
          type: boolean
          description: Whether to allow the preview to include secured documents.
          required: true
    - name: rest-organizations-organizationId-machinelearning-configuration-dne-documentextr
      path: /rest/organizations/{organizationId}/machinelearning/configuration/dne/documentextractionquery
      operations:
      - name: getdocumentextractionquery
        method: POST
        description: Show Document Extraction Query
        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-dne-documentextr
      path: /rest/organizations/{organizationId}/machinelearning/configuration/dne/documentextractionquerymodel
      operations:
      - name: getdocumentextractionquerymodel
        method: GET
        description: Parse a Document Extraction Query
        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: query
          in: query
          type: string
          description: The query that determines the documents to extract. Use the `POST /rest/organizations/{organizationId}/machinelearning/configuration/dne/documentextractionquery
          required: true
    - name: rest-organizations-organizationId-machinelearning-configuration-dne-model
      path: /rest/organizations/{organizationId}/machinelearning/configuration/dne/model
      operations:
      - name: createmodel1
        method: POST
        description: Create DNE Model Resources
        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-dne-model-modelI
      path: /rest/organizations/{organizationId}/machinelearning/configuration/dne/model/{modelId}
      operations:
      - name: getmodel
        method: GET
        description: Show DNE Model Resources
        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: modelId
          in: path
          type: string
          description: The unique identifier of the target machine learning model.<br />**Example:** `My_Model_ID`
          required: true
      - name: updatemodel
        method: PUT
        description: Update DNE Model Resources
        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: modelId
          in: path
          type: string
          description: The unique identifier of the target machine learning model.<br />**Example:** `My_Model_ID`
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: deletemodel
        method: DELETE
        description: Delete DNE Model Resources
        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: modelId
          in: path
          type: string
          description: The unique identifier of the target machine learning model.<br />**Example:** `My_Model_ID`
          required: true
    - name: rest-organizations-organizationId-machinelearning-configuration-dne-parsedocumen
      path: /rest/organizations/{organizationId}/machinelearning/configuration/dne/parsedocumentextractionquerymodel
      operations:
      - name: parsedocumentextractionquery
        method: POST
        description: Parse a Document Extraction Query
        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-dynamic-navigation-experience-configuration-rest
    port: 8080
    description: REST adapter for Coveo Machine Learning Configuration API — Dynamic Navigation Experience Configuration.
      One Spectral-compliant resource per consumed operation, prefixed with /v1.
    resources:
    - path: /v1/organizations/{organizationid}/machinelearning/configuration/dne/autoselectionfieldcandidates
      name: rest-organizations-organizationid-machinelearning-configuration-dne-autoselectio
      description: REST surface for rest-organizations-organizationId-machinelearning-configuration-dne-autoselectio.
      operations:
      - method: GET
        name: getautoselectionfieldcandidates
        description: List Fields
        call: ml-config-dynamic-navigation-experience-configuration.getautoselectionfieldcandidates
        with:
          organizationId: rest.organizationId
          filter: rest.filter
          page: rest.page
          perPage: rest.perPage
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/organizations/{organizationid}/machinelearning/configuration/dne/documentextractionpreview
      name: rest-organizations-organizationid-machinelearning-configuration-dne-documentextr
      description: REST surface for rest-organizations-organizationId-machinelearning-configuration-dne-documentextr.
      operations:
      - method: GET
        name: getdocumentextractionpreview
        description: Show Document Extraction Preview
        call: ml-config-dynamic-navigation-experience-configuration.getdocumentextractionpreview
        with:
          organizationId: rest.organizationId
          fields: rest.fields
          maximumNumberOfSources: rest.maximumNumberOfSources
          viewAllContent: rest.viewAllContent
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/organizations/{organizationid}/machinelearning/configuration/dne/documentextractionquery
      name: rest-organizations-organizationid-machinelearning-configuration-dne-documentextr
      description: REST surface for rest-organizations-organizationId-machinelearning-configuration-dne-documentextr.
      operations:
      - method: POST
        name: getdocumentextractionquery
        description: Show Document Extraction Query
        call: ml-config-dynamic-navigation-experience-configuration.getdocumentextractionquery
        with:
          organizationId: rest.organizationId
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/organizations/{organizationid}/machinelearning/configuration/dne/documentextractionquerymodel
      name: rest-organizations-organizationid-machinelearning-configuration-dne-documentextr
      description: REST surface for rest-organizations-organizationId-machinelearning-configuration-dne-documentextr.
      operations:
      - method: GET
        name: getdocumentextractionquerymodel
        description: Parse a Document Extraction Query
        call: ml-config-dynamic-navigation-experience-configuration.getdocumentextractionquerymodel
        with:
          organizationId: rest.organizationId
          query: rest.query
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/organizations/{organizationid}/machinelearning/configuration/dne/model
      name: rest-organizations-organizationid-machinelearning-configuration-dne-model
      description: REST surface for rest-organizations-organizationId-machinelearning-configuration-dne-model.
      operations:
      - method: POST
        name: createmodel1
        description: Create DNE Model Resources
        call: ml-config-dynamic-navigation-experience-configuration.createmodel1
        with:
          organizationId: rest.organizationId
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/organizations/{organizationid}/machinelearning/configuration/dne/model/{modelid}
      name: rest-organizations-organizationid-machinelearning-configuration-dne-model-modeli
      description: REST surface for rest-organizations-organizationId-machinelearning-configuration-dne-model-modelI.
      operations:
      - method: GET
        name: getmodel
        description: Show DNE Model Resources
        call: ml-config-dynamic-navigation-experience-configuration.getmodel
        with:
          organizationId: rest.organizationId
          modelId: rest.modelId
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: updatemodel
        description: Update DNE Model Resources
        call: ml-config-dynamic-navigation-experience-configuration.updatemodel
        with:
          organizationId: rest.organizationId
          modelId: rest.modelId
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deletemodel
        description: Delete DNE Model Resources
        call: ml-config-dynamic-navigation-experience-configuration.deletemodel
        with:
          organizationId: rest.organizationId
          modelId: rest.modelId
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/organizations/{organizationid}/machinelearning/configuration/dne/parsedocumentextractionquerymodel
      name: rest-organizations-organizationid-machinelearning-configuration-dne-parsedocumen
      description: REST surface for rest-organizations-organizationId-machinelearning-configuration-dne-parsedocumen.
      operations:
      - method: POST
        name: parsedocumentextractionquery
        description: Parse a Document Extraction Query
        call: ml-config-dynamic-navigation-experience-configuration.parsedocumentextractionquery
        with:
          organizationId: rest.organizationId
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: ml-config-dynamic-navigation-experience-configuration-mcp
    port: 9090
    transport: http
    description: MCP adapter for Coveo Machine Learning Configuration API — Dynamic Navigation Experience Configuration. One
      tool per consumed operation, routed inline through this capability's consumes block.
    tools:
    - name: list-fields
      description: List Fields
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: ml-config-dynamic-navigation-experience-configuration.getautoselectionfieldcandidates
      with:
        organizationId: tools.organizationId
        filter: tools.filter
        page: tools.page
        perPage: tools.perPage
      outputParameters:
      - type: object
        mapping: $.
    - name: show-document-extraction-preview
      description: Show Document Extraction Preview
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: ml-config-dynamic-navigation-experience-configuration.getdocumentextractionpreview
      with:
        organizationId: tools.organizationId
        fields: tools.fields
        maximumNumberOfSources: tools.maximumNumberOfSources
        viewAllContent: tools.viewAllContent
      outputParameters:
      - type: object
        mapping: $.
    - name: show-document-extraction-query
      description: Show Document Extraction Query
      hints:
        readOnly: true
        destructive: false
        idempotent: false
      call: ml-config-dynamic-navigation-experience-configuration.getdocumentextractionquery
      with:
        organizationId: tools.organizationId
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: parse-document-extraction-query
      description: Parse a Document Extraction Query
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: ml-config-dynamic-navigation-experience-configuration.getdocumentextractionquerymodel
      with:
        organizationId: tools.organizationId
        query: tools.query
      outputParameters:
      - type: object
        mapping: $.
    - name: create-dne-model-resources
      description: Create DNE Model Resources
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: ml-config-dynamic-navigation-experience-configuration.createmodel1
      with:
        organizationId: tools.organizationId
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: show-dne-model-resources
      description: Show DNE Model Resources
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: ml-config-dynamic-navigation-experience-configuration.getmodel
      with:
        organizationId: tools.organizationId
        modelId: tools.modelId
      outputParameters:
      - type: object
        mapping: $.
    - name: update-dne-model-resources
      description: Update DNE Model Resources
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: ml-config-dynamic-navigation-experience-configuration.updatemodel
      with:
        organizationId: tools.organizationId
        modelId: tools.modelId
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-dne-model-resources
      description: Delete DNE Model Resources
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: ml-config-dynamic-navigation-experience-configuration.deletemodel
      with:
        organizationId: tools.organizationId
        modelId: tools.modelId
      outputParameters:
      - type: object
        mapping: $.
    - name: parse-document-extraction-query-2
      description: Parse a Document Extraction Query
      hints:
        readOnly: true
        destructive: false
        idempotent: false
      call: ml-config-dynamic-navigation-experience-configuration.parsedocumentextractionquery
      with:
        organizationId: tools.organizationId
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.