Coveo Search Interface Service API — General

naftiko: 1.0.0-alpha2
info:
  label: Coveo Search Interface Service API — General
  description: 'Coveo Search Interface Service API — General. 6 operations. Lead operation: Get Search Page Interface Builder.
    Self-contained Naftiko capability covering one Coveo business surface.'
  tags:
  - Coveo
  - Search Interface Service
  - General
  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-general
    baseUri: https://platform.cloud.coveo.com
    description: Coveo Search Interface Service API — General business capability. Self-contained, no shared references.
    authentication:
      type: bearer
      token: '{{env.COVEO_SEARCH_TOKEN}}'
    resources:
    - name: rest-organizations-organizationId-searchpage-v1-interfaces-interfaceId-edit
      path: /rest/organizations/{organizationId}/searchpage/v1/interfaces/{interfaceId}/edit
      operations:
      - name: getsearchpageinterfaceedit
        method: GET
        description: Get Search Page Interface Builder
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: rest-organizations-organizationId-searchpage-v1-interfaces-interfaceId-html
      path: /rest/organizations/{organizationId}/searchpage/v1/interfaces/{interfaceId}/html
      operations:
      - name: getsearchpageinterfacehtml
        method: GET
        description: Retrieve Search Page Interface
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: rest-organizations-organizationId-searchpage-v1-interfaces-interfaceId-loader
      path: /rest/organizations/{organizationId}/searchpage/v1/interfaces/{interfaceId}/loader
      operations:
      - name: getsearchpageinterfaceloader
        method: GET
        description: Get Search Page Interface Loader
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: rest-organizations-organizationId-searchpage-v1-interfaces-interfaceId-login
      path: /rest/organizations/{organizationId}/searchpage/v1/interfaces/{interfaceId}/login
      operations:
      - name: getsearchpageinterfacelogin
        method: GET
        description: Get Search Page Interface Login
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: rest-organizations-organizationId-searchpage-v1-interfaces-interfaceId-manifest
      path: /rest/organizations/{organizationId}/searchpage/v1/interfaces/{interfaceId}/manifest
      operations:
      - name: getsearchpagemanifestv1
        method: POST
        description: Retrieve Search Page Manifest
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: rest-organizations-organizationId-searchpage-v1-interfaces-interfaceId-token
      path: /rest/organizations/{organizationId}/searchpage/v1/interfaces/{interfaceId}/token
      operations:
      - name: getsearchpageinterfacetoken
        method: GET
        description: Get Search Page Search Token
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
  exposes:
  - type: rest
    namespace: search-interface-general-rest
    port: 8080
    description: REST adapter for Coveo Search Interface Service API — General. One Spectral-compliant resource per consumed
      operation, prefixed with /v1.
    resources:
    - path: /v1/organizations/{organizationid}/searchpage/v1/interfaces/{interfaceid}/edit
      name: rest-organizations-organizationid-searchpage-v1-interfaces-interfaceid-edit
      description: REST surface for rest-organizations-organizationId-searchpage-v1-interfaces-interfaceId-edit.
      operations:
      - method: GET
        name: getsearchpageinterfaceedit
        description: Get Search Page Interface Builder
        call: search-interface-general.getsearchpageinterfaceedit
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/organizations/{organizationid}/searchpage/v1/interfaces/{interfaceid}/html
      name: rest-organizations-organizationid-searchpage-v1-interfaces-interfaceid-html
      description: REST surface for rest-organizations-organizationId-searchpage-v1-interfaces-interfaceId-html.
      operations:
      - method: GET
        name: getsearchpageinterfacehtml
        description: Retrieve Search Page Interface
        call: search-interface-general.getsearchpageinterfacehtml
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/organizations/{organizationid}/searchpage/v1/interfaces/{interfaceid}/loader
      name: rest-organizations-organizationid-searchpage-v1-interfaces-interfaceid-loader
      description: REST surface for rest-organizations-organizationId-searchpage-v1-interfaces-interfaceId-loader.
      operations:
      - method: GET
        name: getsearchpageinterfaceloader
        description: Get Search Page Interface Loader
        call: search-interface-general.getsearchpageinterfaceloader
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/organizations/{organizationid}/searchpage/v1/interfaces/{interfaceid}/login
      name: rest-organizations-organizationid-searchpage-v1-interfaces-interfaceid-login
      description: REST surface for rest-organizations-organizationId-searchpage-v1-interfaces-interfaceId-login.
      operations:
      - method: GET
        name: getsearchpageinterfacelogin
        description: Get Search Page Interface Login
        call: search-interface-general.getsearchpageinterfacelogin
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/organizations/{organizationid}/searchpage/v1/interfaces/{interfaceid}/manifest
      name: rest-organizations-organizationid-searchpage-v1-interfaces-interfaceid-manifest
      description: REST surface for rest-organizations-organizationId-searchpage-v1-interfaces-interfaceId-manifest.
      operations:
      - method: POST
        name: getsearchpagemanifestv1
        description: Retrieve Search Page Manifest
        call: search-interface-general.getsearchpagemanifestv1
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/organizations/{organizationid}/searchpage/v1/interfaces/{interfaceid}/token
      name: rest-organizations-organizationid-searchpage-v1-interfaces-interfaceid-token
      description: REST surface for rest-organizations-organizationId-searchpage-v1-interfaces-interfaceId-token.
      operations:
      - method: GET
        name: getsearchpageinterfacetoken
        description: Get Search Page Search Token
        call: search-interface-general.getsearchpageinterfacetoken
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: search-interface-general-mcp
    port: 9090
    transport: http
    description: MCP adapter for Coveo Search Interface Service API — General. One tool per consumed operation, routed inline
      through this capability's consumes block.
    tools:
    - name: get-search-page-interface-builder
      description: Get Search Page Interface Builder
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: search-interface-general.getsearchpageinterfaceedit
      outputParameters:
      - type: object
        mapping: $.
    - name: retrieve-search-page-interface
      description: Retrieve Search Page Interface
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: search-interface-general.getsearchpageinterfacehtml
      outputParameters:
      - type: object
        mapping: $.
    - name: get-search-page-interface-loader
      description: Get Search Page Interface Loader
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: search-interface-general.getsearchpageinterfaceloader
      outputParameters:
      - type: object
        mapping: $.
    - name: get-search-page-interface-login
      description: Get Search Page Interface Login
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: search-interface-general.getsearchpageinterfacelogin
      outputParameters:
      - type: object
        mapping: $.
    - name: retrieve-search-page-manifest
      description: Retrieve Search Page Manifest
      hints:
        readOnly: true
        destructive: false
        idempotent: false
      call: search-interface-general.getsearchpagemanifestv1
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: get-search-page-search-token
      description: Get Search Page Search Token
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: search-interface-general.getsearchpageinterfacetoken
      outputParameters:
      - type: object
        mapping: $.