Coveo · Capability

Coveo Search Interface Service API — Search Page Configuration

Coveo Search Interface Service API — Search Page Configuration. 14 operations. Lead operation: Get Project Search Page Interfaces. Self-contained Naftiko capability covering one Coveo business surface.

Run with Naftiko CoveoSearch Interface ServiceSearch Page Configuration

What You Can Do

GET

Getprojectsearchpageinterfaces — Get Project Search Page Interfaces

/v1/organizations/{organizationid}/searchpage/v1/projects/interfaces

GET

Getallsearchpageinterfaces — Get All Search Page Interfaces

/v1/organizations/{organizationid}/searchpage/v1/interfaces

POST

Createsearchpageinterface — Create a Search Page Interface

/v1/organizations/{organizationid}/searchpage/v1/interfaces

GET

Getsearchpageinterface — Get a Search Page Interface

/v1/organizations/{organizationid}/searchpage/v1/interfaces/{interfaceid}

PUT

Updatesearchpageinterface — Update a Search Page Interface

/v1/organizations/{organizationid}/searchpage/v1/interfaces/{interfaceid}

DELETE

Deletesearchpageinterface — Delete a Search Page Interface

/v1/organizations/{organizationid}/searchpage/v1/interfaces/{interfaceid}

POST

Requestsearchpageinterfaceaccess — Request Search Page Interface Access

/v1/organizations/{organizationid}/searchpage/v1/interfaces/{interfaceid}/access/request

GET

Getsearchpageinterfaceaccess — Get a Search Page Interface's Access Configuration

/v1/organizations/{organizationid}/searchpage/v1/interfaces/{interfaceid}/accesses

PUT

Updatesearchpageinterfaceaccess — Update a Search Page Interface's Access Configuration

/v1/organizations/{organizationid}/searchpage/v1/interfaces/{interfaceid}/accesses

GET

Getsearchpageinterfaceuseraccess — Get the List of Users with Access to the Search Page.

/v1/organizations/{organizationid}/searchpage/v1/interfaces/{interfaceid}/accesses/users

PUT

Updatesearchpageinterfaceuseraccess — Update the List of Users with Access to a Search Page.

/v1/organizations/{organizationid}/searchpage/v1/interfaces/{interfaceid}/accesses/users

POST

Addsearchpageinterfaceuseraccess — Add a Search Page Interface User Access

/v1/organizations/{organizationid}/searchpage/v1/interfaces/{interfaceid}/accesses/users

GET

Getsearchpageinterfacepipelines — Get Search Page Interface Pipelines

/v1/organizations/{organizationid}/searchpage/v1/interfaces/{interfaceid}/pipelines

POST

Previewsearchpageinterface — Preview Search Page Interface

naftiko: 1.0.0-alpha2
info:
  label: Coveo Search Interface Service API — Search Page Configuration
  description: 'Coveo Search Interface Service API — Search Page Configuration. 14 operations. Lead operation: Get Project
    Search Page Interfaces. Self-contained Naftiko capability covering one Coveo business surface.'
  tags:
  - Coveo
  - Search Interface Service
  - Search Page Configuration
  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-search-page-configuration
    baseUri: https://platform.cloud.coveo.com
    description: Coveo Search Interface Service API — Search Page Configuration business capability. Self-contained, no shared
      references.
    authentication:
      type: bearer
      token: '{{env.COVEO_SEARCH_TOKEN}}'
    resources:
    - name: organizations-organizationId-searchpage-v1-projects-interfaces
      path: /organizations/{organizationId}/searchpage/v1/projects/interfaces
      operations:
      - name: getprojectsearchpageinterfaces
        method: GET
        description: Get Project Search Page Interfaces
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: rest-organizations-organizationId-searchpage-v1-interfaces
      path: /rest/organizations/{organizationId}/searchpage/v1/interfaces
      operations:
      - name: getallsearchpageinterfaces
        method: GET
        description: Get All Search Page Interfaces
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: createsearchpageinterface
        method: POST
        description: Create a Search Page Interface
        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-searchpage-v1-interfaces-interfaceId
      path: /rest/organizations/{organizationId}/searchpage/v1/interfaces/{interfaceId}
      operations:
      - name: getsearchpageinterface
        method: GET
        description: Get a Search Page Interface
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: updatesearchpageinterface
        method: PUT
        description: Update a Search Page Interface
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: deletesearchpageinterface
        method: DELETE
        description: Delete a Search Page Interface
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: rest-organizations-organizationId-searchpage-v1-interfaces-interfaceId-access-re
      path: /rest/organizations/{organizationId}/searchpage/v1/interfaces/{interfaceId}/access/request
      operations:
      - name: requestsearchpageinterfaceaccess
        method: POST
        description: Request Search Page Interface Access
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: rest-organizations-organizationId-searchpage-v1-interfaces-interfaceId-accesses
      path: /rest/organizations/{organizationId}/searchpage/v1/interfaces/{interfaceId}/accesses
      operations:
      - name: getsearchpageinterfaceaccess
        method: GET
        description: Get a Search Page Interface's Access Configuration
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: updatesearchpageinterfaceaccess
        method: PUT
        description: Update a Search Page Interface's Access Configuration
        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-searchpage-v1-interfaces-interfaceId-accesses-
      path: /rest/organizations/{organizationId}/searchpage/v1/interfaces/{interfaceId}/accesses/users
      operations:
      - name: getsearchpageinterfaceuseraccess
        method: GET
        description: Get the List of Users with Access to the Search Page.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: updatesearchpageinterfaceuseraccess
        method: PUT
        description: Update the List of Users with Access to a Search Page.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: addsearchpageinterfaceuseraccess
        method: POST
        description: Add a Search Page Interface User Access
        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-searchpage-v1-interfaces-interfaceId-pipelines
      path: /rest/organizations/{organizationId}/searchpage/v1/interfaces/{interfaceId}/pipelines
      operations:
      - name: getsearchpageinterfacepipelines
        method: GET
        description: Get Search Page Interface Pipelines
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: rest-organizations-organizationId-searchpage-v1-interfaces-interfaceId-preview
      path: /rest/organizations/{organizationId}/searchpage/v1/interfaces/{interfaceId}/preview
      operations:
      - name: previewsearchpageinterface
        method: POST
        description: Preview Search Page Interface
        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-search-page-configuration-rest
    port: 8080
    description: REST adapter for Coveo Search Interface Service API — Search Page Configuration. One Spectral-compliant resource
      per consumed operation, prefixed with /v1.
    resources:
    - path: /v1/organizations/{organizationid}/searchpage/v1/projects/interfaces
      name: organizations-organizationid-searchpage-v1-projects-interfaces
      description: REST surface for organizations-organizationId-searchpage-v1-projects-interfaces.
      operations:
      - method: GET
        name: getprojectsearchpageinterfaces
        description: Get Project Search Page Interfaces
        call: search-interface-search-page-configuration.getprojectsearchpageinterfaces
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/organizations/{organizationid}/searchpage/v1/interfaces
      name: rest-organizations-organizationid-searchpage-v1-interfaces
      description: REST surface for rest-organizations-organizationId-searchpage-v1-interfaces.
      operations:
      - method: GET
        name: getallsearchpageinterfaces
        description: Get All Search Page Interfaces
        call: search-interface-search-page-configuration.getallsearchpageinterfaces
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createsearchpageinterface
        description: Create a Search Page Interface
        call: search-interface-search-page-configuration.createsearchpageinterface
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/organizations/{organizationid}/searchpage/v1/interfaces/{interfaceid}
      name: rest-organizations-organizationid-searchpage-v1-interfaces-interfaceid
      description: REST surface for rest-organizations-organizationId-searchpage-v1-interfaces-interfaceId.
      operations:
      - method: GET
        name: getsearchpageinterface
        description: Get a Search Page Interface
        call: search-interface-search-page-configuration.getsearchpageinterface
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: updatesearchpageinterface
        description: Update a Search Page Interface
        call: search-interface-search-page-configuration.updatesearchpageinterface
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deletesearchpageinterface
        description: Delete a Search Page Interface
        call: search-interface-search-page-configuration.deletesearchpageinterface
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/organizations/{organizationid}/searchpage/v1/interfaces/{interfaceid}/access/request
      name: rest-organizations-organizationid-searchpage-v1-interfaces-interfaceid-access-re
      description: REST surface for rest-organizations-organizationId-searchpage-v1-interfaces-interfaceId-access-re.
      operations:
      - method: POST
        name: requestsearchpageinterfaceaccess
        description: Request Search Page Interface Access
        call: search-interface-search-page-configuration.requestsearchpageinterfaceaccess
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/organizations/{organizationid}/searchpage/v1/interfaces/{interfaceid}/accesses
      name: rest-organizations-organizationid-searchpage-v1-interfaces-interfaceid-accesses
      description: REST surface for rest-organizations-organizationId-searchpage-v1-interfaces-interfaceId-accesses.
      operations:
      - method: GET
        name: getsearchpageinterfaceaccess
        description: Get a Search Page Interface's Access Configuration
        call: search-interface-search-page-configuration.getsearchpageinterfaceaccess
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: updatesearchpageinterfaceaccess
        description: Update a Search Page Interface's Access Configuration
        call: search-interface-search-page-configuration.updatesearchpageinterfaceaccess
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/organizations/{organizationid}/searchpage/v1/interfaces/{interfaceid}/accesses/users
      name: rest-organizations-organizationid-searchpage-v1-interfaces-interfaceid-accesses
      description: REST surface for rest-organizations-organizationId-searchpage-v1-interfaces-interfaceId-accesses-.
      operations:
      - method: GET
        name: getsearchpageinterfaceuseraccess
        description: Get the List of Users with Access to the Search Page.
        call: search-interface-search-page-configuration.getsearchpageinterfaceuseraccess
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: updatesearchpageinterfaceuseraccess
        description: Update the List of Users with Access to a Search Page.
        call: search-interface-search-page-configuration.updatesearchpageinterfaceuseraccess
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: addsearchpageinterfaceuseraccess
        description: Add a Search Page Interface User Access
        call: search-interface-search-page-configuration.addsearchpageinterfaceuseraccess
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/organizations/{organizationid}/searchpage/v1/interfaces/{interfaceid}/pipelines
      name: rest-organizations-organizationid-searchpage-v1-interfaces-interfaceid-pipelines
      description: REST surface for rest-organizations-organizationId-searchpage-v1-interfaces-interfaceId-pipelines.
      operations:
      - method: GET
        name: getsearchpageinterfacepipelines
        description: Get Search Page Interface Pipelines
        call: search-interface-search-page-configuration.getsearchpageinterfacepipelines
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/organizations/{organizationid}/searchpage/v1/interfaces/{interfaceid}/preview
      name: rest-organizations-organizationid-searchpage-v1-interfaces-interfaceid-preview
      description: REST surface for rest-organizations-organizationId-searchpage-v1-interfaces-interfaceId-preview.
      operations:
      - method: POST
        name: previewsearchpageinterface
        description: Preview Search Page Interface
        call: search-interface-search-page-configuration.previewsearchpageinterface
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: search-interface-search-page-configuration-mcp
    port: 9090
    transport: http
    description: MCP adapter for Coveo Search Interface Service API — Search Page Configuration. One tool per consumed operation,
      routed inline through this capability's consumes block.
    tools:
    - name: get-project-search-page-interfaces
      description: Get Project Search Page Interfaces
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: search-interface-search-page-configuration.getprojectsearchpageinterfaces
      outputParameters:
      - type: object
        mapping: $.
    - name: get-all-search-page-interfaces
      description: Get All Search Page Interfaces
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: search-interface-search-page-configuration.getallsearchpageinterfaces
      outputParameters:
      - type: object
        mapping: $.
    - name: create-search-page-interface
      description: Create a Search Page Interface
      hints:
        readOnly: true
        destructive: false
        idempotent: false
      call: search-interface-search-page-configuration.createsearchpageinterface
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: get-search-page-interface
      description: Get a Search Page Interface
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: search-interface-search-page-configuration.getsearchpageinterface
      outputParameters:
      - type: object
        mapping: $.
    - name: update-search-page-interface
      description: Update a Search Page Interface
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: search-interface-search-page-configuration.updatesearchpageinterface
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-search-page-interface
      description: Delete a Search Page Interface
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: search-interface-search-page-configuration.deletesearchpageinterface
      outputParameters:
      - type: object
        mapping: $.
    - name: request-search-page-interface-access
      description: Request Search Page Interface Access
      hints:
        readOnly: true
        destructive: false
        idempotent: false
      call: search-interface-search-page-configuration.requestsearchpageinterfaceaccess
      outputParameters:
      - type: object
        mapping: $.
    - name: get-search-page-interface-s-access
      description: Get a Search Page Interface's Access Configuration
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: search-interface-search-page-configuration.getsearchpageinterfaceaccess
      outputParameters:
      - type: object
        mapping: $.
    - name: update-search-page-interface-s-access
      description: Update a Search Page Interface's Access Configuration
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: search-interface-search-page-configuration.updatesearchpageinterfaceaccess
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: get-list-users-access-search
      description: Get the List of Users with Access to the Search Page.
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: search-interface-search-page-configuration.getsearchpageinterfaceuseraccess
      outputParameters:
      - type: object
        mapping: $.
    - name: update-list-users-access-search
      description: Update the List of Users with Access to a Search Page.
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: search-interface-search-page-configuration.updatesearchpageinterfaceuseraccess
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: add-search-page-interface-user
      description: Add a Search Page Interface User Access
      hints:
        readOnly: true
        destructive: false
        idempotent: false
      call: search-interface-search-page-configuration.addsearchpageinterfaceuseraccess
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: get-search-page-interface-pipelines
      description: Get Search Page Interface Pipelines
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: search-interface-search-page-configuration.getsearchpageinterfacepipelines
      outputParameters:
      - type: object
        mapping: $.
    - name: preview-search-page-interface
      description: Preview Search Page Interface
      hints:
        readOnly: true
        destructive: false
        idempotent: false
      call: search-interface-search-page-configuration.previewsearchpageinterface
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.