Coveo Search Interface Service API — Search Interface

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