Coveo Customer Service API — Insight Panel

naftiko: 1.0.0-alpha2
info:
  label: Coveo Customer Service API — Insight Panel
  description: 'Coveo Customer Service API — Insight Panel. 11 operations. Lead operation: Get an Insight Panel Interface.
    Self-contained Naftiko capability covering one Coveo business surface.'
  tags:
  - Coveo
  - Customer 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: customer-service-insight-panel
    baseUri: https://platform.cloud.coveo.com
    description: Coveo Customer Service API — Insight Panel business capability. Self-contained, no shared references.
    authentication:
      type: bearer
      token: '{{env.COVEO_SEARCH_TOKEN}}'
    resources:
    - name: rest-organizations-organizationId-insight-v1-configs-configId-interface
      path: /rest/organizations/{organizationId}/insight/v1/configs/{configId}/interface
      operations:
      - name: insightpanelinterfaceget
        method: GET
        description: Get an Insight Panel Interface
        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 /><b>Example:</b>
            `mycoveocloudv2organizationg8tp8wu3`
          required: true
        - name: configId
          in: path
          type: string
          description: The unique identifier of the target Insight Panel configuration.
          required: true
    - name: rest-organizations-organizationId-insight-v1-configs-configId-querysuggest
      path: /rest/organizations/{organizationId}/insight/v1/configs/{configId}/querysuggest
      operations:
      - name: insightpanelquerysuggest
        method: POST
        description: Retrieve Query Suggestions
        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 /><b>Example:</b>
            `mycoveocloudv2organizationg8tp8wu3`
          required: true
        - name: configId
          in: path
          type: string
          description: The unique identifier of the Insight Panel configuration.
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: rest-organizations-organizationId-insight-v1-configs-configId-quickview
      path: /rest/organizations/{organizationId}/insight/v1/configs/{configId}/quickview
      operations:
      - name: insightpanelquickview
        method: GET
        description: Retrieve Item Quickview
        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 /><b>Example:</b>
            `mycoveocloudv2organizationg8tp8wu3`
          required: true
        - name: configId
          in: path
          type: string
          description: The unique identifier of the target Insight Panel configuration.
          required: true
        - name: uniqueId
          in: query
          type: string
          description: The unique identifier of the target document.
          required: true
        - name: q
          in: query
          type: string
          description: <p>The basic query expression, typically the keywords entered by the end user in a query box.</p> <p><strong>Note:</strong>
            When logging a <strong>Search</stron
        - name: enableNavigation
          in: query
          type: boolean
          description: Provide controls to the end user for navigating through the matching keywords in the document.
        - name: requestedOutputSize
          in: query
          type: integer
          description: The approximate number of bytes to request in the HTML response. <strong>Default:</strong> <code>0</code>,
            meaning that the entire HTML document is requested.
    - name: rest-organizations-organizationId-insight-v1-configs-configId-search
      path: /rest/organizations/{organizationId}/insight/v1/configs/{configId}/search
      operations:
      - name: insightpanelsearch
        method: POST
        description: Search for Items
        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 /><b>Example:</b>
            `mycoveocloudv2organizationg8tp8wu3`
          required: true
        - name: configId
          in: path
          type: string
          description: The unique identifier of the Insight Panel configuration.
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: rest-organizations-organizationId-insightconfig-v1-configs
      path: /rest/organizations/{organizationId}/insightconfig/v1/configs
      operations:
      - name: insightpanelconfigurationlist
        method: GET
        description: List Insight Panel Configurations
        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 /><b>Example:</b>
            `mycoveocloudv2organizationg8tp8wu3`
          required: true
        - name: page
          in: query
          type: integer
          description: The 0-based number of the page of configurations to list.
        - name: perPage
          in: query
          type: integer
          description: The number of configurations to list per page. Must be equal to or greater than <code>1</code>.
        - name: filter
          in: query
          type: string
          description: A filter that only retrieves matching Insight Panel configurations.
        - name: order
          in: query
          type: string
          description: 'The order in which the configurations are listed. The available values are: <ul> <li><i>empty</i>:
            items are not sorted in any specific order.</li> <li><code>as'
      - name: insightpanelconfigurationcreate
        method: POST
        description: Create an Insight Panel Configuration
        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 /><b>Example:</b>
            `mycoveocloudv2organizationg8tp8wu3`
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: rest-organizations-organizationId-insightconfig-v1-configs-ids
      path: /rest/organizations/{organizationId}/insightconfig/v1/configs/ids
      operations:
      - name: insightpanelconfigurationlistids
        method: POST
        description: List Insight Panel Configurations by Ids.
        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 /><b>Example:</b>
            `mycoveocloudv2organizationg8tp8wu3`
          required: true
        - name: page
          in: query
          type: integer
          description: The 0-based number of the page of configurations to list.
        - name: perPage
          in: query
          type: integer
          description: The number of configurations to list per page. Must be equal to or greater than <code>1</code>.
        - name: filter
          in: query
          type: string
          description: A filter that only retrieves matching Insight Panel configurations.
        - name: order
          in: query
          type: string
          description: 'The order in which the configurations are listed. The available values are: <ul> <li><i>empty</i>:
            items are not sorted in any specific order.</li> <li><code>as'
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: rest-organizations-organizationId-insightconfig-v1-configs-projects-get
      path: /rest/organizations/{organizationId}/insightconfig/v1/configs/projects/get
      operations:
      - name: getinsightconfigurationsbyproject
        method: GET
        description: Get Insight Configurations by Project
        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 /><b>Example:</b>
            `mycoveocloudv2organizationg8tp8wu3`
          required: true
        - name: projectId
          in: query
          type: string
          description: The unique identifier of the project for which to retrieve insight panel configurations.
          required: true
        - name: page
          in: query
          type: integer
          description: The 0-based number of the page of configurations to list.<br /><b>Default:</b> `0`
        - name: perPage
          in: query
          type: integer
          description: The maximum number of configurations to include per page.<br /><b>Default:</b> `100`
        - name: filter
          in: query
          type: string
          description: A filter that only retrieves matching Insight Panel configurations.
        - name: order
          in: query
          type: string
          description: 'The order in which the configurations are listed. The available values are: <ul> <li><i>empty</i>:
            items are not sorted in any specific order.</li> <li><code>as'
    - name: rest-organizations-organizationId-insightconfig-v1-configs-configId
      path: /rest/organizations/{organizationId}/insightconfig/v1/configs/{configId}
      operations:
      - name: insightpanelconfigurationget
        method: GET
        description: Get an Insight Panel Configuration
        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 /><b>Example:</b>
            `mycoveocloudv2organizationg8tp8wu3`
          required: true
        - name: configId
          in: path
          type: string
          description: The unique identifier of the target Insight Panel configuration.
          required: true
      - name: insightpanelconfigurationupdate
        method: PUT
        description: Update an Insight Panel Configuration
        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 /><b>Example:</b>
            `mycoveocloudv2organizationg8tp8wu3`
          required: true
        - name: configId
          in: path
          type: string
          description: The unique identifier of the target Insight Panel configuration.
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
      - name: insightpanelconfigurationdelete
        method: DELETE
        description: Delete an Insight Panel Configuration
        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 /><b>Example:</b>
            `mycoveocloudv2organizationg8tp8wu3`
          required: true
        - name: configId
          in: path
          type: string
          description: The unique identifier of the target Insight Panel configuration.
          required: true
  exposes:
  - type: rest
    namespace: customer-service-insight-panel-rest
    port: 8080
    description: REST adapter for Coveo Customer Service API — Insight Panel. One Spectral-compliant resource per consumed
      operation, prefixed with /v1.
    resources:
    - path: /v1/organizations/{organizationid}/insight/v1/configs/{configid}/interface
      name: rest-organizations-organizationid-insight-v1-configs-configid-interface
      description: REST surface for rest-organizations-organizationId-insight-v1-configs-configId-interface.
      operations:
      - method: GET
        name: insightpanelinterfaceget
        description: Get an Insight Panel Interface
        call: customer-service-insight-panel.insightpanelinterfaceget
        with:
          organizationId: rest.organizationId
          configId: rest.configId
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/organizations/{organizationid}/insight/v1/configs/{configid}/querysuggest
      name: rest-organizations-organizationid-insight-v1-configs-configid-querysuggest
      description: REST surface for rest-organizations-organizationId-insight-v1-configs-configId-querysuggest.
      operations:
      - method: POST
        name: insightpanelquerysuggest
        description: Retrieve Query Suggestions
        call: customer-service-insight-panel.insightpanelquerysuggest
        with:
          organizationId: rest.organizationId
          configId: rest.configId
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/organizations/{organizationid}/insight/v1/configs/{configid}/quickview
      name: rest-organizations-organizationid-insight-v1-configs-configid-quickview
      description: REST surface for rest-organizations-organizationId-insight-v1-configs-configId-quickview.
      operations:
      - method: GET
        name: insightpanelquickview
        description: Retrieve Item Quickview
        call: customer-service-insight-panel.insightpanelquickview
        with:
          organizationId: rest.organizationId
          configId: rest.configId
          uniqueId: rest.uniqueId
          q: rest.q
          enableNavigation: rest.enableNavigation
          requestedOutputSize: rest.requestedOutputSize
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/organizations/{organizationid}/insight/v1/configs/{configid}/search
      name: rest-organizations-organizationid-insight-v1-configs-configid-search
      description: REST surface for rest-organizations-organizationId-insight-v1-configs-configId-search.
      operations:
      - method: POST
        name: insightpanelsearch
        description: Search for Items
        call: customer-service-insight-panel.insightpanelsearch
        with:
          organizationId: rest.organizationId
          configId: rest.configId
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/organizations/{organizationid}/insightconfig/v1/configs
      name: rest-organizations-organizationid-insightconfig-v1-configs
      description: REST surface for rest-organizations-organizationId-insightconfig-v1-configs.
      operations:
      - method: GET
        name: insightpanelconfigurationlist
        description: List Insight Panel Configurations
        call: customer-service-insight-panel.insightpanelconfigurationlist
        with:
          organizationId: rest.organizationId
          page: rest.page
          perPage: rest.perPage
          filter: rest.filter
          order: rest.order
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: insightpanelconfigurationcreate
        description: Create an Insight Panel Configuration
        call: customer-service-insight-panel.insightpanelconfigurationcreate
        with:
          organizationId: rest.organizationId
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/organizations/{organizationid}/insightconfig/v1/configs/ids
      name: rest-organizations-organizationid-insightconfig-v1-configs-ids
      description: REST surface for rest-organizations-organizationId-insightconfig-v1-configs-ids.
      operations:
      - method: POST
        name: insightpanelconfigurationlistids
        description: List Insight Panel Configurations by Ids.
        call: customer-service-insight-panel.insightpanelconfigurationlistids
        with:
          organizationId: rest.organizationId
          page: rest.page
          perPage: rest.perPage
          filter: rest.filter
          order: rest.order
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/organizations/{organizationid}/insightconfig/v1/configs/projects/get
      name: rest-organizations-organizationid-insightconfig-v1-configs-projects-get
      description: REST surface for rest-organizations-organizationId-insightconfig-v1-configs-projects-get.
      operations:
      - method: GET
        name: getinsightconfigurationsbyproject
        description: Get Insight Configurations by Project
        call: customer-service-insight-panel.getinsightconfigurationsbyproject
        with:
          organizationId: rest.organizationId
          projectId: rest.projectId
          page: rest.page
          perPage: rest.perPage
          filter: rest.filter
          order: rest.order
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/organizations/{organizationid}/insightconfig/v1/configs/{configid}
      name: rest-organizations-organizationid-insightconfig-v1-configs-configid
      description: REST surface for rest-organizations-organizationId-insightconfig-v1-configs-configId.
      operations:
      - method: GET
        name: insightpanelconfigurationget
        description: Get an Insight Panel Configuration
        call: customer-service-insight-panel.insightpanelconfigurationget
        with:
          organizationId: rest.organizationId
          configId: rest.configId
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: insightpanelconfigurationupdate
        description: Update an Insight Panel Configuration
        call: customer-service-insight-panel.insightpanelconfigurationupdate
        with:
          organizationId: rest.organizationId
          configId: rest.configId
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: insightpanelconfigurationdelete
        description: Delete an Insight Panel Configuration
        call: customer-service-insight-panel.insightpanelconfigurationdelete
        with:
          organizationId: rest.organizationId
          configId: rest.configId
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: customer-service-insight-panel-mcp
    port: 9090
    transport: http
    description: MCP adapter for Coveo Customer Service API — Insight Panel. One tool per consumed operation, routed inline
      through this capability's consumes block.
    tools:
    - name: get-insight-panel-interface
      description: Get an Insight Panel Interface
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: customer-service-insight-panel.insightpanelinterfaceget
      with:
        organizationId: tools.organizationId
        configId: tools.configId
      outputParameters:
      - type: object
        mapping: $.
    - name: retrieve-query-suggestions
      description: Retrieve Query Suggestions
      hints:
        readOnly: true
        destructive: false
        idempotent: false
      call: customer-service-insight-panel.insightpanelquerysuggest
      with:
        organizationId: tools.organizationId
        configId: tools.configId
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: retrieve-item-quickview
      description: Retrieve Item Quickview
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: customer-service-insight-panel.insightpanelquickview
      with:
        organizationId: tools.organizationId
        configId: tools.configId
        uniqueId: tools.uniqueId
        q: tools.q
        enableNavigation: tools.enableNavigation
        requestedOutputSize: tools.requestedOutputSize
      outputParameters:
      - type: object
        mapping: $.
    - name: search-items
      description: Search for Items
      hints:
        readOnly: true
        destructive: false
        idempotent: false
      call: customer-service-insight-panel.insightpanelsearch
      with:
        organizationId: tools.organizationId
        configId: tools.configId
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: list-insight-panel-configurations
      description: List Insight Panel Configurations
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: customer-service-insight-panel.insightpanelconfigurationlist
      with:
        organizationId: tools.organizationId
        page: tools.page
        perPage: tools.perPage
        filter: tools.filter
        order: tools.order
      outputParameters:
      - type: object
        mapping: $.
    - name: create-insight-panel-configuration
      description: Create an Insight Panel Configuration
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: customer-service-insight-panel.insightpanelconfigurationcreate
      with:
        organizationId: tools.organizationId
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: list-insight-panel-configurations-ids
      description: List Insight Panel Configurations by Ids.
      hints:
        readOnly: true
        destructive: false
        idempotent: false
      call: customer-service-insight-panel.insightpanelconfigurationlistids
      with:
        organizationId: tools.organizationId
        page: tools.page
        perPage: tools.perPage
        filter: tools.filter
        order: tools.order
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: get-insight-configurations-project
      description: Get Insight Configurations by Project
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: customer-service-insight-panel.getinsightconfigurationsbyproject
      with:
        organizationId: tools.organizationId
        projectId: tools.projectId
        page: tools.page
        perPage: tools.perPage
        filter: tools.filter
        order: tools.order
      outputParameters:
      - type: object
        mapping: $.
    - name: get-insight-panel-configuration
      description: Get an Insight Panel Configuration
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: customer-service-insight-panel.insightpanelconfigurationget
      with:
        organizationId: tools.organizationId
        configId: tools.configId
      outputParameters:
      - type: object
        mapping: $.
    - name: update-insight-panel-configuration
      description: Update an Insight Panel Configuration
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: customer-service-insight-panel.insightpanelconfigurationupdate
      with:
        organizationId: tools.organizationId
        configId: tools.configId
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-insight-panel-configuration
      description: Delete an Insight Panel Configuration
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: customer-service-insight-panel.insightpanelconfigurationdelete
      with:
        organizationId: tools.organizationId
        configId: tools.configId
      outputParameters:
      - type: object
        mapping: $.