Coveo Search Interface Service API — Insight Panel

naftiko: 1.0.0-alpha2
info:
  label: Coveo Search Interface Service API — Insight Panel
  description: 'Coveo Search Interface Service API — Insight Panel. 9 operations. Lead operation: Create an Insight Panel
    Interface. Self-contained Naftiko capability covering one Coveo business surface.'
  tags:
  - Coveo
  - Search Interface Service
  - Insight Panel
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    COVEO_SEARCH_TOKEN: COVEO_SEARCH_TOKEN
capability:
  consumes:
  - type: http
    namespace: search-interface-insight-panel
    baseUri: https://platform.cloud.coveo.com
    description: Coveo Search Interface Service API — Insight Panel business capability. Self-contained, no shared references.
    authentication:
      type: bearer
      token: '{{env.COVEO_SEARCH_TOKEN}}'
    resources:
    - name: rest-organizations-organizationId-insightinterface-v1-interfaces
      path: /rest/organizations/{organizationId}/insightinterface/v1/interfaces
      operations:
      - name: createinsightpanelinterface
        method: POST
        description: Create an Insight Panel Interface
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: getallinsightpanelinterfaces
        method: GET
        description: Get All Insight Panel Interfaces
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: rest-organizations-organizationId-insightinterface-v1-interfaces-interfaceId
      path: /rest/organizations/{organizationId}/insightinterface/v1/interfaces/{interfaceId}
      operations:
      - name: getinsightpanelinterface
        method: GET
        description: Get an Insight Panel Interface
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: updateinsightpanelinterface
        method: PUT
        description: Update an Insight Panel Interface
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: deleteinsightpanelinterface
        method: DELETE
        description: Delete an Insight Panel Interface
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: rest-organizations-organizationId-insightinterface-v1-interfaces-interfaceId-ver
      path: /rest/organizations/{organizationId}/insightinterface/v1/interfaces/{interfaceId}/versions
      operations:
      - name: getinsightpanelinterfaceversions
        method: GET
        description: Get Versions for an Insight Panel Interface
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: rest-organizations-organizationId-insightinterface-v1-interfaces-interfaceId-ver
      path: /rest/organizations/{organizationId}/insightinterface/v1/interfaces/{interfaceId}/versions/{versionNumber}
      operations:
      - name: getinsightpanelinterfaceversion
        method: GET
        description: Get an Insight Panel Interface Version
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: rest-organizations-organizationId-insightinterface-v1-interfaces-interfaceId-ver
      path: /rest/organizations/{organizationId}/insightinterface/v1/interfaces/{interfaceId}/versions/{versionNumber}/label
      operations:
      - name: updateinsightpanelinterfaceversionlabel
        method: PUT
        description: Update an Insight Panel Interface Version Label
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: rest-organizations-organizationId-insightinterface-v1-interfaces-interfaceId-ver
      path: /rest/organizations/{organizationId}/insightinterface/v1/interfaces/{interfaceId}/versions/{versionNumber}/restore
      operations:
      - name: restoreinsightpanelinterfaceversion
        method: POST
        description: Restore an Insight Panel Interface Version
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
  exposes:
  - type: rest
    namespace: search-interface-insight-panel-rest
    port: 8080
    description: REST adapter for Coveo Search Interface Service API — Insight Panel. One Spectral-compliant resource per
      consumed operation, prefixed with /v1.
    resources:
    - path: /v1/organizations/{organizationid}/insightinterface/v1/interfaces
      name: rest-organizations-organizationid-insightinterface-v1-interfaces
      description: REST surface for rest-organizations-organizationId-insightinterface-v1-interfaces.
      operations:
      - method: POST
        name: createinsightpanelinterface
        description: Create an Insight Panel Interface
        call: search-interface-insight-panel.createinsightpanelinterface
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: GET
        name: getallinsightpanelinterfaces
        description: Get All Insight Panel Interfaces
        call: search-interface-insight-panel.getallinsightpanelinterfaces
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/organizations/{organizationid}/insightinterface/v1/interfaces/{interfaceid}
      name: rest-organizations-organizationid-insightinterface-v1-interfaces-interfaceid
      description: REST surface for rest-organizations-organizationId-insightinterface-v1-interfaces-interfaceId.
      operations:
      - method: GET
        name: getinsightpanelinterface
        description: Get an Insight Panel Interface
        call: search-interface-insight-panel.getinsightpanelinterface
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: updateinsightpanelinterface
        description: Update an Insight Panel Interface
        call: search-interface-insight-panel.updateinsightpanelinterface
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deleteinsightpanelinterface
        description: Delete an Insight Panel Interface
        call: search-interface-insight-panel.deleteinsightpanelinterface
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/organizations/{organizationid}/insightinterface/v1/interfaces/{interfaceid}/versions
      name: rest-organizations-organizationid-insightinterface-v1-interfaces-interfaceid-ver
      description: REST surface for rest-organizations-organizationId-insightinterface-v1-interfaces-interfaceId-ver.
      operations:
      - method: GET
        name: getinsightpanelinterfaceversions
        description: Get Versions for an Insight Panel Interface
        call: search-interface-insight-panel.getinsightpanelinterfaceversions
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/organizations/{organizationid}/insightinterface/v1/interfaces/{interfaceid}/versions/{versionnumber}
      name: rest-organizations-organizationid-insightinterface-v1-interfaces-interfaceid-ver
      description: REST surface for rest-organizations-organizationId-insightinterface-v1-interfaces-interfaceId-ver.
      operations:
      - method: GET
        name: getinsightpanelinterfaceversion
        description: Get an Insight Panel Interface Version
        call: search-interface-insight-panel.getinsightpanelinterfaceversion
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/organizations/{organizationid}/insightinterface/v1/interfaces/{interfaceid}/versions/{versionnumber}/label
      name: rest-organizations-organizationid-insightinterface-v1-interfaces-interfaceid-ver
      description: REST surface for rest-organizations-organizationId-insightinterface-v1-interfaces-interfaceId-ver.
      operations:
      - method: PUT
        name: updateinsightpanelinterfaceversionlabel
        description: Update an Insight Panel Interface Version Label
        call: search-interface-insight-panel.updateinsightpanelinterfaceversionlabel
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/organizations/{organizationid}/insightinterface/v1/interfaces/{interfaceid}/versions/{versionnumber}/restore
      name: rest-organizations-organizationid-insightinterface-v1-interfaces-interfaceid-ver
      description: REST surface for rest-organizations-organizationId-insightinterface-v1-interfaces-interfaceId-ver.
      operations:
      - method: POST
        name: restoreinsightpanelinterfaceversion
        description: Restore an Insight Panel Interface Version
        call: search-interface-insight-panel.restoreinsightpanelinterfaceversion
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: search-interface-insight-panel-mcp
    port: 9090
    transport: http
    description: MCP adapter for Coveo Search Interface Service API — Insight Panel. One tool per consumed operation, routed
      inline through this capability's consumes block.
    tools:
    - name: create-insight-panel-interface
      description: Create an Insight Panel Interface
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: search-interface-insight-panel.createinsightpanelinterface
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: get-all-insight-panel-interfaces
      description: Get All Insight Panel Interfaces
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: search-interface-insight-panel.getallinsightpanelinterfaces
      outputParameters:
      - type: object
        mapping: $.
    - name: get-insight-panel-interface
      description: Get an Insight Panel Interface
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: search-interface-insight-panel.getinsightpanelinterface
      outputParameters:
      - type: object
        mapping: $.
    - name: update-insight-panel-interface
      description: Update an Insight Panel Interface
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: search-interface-insight-panel.updateinsightpanelinterface
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-insight-panel-interface
      description: Delete an Insight Panel Interface
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: search-interface-insight-panel.deleteinsightpanelinterface
      outputParameters:
      - type: object
        mapping: $.
    - name: get-versions-insight-panel-interface
      description: Get Versions for an Insight Panel Interface
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: search-interface-insight-panel.getinsightpanelinterfaceversions
      outputParameters:
      - type: object
        mapping: $.
    - name: get-insight-panel-interface-version
      description: Get an Insight Panel Interface Version
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: search-interface-insight-panel.getinsightpanelinterfaceversion
      outputParameters:
      - type: object
        mapping: $.
    - name: update-insight-panel-interface-version
      description: Update an Insight Panel Interface Version Label
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: search-interface-insight-panel.updateinsightpanelinterfaceversionlabel
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: restore-insight-panel-interface-version
      description: Restore an Insight Panel Interface Version
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: search-interface-insight-panel.restoreinsightpanelinterfaceversion
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.