openapi: 3.0.0
info:
  title: Search Interface Service
  version: 1.0.0
  description: Documentation for Search Interface Service
  termsOfService: https://www.coveo.com/en/support/terms-agreements
  contact:
    name: support@coveo.com
tags:
- name: Configuration
- name: Search Interface
- name: IPX Configuration
- name: Insight Panel
paths:
  /rest/organizations/{organizationId}/searchinterfaces:
    get:
      operationId: get-all-interface-config
      summary: List Search Interface Configurations
      description: Lists the search interface configurations in a [Coveo organization](https://docs.coveo.com/en/185/).
      tags:
      - Configuration
      parameters:
      - $ref: '#/components/parameters/organization-id'
      - $ref: '#/components/parameters/filter'
      - $ref: '#/components/parameters/order'
      - $ref: '#/components/parameters/page'
      - $ref: '#/components/parameters/perPage'
      responses:
        '200':
          description: Ok
    post:
      operationId: create-interface-config
      summary: Create Search Interface Configuration
      description: Creates a search interface configuration in a [Coveo organization](https://docs.coveo.com/en/185/).
      tags:
      - Configuration
      parameters:
      - $ref: '#/components/parameters/organization-id'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/interface-config'
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/interface-config-id'
  /rest/organizations/{organizationId}/searchinterfaces/projects/interfaces:
    get:
      operationId: get-project-interface-config
      summary: List Search Interface Configurations in a Project
      description: Lists the search interface configurations in a [Coveo organization](https://docs.coveo.com/en/185/) and
        a [project](https://docs.coveo.com/en/n7ef0517/manage-an-organization/manage-projects).
      tags:
      - Configuration
      parameters:
      - $ref: '#/components/parameters/organization-id'
      - $ref: '#/components/parameters/filter'
      - $ref: '#/components/parameters/order'
      - $ref: '#/components/parameters/page'
      - $ref: '#/components/parameters/perPage'
      - $ref: '#/components/parameters/projectId'
      responses:
        '200':
          description: Ok
  /rest/organizations/{organizationId}/searchinterfaces/{interfaceId}:
    get:
      operationId: get-interface-config
      summary: Show Search Interface Configuration
      description: Shows a search interface configuration in a [Coveo organization](https://docs.coveo.com/en/185/).
      tags:
      - Configuration
      parameters:
      - $ref: '#/components/parameters/organization-id'
      - $ref: '#/components/parameters/interface-id'
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/interface-config-id'
        '404':
          description: Not Found
    put:
      operationId: update-interface-config
      summary: Update Search Interface Configuration
      description: Updates a search interface configuration in a [Coveo organization](https://docs.coveo.com/en/185/).
      tags:
      - Configuration
      parameters:
      - $ref: '#/components/parameters/organization-id'
      - $ref: '#/components/parameters/interface-id'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/interface-config'
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/interface-config-id'
        '404':
          description: Not Found
    delete:
      operationId: delete-interface-config
      summary: Delete Search Interface Configuration
      description: Deletes a search interface configuration in a [Coveo organization](https://docs.coveo.com/en/185/).
      tags:
      - Configuration
      parameters:
      - $ref: '#/components/parameters/organization-id'
      - $ref: '#/components/parameters/interface-id'
      responses:
        '204':
          description: No Content
        '404':
          description: Not Found
  /rest/organizations/{organizationId}/searchinterfaces/{interfaceId}/accesses:
    get:
      operationId: get-interface-access
      summary: List Search Interface Accesses
      description: Lists the accesses to a target search interface in a [Coveo organization](https://docs.coveo.com/en/185/).
      tags:
      - Configuration
      parameters:
      - $ref: '#/components/parameters/organization-id'
      - $ref: '#/components/parameters/interface-id'
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/interface-access'
        '404':
          description: Not Found
    put:
      operationId: update-interface-access
      summary: Update Search Interface Accesses
      description: Updates the accesses to a target search interface in a [Coveo organization](https://docs.coveo.com/en/185/).
      tags:
      - Configuration
      parameters:
      - $ref: '#/components/parameters/organization-id'
      - $ref: '#/components/parameters/interface-id'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/interface-access'
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/interface-access'
        '404':
          description: Not Found
  /rest/organizations/{organizationId}/searchinterfaces/{interfaceId}/accesses/users:
    get:
      operationId: get-interface-user-access
      summary: List Search Interface User Accesses
      description: Lists the accesses to a target search interface in a [Coveo organization](https://docs.coveo.com/en/185/).
      tags:
      - Configuration
      parameters:
      - $ref: '#/components/parameters/organization-id'
      - $ref: '#/components/parameters/interface-id'
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/interface-user-list'
        '404':
          description: Not Found
    put:
      operationId: update-interface-user-access
      summary: Update Search Interface User Accesses
      description: Updates the accesses to a target search interface in a [Coveo organization](https://docs.coveo.com/en/185/).
      tags:
      - Configuration
      parameters:
      - $ref: '#/components/parameters/organization-id'
      - $ref: '#/components/parameters/interface-id'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/interface-user-list'
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/interface-user-list'
        '404':
          description: Not Found
    post:
      operationId: add-interface-user-access
      summary: Add Search Interface User Accesses
      description: Adds user accesses to a target search interface in a [Coveo organization](https://docs.coveo.com/en/185/).
      tags:
      - Configuration
      parameters:
      - $ref: '#/components/parameters/organization-id'
      - $ref: '#/components/parameters/interface-id'
      - $ref: '#/components/parameters/notify'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/interface-add-user'
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/interface-user-list'
        '404':
          description: Not Found
  /rest/organizations/{organizationId}/searchinterfaces/{interfaceId}/html:
    get:
      operationId: get-interface-html
      summary: Retrieve Search Interface
      description: Retrieves a search interface in HTML page format from a [Coveo organization](https://docs.coveo.com/en/185/).
      tags:
      - Search Interface
      parameters:
      - $ref: '#/components/parameters/organization-id'
      - $ref: '#/components/parameters/interface-id'
      responses:
        '200':
          description: Ok
          content:
            text/html:
              encoding:
                text/html:
                  contentType: text/html
      security:
      - {}
  /rest/organizations/{organizationId}/searchinterfaces/{interfaceId}/manifest/v1:
    post:
      operationId: post-manifest
      summary: Retrieve Search Interface Manifest
      description: Retrieves a search interface manifest with detailed information from a [Coveo organization](https://docs.coveo.com/en/185/).
      tags:
      - Search Interface
      parameters:
      - $ref: '#/components/parameters/organization-id'
      - $ref: '#/components/parameters/interface-id'
      requestBody:
        required: false
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/interface-manifest-request'
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/interface-manifest'
        '404':
          description: Not Found
      security:
      - {}
  /rest/organizations/{organizationId}/hostedpages:
    get:
      operationId: get-all-hostedpages
      summary: List Hosted Pages
      description: Lists the hosted pages in a [Coveo organization](https://docs.coveo.com/en/185/).
      tags:
      - Hosted Page
      parameters:
      - $ref: '#/components/parameters/organization-id'
      - $ref: '#/components/parameters/filter'
      - $ref: '#/components/parameters/order'
      - $ref: '#/components/parameters/page'
      - $ref: '#/components/parameters/perPage'
      responses:
        '200':
          description: Ok
    post:
      operationId: create-hostedpage
      summary: Create Hosted Page
      description: Creates a hosted page in a [Coveo organization](https://docs.coveo.com/en/185/).
      tags:
      - Hosted Page
      parameters:
      - $ref: '#/components/parameters/organization-id'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/hostedpage'
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/hostedpage-id'
  /rest/organizations/{organizationId}/hostedpages/projects/pages:
    get:
      operationId: get-project-hostedpages
      summary: List Hosted Pages in a Project
      description: Lists the hosted pages in a [Coveo organization](https://docs.coveo.com/en/185/) and a [project](https://docs.coveo.com/en/n7ef0517/manage-an-organization/manage-projects).
      tags:
      - Hosted Page
      parameters:
      - $ref: '#/components/parameters/organization-id'
      - $ref: '#/components/parameters/filter'
      - $ref: '#/components/parameters/order'
      - $ref: '#/components/parameters/page'
      - $ref: '#/components/parameters/perPage'
      - $ref: '#/components/parameters/projectId'
      responses:
        '200':
          description: Ok
  /rest/organizations/{organizationId}/hostedpages/{pageId}:
    get:
      operationId: get-hostedpage
      summary: Retrieve Hosted Page Configuration
      description: Retrieves a hosted page configuration in a [Coveo organization](https://docs.coveo.com/en/185/).
      tags:
      - Hosted Page
      parameters:
      - $ref: '#/components/parameters/organization-id'
      - $ref: '#/components/parameters/page-id'
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/hostedpage-id'
        '404':
          description: Not Found
    put:
      operationId: update-hostedpage
      summary: Update Hosted Page
      description: Updates an hosted page in a [Coveo organization](https://docs.coveo.com/en/185/).
      tags:
      - Hosted Page
      parameters:
      - $ref: '#/components/parameters/organization-id'
      - $ref: '#/components/parameters/page-id'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/hostedpage'
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/hostedpage-id'
        '404':
          description: Not Found
    delete:
      operationId: delete-hostedpage
      summary: Delete Hosted Page
      description: Deletes an hosted page in a [Coveo organization](https://docs.coveo.com/en/185/).
      tags:
      - Hosted Page
      parameters:
      - $ref: '#/components/parameters/organization-id'
      - $ref: '#/components/parameters/page-id'
      responses:
        '204':
          description: No Content
        '404':
          description: Not Found
  /rest/organizations/{organizationId}/hostedpages/{pageId}/html/v1:
    get:
      operationId: get-hostedpage-html
      summary: Show Hosted Page
      description: Shows a hosted page in a [Coveo organization](https://docs.coveo.com/en/185/).
      tags:
      - Hosted Page
      parameters:
      - $ref: '#/components/parameters/organization-id'
      - $ref: '#/components/parameters/page-id'
      responses:
        '200':
          description: Ok
          content:
            text/html:
              encoding:
                text/html:
                  contentType: text/html
  /rest/organizations/{organizationId}/ipxinterface/v1/interfaces:
    get:
      operationId: get-all-ipx-interface-configs
      summary: List All IPX Interface Configurations
      description: Lists the IPX interface configurations in a [Coveo organization](https://docs.coveo.com/en/185/).
      tags:
      - IPX Configuration
      parameters:
      - $ref: '#/components/parameters/organization-id'
      - $ref: '#/components/parameters/filter'
      - $ref: '#/components/parameters/order'
      - $ref: '#/components/parameters/page'
      - $ref: '#/components/parameters/perPage'
      responses:
        '200':
          description: Ok
    post:
      operationId: create-ipx-interface-config
      summary: Create IPX Interface Configuration
      description: Create an IPX interface configuration in a [Coveo organization](https://docs.coveo.com/en/185/).
      tags:
      - IPX Configuration
      parameters:
      - $ref: '#/components/parameters/organization-id'
      - in: query
        name: createPipelines
        description: If true, pipelines, conditions and models will be created for the IPX interface.
        schema:
          type: boolean
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ipx-interface-config'
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ipx-interface-config-id'
  /rest/organizations/{organizationId}/ipxinterface/v1/projects/interfaces:
    get:
      operationId: get-project-ipx-interface-configs
      summary: List IPX Interface Configurations in Project
      description: Lists the IPX interface configurations in a [Coveo organization](https://docs.coveo.com/en/185/) and a
        [project](https://docs.coveo.com/en/n7ef0517/manage-an-organization/manage-projects).
      tags:
      - IPX Configuration
      parameters:
      - $ref: '#/components/parameters/organization-id'
      - $ref: '#/components/parameters/filter'
      - $ref: '#/components/parameters/order'
      - $ref: '#/components/parameters/page'
      - $ref: '#/components/parameters/perPage'
      - $ref: '#/components/parameters/projectId'
      responses:
        '200':
          description: Ok
  /rest/organizations/{organizationId}/ipxinterface/v1/interfaces/{interfaceId}:
    get:
      operationId: get-ipx-interface-config
      summary: Show IPX Interface Configuration
      description: Shows an IPX interface configuration in a [Coveo organization](https://docs.coveo.com/en/185/).
      tags:
      - IPX Configuration
      parameters:
      - $ref: '#/components/parameters/organization-id'
      - $ref: '#/components/parameters/interface-id'
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ipx-interface-config-id'
        '404':
          description: Not Found
    put:
      operationId: update-ipx-interface-config
      summary: Update IPX Interface Configuration
      description: Updates an IPX interface configuration in a [Coveo organization](https://docs.coveo.com/en/185/).
      tags:
      - IPX Configuration
      parameters:
      - $ref: '#/components/parameters/organization-id'
      - $ref: '#/components/parameters/interface-id'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ipx-interface-config'
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ipx-interface-config-id'
        '404':
          description: Not Found
    delete:
      operationId: delete-ipx-interface-config
      summary: Delete IPX Interface Configuration
      description: Deletes an IPX interface configuration in a [Coveo organization](https://docs.coveo.com/en/185/).
      tags:
      - IPX Configuration
      parameters:
      - $ref: '#/components/parameters/organization-id'
      - $ref: '#/components/parameters/interface-id'
      responses:
        '204':
          description: No Content
        '404':
          description: Not Found
  /rest/organizations/{organizationId}/ipxinterface/v1/interfaces/{interfaceId}/versions:
    get:
      operationId: get-ipx-interface-versions
      summary: Get Versions for an IPX Interface
      description: Get a list of versions of the [IPX](https://docs.coveo.com/en/n47d1000/) interface of a [Coveo organization](https://docs.coveo.com/en/185/).
      tags:
      - IPX Configuration
      parameters:
      - $ref: '#/components/parameters/organization-id'
      - $ref: '#/components/parameters/interface-id'
      - $ref: '#/components/parameters/versions-page'
      - $ref: '#/components/parameters/versions-per-page'
      - $ref: '#/components/parameters/versions-filter'
      - $ref: '#/components/parameters/versions-order'
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InterfaceVersionInfoPage'
  /rest/organizations/{organizationId}/ipxinterface/v1/interfaces/{interfaceId}/versions/{versionNumber}:
    get:
      operationId: get-ipx-interface-version
      summary: Get an IPX Interface Version
      description: Get information about a specific version of an [IPX](https://docs.coveo.com/en/n47d1000/) interface.
      tags:
      - IPX Configuration
      parameters:
      - $ref: '#/components/parameters/organization-id'
      - $ref: '#/components/parameters/interface-id'
      - $ref: '#/components/parameters/version-number'
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                $ref: '#components/schemas/IpxInterfaceVersionInfo'
  /rest/organizations/{organizationId}/ipxinterface/v1/interfaces/{interfaceId}/versions/{versionNumber}/restore:
    post:
      operationId: restore-ipx-interface-version
      summary: Restore an IPX Interface Version
      description: Restore the current [IPX](https://docs.coveo.com/en/n47d1000/) interface to a specific version.
      tags:
      - IPX Configuration
      parameters:
      - $ref: '#/components/parameters/organization-id'
      - $ref: '#/components/parameters/interface-id'
      - $ref: '#/components/parameters/version-number'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/VersionLabelParams'
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ipx-interface-config-id'
  /rest/organizations/{organizationId}/ipxinterface/v1/interfaces/{interfaceId}/versions/{versionNumber}/label:
    put:
      operationId: update-ipx-interface-version-label
      summary: Update an IPX Interface Version Label
      description: Update the label for a specific [IPX](https://docs.coveo.com/en/n47d1000/) interface version.
      tags:
      - IPX Configuration
      parameters:
      - $ref: '#/components/parameters/organization-id'
      - $ref: '#/components/parameters/interface-id'
      - $ref: '#/components/parameters/version-number'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/VersionLabelParams'
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InterfaceVersionInfo'
  /rest/organizations/{organizationId}/ipxinterface/v1/interfaces/{interfaceId}/loader:
    get:
      operationId: get-ipx-interface-loader
      summary: Show an IPX Interface Loader
      description: Shows an IPX interface loader in a [Coveo organization](https://docs.coveo.com/en/185/).
      tags:
      - IPX loader
      parameters:
      - $ref: '#/components/parameters/organization-id'
      - $ref: '#/components/parameters/interface-id'
      responses:
        '200':
          description: Ok
        '404':
          description: Not Found
  /rest/organizations/{organizationId}/ipxinterface/v1/interfaces/{interfaceId}/preview:
    post:
      operationId: preview-ipx-interface
      summary: Preview IPX Interface
      description: Generate the markup of an IPX interface in a [Coveo organization](https://docs.coveo.com/en/185/).
      tags:
      - IPX Configuration
      parameters:
      - $ref: '#/components/parameters/organization-id'
      - $ref: '#/components/parameters/interface-id'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ipx-interface-config-id'
      responses:
        '200':
          description: Ok
          content:
            text/html:
              schema:
                type: string
                example: <atomic-search-interface></atomic-search-interface>
        '404':
          description: Not Found
        '401':
          description: Unauthorized
  /rest/organizations/{organizationId}/ipxinterface/v1/interfaces/{interfaceId}/edit:
    get:
      operationId: get-ipx-interface-edit
      summary: Get IPX Interface Builder
      description: Get the builder for an IPX interface in a [Coveo organization](https://docs.coveo.com/en/185/).
      tags:
      - IPX Configuration
      parameters:
      - $ref: '#/components/parameters/organization-id'
      - $ref: '#/components/parameters/interface-id'
      responses:
        '200':
          description: Ok
          content:
            text/html:
              schema:
                type: string
        '404':
          description: Not Found
  /rest/organizations/{organizationId}/ipxinterface/v1/interfaces/{interfaceId}/login:
    get:
      operationId: get-ipx-interface-login
      summary: Get IPX Interface Login
      description: Get the login page for an IPX interface in a [Coveo organization](https://docs.coveo.com/en/185/).
      tags:
      - IPX Configuration
      parameters:
      - $ref: '#/components/parameters/organization-id'
      responses:
        '200':
          description: Ok
          content:
            text/html:
              schema:
                type: string
        '404':
          description: Not Found
  /rest/organizations/{organizationId}/ipxinterface/v1/interfaces/{interfaceId}/token:
    get:
      operationId: get-ipx-interface-token
      summary: Get IPX Interface Search Token
      description: Get the search token for an IPX interface in a [Coveo organization](https://docs.coveo.com/en/185/).
      tags:
      - IPX Configuration
      parameters:
      - $ref: '#/components/parameters/organization-id'
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                properties:
                  token:
                    type: string
        '404':
          description: Not Found
  /rest/organizations/{organizationId}/ipxinterface/v1/interfaces/{interfaceId}/pipelines:
    get:
      operationId: get-ipx-interface-pipelines
      summary: Get IPX Interface Pipelines
      description: Get the pipelines used by an IPX interface in a [Coveo organization](https://docs.coveo.com/en/185/) in
        the builder context.
      tags:
      - IPX Configuration
      parameters:
      - $ref: '#/components/parameters/organization-id'
      - $ref: '#/components/parameters/interface-id'
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/pipelines-status'
        '404':
          description: Not Found
  /rest/organizations/{organizationId}/searchpage/v1/interfaces:
    get:
      operationId: get-all-search-page-interfaces
      summary: Get All Search Page Interfaces
      description: Get all search page interfaces in a [Coveo organization](https://docs.coveo.com/en/185/).
      tags:
      - Search Page Configuration
      parameters:
      - $ref: '#/components/parameters/organization-id'
      - $ref: '#/components/parameters/filter'
      - $ref: '#/components/parameters/order'
      - $ref: '#/components/parameters/page'
      - $ref: '#/components/parameters/perPage'
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/search-page-interface-config-id'
    post:
      operationId: create-search-page-interface
      summary: Create a Search Page Interface
      description: Create a search page interface in a [Coveo organization](https://docs.coveo.com/en/185/).
      tags:
      - Search Page Configuration
      parameters:
      - $ref: '#/components/parameters/organization-id'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/search-page-interface-config'
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/search-page-interface-config-id'
  /organizations/{organizationId}/searchpage/v1/projects/interfaces:
    get:
      operationId: get-project-search-page-interfaces
      summary: Get Project Search Page Interfaces
      description: Get all search page interfaces in a [Coveo organization](https://docs.coveo.com/en/185/) and a [project](https://docs.coveo.com/en/n7ef0517/manage-an-organization/manage-projects).
      tags:
      - Search Page Configuration
      parameters:
      - $ref: '#/components/parameters/organization-id'
      - $ref: '#/components/parameters/filter'
      - $ref: '#/components/parameters/order'
      - $ref: '#/components/parameters/page'
      - $ref: '#/components/parameters/perPage'
      - $ref: '#/components/parameters/projectId'
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/search-page-interface-config-project'
  /rest/organizations/{organizationId}/searchpage/v1/interfaces/{interfaceId}:
    get:
      operationId: get-search-page-interface
      summary: Get a Search Page Interface
      description: Get a search page interface in a [Coveo organization](https://docs.coveo.com/en/185/).
      tags:
      - Search Page Configuration
      parameters:
      - $ref: '#/components/parameters/organization-id'
      - $ref: '#/components/parameters/interface-id'
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/search-page-interface-config-id'
        '404':
          description: Not Found
    put:
      operationId: update-search-page-interface
      summary: Update a Search Page Interface
      description: Update a search page interface in a [Coveo organization](https://docs.coveo.com/en/185/).
      tags:
      - Search Page Configuration
      parameters:
      - $ref: '#/components/parameters/organization-id'
      - $ref: '#/components/parameters/interface-id'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/search-page-interface-config'
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/search-page-interface-config-id'
        '404':
          description: Not Found
    delete:
      operationId: delete-search-page-interface
      summary: Delete a Search Page Interface
      description: Delete a search page interface in a [Coveo organization](https://docs.coveo.com/en/185/).
      tags:
      - Search Page Configuration
      parameters:
      - $ref: '#/components/parameters/organization-id'
      - $ref: '#/components/parameters/interface-id'
      responses:
        '204':
          description: No Content
        '404':
          description: Not Found
  /rest/organizations/{organizationId}/searchpage/v1/interfaces/{interfaceId}/accesses:
    get:
      operationId: get-search-page-interface-access
      summary: Get a Search Page Interface's Access Configuration
      description: Get a search page interface access in a [Coveo organization](https://docs.coveo.com/en/185/).
      tags:
      - Search Page Configuration
      parameters:
      - $ref: '#/components/parameters/organization-id'
      - $ref: '#/components/parameters/interface-id'
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/interface-access'
        '404':
          description: Not Found
    put:
      operationId: update-search-page-interface-access
      summary: Update a Search Page Interface's Access Configuration
      description: Update a search page interface access in a [Coveo organization](https://docs.coveo.com/en/185/).
      tags:
      - Search Page Configuration
      parameters:
      - $ref: '#/components/parameters/organization-id'
      - $ref: '#/components/parameters/interface-id'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/search-page-interface-access'
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/search-page-interface-access'
        '404':
          description: Not Found
  /rest/organizations/{organizationId}/searchpage/v1/interfaces/{interfaceId}/accesses/users:
    get:
      operationId: get-search-page-interface-user-access
      summary: Get the List of Users with Access to the Search Page.
      description: Get a user with access to a given search page interface in a [Coveo organization](https://docs.coveo.com/en/185/).
      tags:
      - Search Page Configuration
      parameters:
      - $ref: '#/components/parameters/organization-id'
      - $ref: '#/components/parameters/interface-id'
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                type: array
                items:
                  type: string
        '404':
          description: Not Found
    put:
      operationId: update-search-page-interface-user-access
      summary: Update the List of Users with Access to a Search Page.
      description: Set list of users with access to a given search page interface in a [Coveo organization](https://docs.coveo.com/en/185/).
      tags:
      - Search Page Configuration
      parameters:
      - $ref: '#/components/parameters/organization-id'
      - $ref: '#/components/parameters/interface-id'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: array
              items:
                type: string
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/search-page-interface-config-id'
        '404':
          description: Not Found
    post:
      operationId: add-search-page-interface-user-access
      summary: Add a Search Page Interface User Access
      description: Add users to list of users with access to given search page in a [Coveo organization](https://docs.coveo.com/en/185/).
      tags:
      - Search Page Configuration
      parameters:
      - $ref: '#/components/parameters/organization-id'
      - $ref: '#/components/parameters/interface-id'
      - $ref: '#/components/parameters/notify'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/interface-add-user'
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/search-page-interface-config-id'
  /rest/organizations/{organizationId}/searchpage/v1/interfaces/{interfaceId}/access/request:
    post:
      operationId: request-search-page-interface-access
      summary: Request Search Page Interface Access
      description: Request access to a search page interface in a [Coveo organization](https://docs.coveo.com/en/185/).
      tags:
      - Search Page Configuration
      parameters:
      - $ref: '#/components/parameters/organization-id'
      - $ref: '#/components/parameters/interface-id'
      responses:
        '204':
          description: No Content
        '400':
          description: Bad Request
        '404':
          description: Not Found
  /rest/organizations/{organizationId}/searchpage/v1/interfaces/{interfaceId}/preview:
    post:
      operationId: preview-search-page-interface
      summary: Preview Search Page Interface
      description: Generate the markup of a search page interface in a [Coveo organization](https://docs.coveo.com/en/185/).
      tags:
      - Search Page Configuration
      parameters:
      - $ref: '#/components/parameters/organization-id'
      - $ref: '#/components/parameters/interface-id'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/search-page-interface-config-id'
      responses:
        '200':
          description: Ok
          content:
            text/html:
              schema:
                type: string
                example: <atomic-search-interface></atomic-search-interface>
        '404':
          description: Not Found
        '401':
          description: Unauthorized
  /rest/organizations/{organizationId}/searchpage/v1/interfaces/{interfaceId}/html:
    get:
      operationId: get-search-page-interface-html
      summary: Retrieve Search Page Interface
      description: Retrieve a search page interface in HTML page format from a [Coveo organization](https://docs.coveo.com/en/185/).
      parameters:
      - $ref: '#/components/parameters/organization-id'
      - $ref: '#/components/parameters/interface-id'
      responses:
        '200':
          description: Ok
          content:
            text/html:
              schema:
                type: string
                example: <atomic-search-interface></atomic-search-interface>
        '404':
          description: Not Found
  /rest/organizations/{organizationId}/searchpage/v1/interfaces/{interfaceId}/manifest:
    post:
      operationId: get-search-page-manifest-v1
      summary: Retrieve Search Page Manifest
      description: Retrieves a search page manifest with detailed information from a [Coveo Cloud organization](https://docs.coveo.com/en/185/).
      parameters:
      - $ref: '#/components/parameters/organization-id'
      - $ref: '#/components/parameters/interface-id'
      requestBody:
        required: false
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/interface-manifest-request'
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/interface-manifest'
        '404':
          description: Not Found
  /rest/organizations/{organizationId}/searchpage/v1/interfaces/{interfaceId}/token:
    get:
      operationId: get-search-page-interface-token
      summary: Get Search Page Search Token
      description: Get the search token for a search page interface in a [Coveo organization](https://docs.coveo.com/en/185/).
      parameters:
      - $ref: '#/components/parameters/organization-id'
      - $ref: '#/components/parameters/interface-id'
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                properties:
                  token:
                    type: string
  /rest/organizations/{organizationId}/searchpage/v1/interfaces/{interfaceId}/edit:
    get:
      operationId: get-search-page-interface-edit
      summary: Get Search Page Interface Builder
      description: Get the builder for a search page in a [Coveo organization](https://docs.coveo.com/en/185/).
      parameters:
      - $ref: '#/components/parameters/organization-id'
      - $ref: '#/components/parameters/interface-id'
      responses:
        '200':
          description: Ok
          content:
            text/html:
              schema:
                type: string
  /rest/organizations/{organizationId}/searchpage/v1/interfaces/{interfaceId}/loader:
    get:
      operationId: get-search-page-interface-loader
      summary: Get Search Page Interface Loader
      description: Get the loader for a search page in a [Coveo organization](https://docs.coveo.com/en/185/).
      parameters:
      - $ref: '#/components/parameters/organization-id'
      - $ref: '#/components/parameters/interface-id'
      responses:
        '200':
          description: Ok
          content:
            text/html:
              schema:
                type: string
        '404':
          description: Not Found
  /rest/organizations/{organizationId}/searchpage/v1/interfaces/{interfaceId}/login:
    get:
      operationId: get-search-page-interface-login
      summary: Get Search Page Interface Login
      description: Get the login page for a search page in a [Coveo organization](https://docs.coveo.com/en/185/).
      parameters:
      - $ref: '#/components/parameters/organization-id'
      responses:
        '200':
          description: Ok
          content:
            text/html:
              schema:
                type: string
        '404':
          description: Not Found
  /rest/organizations/{organizationId}/searchpage/v1/interfaces/{interfaceId}/pipelines:
    get:
      operationId: get-search-page-interface-pipelines
      summary: Get Search Page Interface Pipelines
      description: Get the pipelines used by a search page in a [Coveo organization](https://docs.coveo.com/en/185/) in the
        builder context.
      tags:
      - Search Page Configuration
      parameters:
      - $ref: '#/components/parameters/organization-id'
      - $ref: '#/components/parameters/interface-id'
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/pipelines-status'
        '404':
          description: Not Found
  /rest/organizations/{organizationId}/insightinterface/v1/interfaces:
    post:
      operationId: create-insight-panel-interface
      summary: Create an Insight Panel Interface
      description: Create an [Insight Panel](https://docs.coveo.com/en/m7ak9250/) interface in a [Coveo organization](https://docs.coveo.com/en/185/).
      tags:
      - Insight Panel
      parameters:
      - $ref: '#/components/parameters/organization-id'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/InsightPanelBodyParams'
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InsightPanelInterface'
    get:
      operationId: get-all-insight-panel-interfaces
      summary: Get All Insight Panel Interfaces
      description: Get all [Insight Panel](https://docs.coveo.com/en/m7ak9250/) interfaces in a [Coveo organization](https://docs.coveo.com/en/185/).
      tags:
      - Insight Panel
      parameters:
      - $ref: '#/components/parameters/organization-id'
      - $ref: '#/components/parameters/filter'
      - $ref: '#/components/parameters/page'
      - $ref: '#/components/parameters/perPage'
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/InsightPanelInterface'
  /rest/organizations/{organizationId}/insightinterface/v1/interfaces/{interfaceId}:
    get:
      operationId: get-insight-panel-interface
      summary: Get an Insight Panel Interface
      description: Get an [Insight Panel](https://docs.coveo.com/en/m7ak9250/) interface in a [Coveo organization](https://docs.coveo.com/en/185/).
      tags:
      - Insight Panel
      parameters:
      - $ref: '#/components/parameters/organization-id'
      - $ref: '#/components/parameters/insight-panel-interface-id'
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InsightPanelInterface'
    put:
      operationId: update-insight-panel-interface
      summary: Update an Insight Panel Interface
      description: Update an [Insight Panel](https://docs.coveo.com/en/m7ak9250/) interface in a [Coveo organization](https://docs.coveo.com/en/185/).
      tags:
      - Insight Panel
      parameters:
      - $ref: '#/components/parameters/organization-id'
      - $ref: '#/components/parameters/insight-panel-interface-id'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/InsightPanelBodyParams'
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InsightPanelInterface'
    delete:
      operationId: delete-insight-panel-interface
      summary: Delete an Insight Panel Interface
      description: Delete an [Insight Panel](https://docs.coveo.com/en/m7ak9250/) interface in a [Coveo organization](https://docs.coveo.com/en/185/).
      tags:
      - Insight Panel
      parameters:
      - $ref: '#/components/parameters/organization-id'
      - $ref: '#/components/parameters/insight-panel-interface-id'
      responses:
        '204':
          description: NoContent
  /rest/organizations/{organizationId}/insightinterface/v1/interfaces/{interfaceId}/versions:
    get:
      operationId: get-insight-panel-interface-versions
      summary: Get Versions for an Insight Panel Interface
      description: Get a list of versions of the [Insight Panel](https://docs.coveo.com/en/m7ak9250/) interface of a [Coveo
        organization](https://docs.coveo.com/en/185/).
      tags:
      - Insight Panel
      parameters:
      - $ref: '#/components/parameters/organization-id'
      - $ref: '#/components/parameters/insight-panel-interface-id'
      - $ref: '#/components/parameters/versions-page'
      - $ref: '#/components/parameters/versions-per-page'
      - $ref: '#/components/parameters/versions-filter'
      - $ref: '#/components/parameters/versions-order'
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InterfaceVersionInfoPage'
  /rest/organizations/{organizationId}/insightinterface/v1/interfaces/{interfaceId}/versions/{versionNumber}:
    get:
      operationId: get-insight-panel-interface-version
      summary: Get an Insight Panel Interface Version
      description: Get information about a specific version of an [Insight Panel](https://docs.coveo.com/en/m7ak9250/) interface.
      tags:
      - Insight Panel
      parameters:
      - $ref: '#/components/parameters/organization-id'
      - $ref: '#/components/parameters/insight-panel-interface-id'
      - $ref: '#/components/parameters/version-number'
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                $ref: '#components/schemas/InsightInterfaceVersionInfo'
  /rest/organizations/{organizationId}/insightinterface/v1/interfaces/{interfaceId}/versions/{versionNumber}/restore:
    post:
      operationId: restore-insight-panel-interface-version
      summary: Restore an Insight Panel Interface Version
      description: Restore the current [Insight Panel](https://docs.coveo.com/en/m7ak9250/) interface to a specific version.
      tags:
      - Insight Panel
      parameters:
      - $ref: '#/components/parameters/organization-id'
      - $ref: '#/components/parameters/insight-panel-interface-id'
      - $ref: '#/components/parameters/version-number'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/VersionLabelParams'
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InsightPanelInterface'
  /rest/organizations/{organizationId}/insightinterface/v1/interfaces/{interfaceId}/versions/{versionNumber}/label:
    put:
      operationId: update-insight-panel-interface-version-label
      summary: Update an Insight Panel Interface Version Label
      description: Update the label for a specific [Insight Panel](https://docs.coveo.com/en/m7ak9250/) interface version.
      tags:
      - Insight Panel
      parameters:
      - $ref: '#/components/parameters/organization-id'
      - $ref: '#/components/parameters/insight-panel-interface-id'
      - $ref: '#/components/parameters/version-number'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/VersionLabelParams'
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InterfaceVersionInfo'
components:
  schemas:
    interface-config-id:
      type: object
      properties:
        id:
          type: string
          description: The unique identifier of the search interface configuration.
          example: 123e4567-e89b-12d3-a456-426614174000
        name:
          type: string
          description: A short descriptive name to help manage search pages.
          example: ExStore
        facets:
          type: array
          description: The list of facets to display in the search interface.
          items:
            properties:
              field:
                type: string
                description: The [field](https://docs.coveo.com/en/200) on which the facet is based.
              label:
                type: string
                description: The label of the facet.
          example:
          - field: source
            label: Source
          - field: objecttype
            label: Object Type
        sortCriteria:
          type: array
          description: The array of sort criteria the end user can select when interacting with the search interface.
          items:
            properties:
              by:
                type: string
                description: 'The kind of sort criterion. Required. <br />**Allowed values:**<br />- `relevancy`<br />- `date`<br
                  />- `field`: sort based on the values of a target field, which you need to specify in the `field` parameter.'
                enum:
                - relevancy
                - date
                - field
              label:
                type: string
                description: The label of the sort criterion. Required.
              field:
                type: string
                description: The [field](https://docs.coveo.com/en/200) on which the sort is based. Required when `by` value
                  is `field`, and ignored otherwise.<br />Must be [sortable in the index](https://docs.coveo.com/en/1833/index-content/add-or-edit-a-field#sortable).
              order:
                type: string
                enum:
                - ASC
                - DESC
                description: 'The sort direction, if applicable.<br />Default behaviour is a follows:<br />- If the `by` value
                  is `relevancy`, this parameter does not apply.<br />- If the `by` value is `date`, the default value is
                  `DESC`.<br />- If the `by` value is anything else, the default value is `ASC`.<br />**Allowed values:**
                  <br />- `ASC`: ascending <br>- `DESC`: descending'
            required:
            - by
            - label
          example:
          - by: relevancy
            label: Relevance
          - by: date
            label: Date
            order: DESC
          - by: field
            label: Price
            field: price
            order: ASC
        accesses:
          $ref: '#/components/schemas/interface-access'
        content:
          $ref: '#/components/schemas/interface-pipeline-content'
        created:
          type: string
          format: date-time
          description: The creation timestamp. (ISO 8601)
          example: '2021-12-31T12:46:00.000Z'
        createdBy:
          type: string
          description: The creator principal.
          example: jdoe@gmail.com-google
        updated:
          type: string
          format: date-time
          description: The last update timestamp. (ISO 8601)
          example: '2001-12-31T13:03:00.000Z'
        updatedBy:
          type: string
          description: The last updater principal.
          example: jdoe@gmail.com-google
      required:
      - id
      - name
    interface-config:
      type: object
      properties:
        name:
          type: string
          description: A short descriptive name to help manage search pages.
          example: ExStore
        title:
          type: string
          description: The title of the search interface configuration. Will be displayed as the HTML page title.
          example: My example store search page
        facets:
          type: array
          description: The list of facets to display in the search interface.
          items:
            properties:
              field:
                type: string
                description: The [field](https://docs.coveo.com/en/200) on which the facet is based.
              label:
                type: string
                description: The label of the facet.
          example:
          - field: source
            label: Source
          - field: objecttype
            label: Object Type
        sortCriteria:
          type: array
          description: The array of sort criteria the end user can select when interacting with the search interface.
          items:
            properties:
              by:
                type: string
                description: 'The kind of sort criterion. Required. <br />**Allowed values:**<br />- `relevancy`<br />- `date`<br
                  />- `field`: sort based on the values of a target field, which you need to specify in the `field` parameter.'
                enum:
                - relevancy
                - date
                - field
              label:
                type: string
                description: The label of the sort criterion. Required.
              field:
                type: string
                description: The [field](https://docs.coveo.com/en/200) on which the sort is based. Required when `by` value
                  is `field`, and ignored otherwise.<br />Must be [sortable in the index](https://docs.coveo.com/en/1833/index-content/add-or-edit-a-field#sortable).
              order:
                type: string
                enum:
                - ASC
                - DESC
                description: 'The sort direction, if applicable.<br />Default behaviour is a follows:<br />- If the `by` value
                  is `relevancy`, this parameter does not apply.<br />- If the `by` value is `date`, the default value is
                  `DESC`.<br />- If the `by` value is anything else, the default value is `ASC`.<br />**Allowed values:**
                  <br />- `ASC`: ascending <br>- `DESC`: descending'
            required:
            - by
            - label
          example:
          - by: relevancy
            label: Relevance
          - by: date
            label: Date
            order: DESC
          - by: field
            label: Price
            field: price
            order: ASC
        accesses:
          $ref: '#/components/schemas/interface-access'
        content:
          $ref: '#/components/schemas/interface-content'
        layout:
          type: string
          enum:
          - LIST
          - GRID
      required:
      - name
    interface-content:
      type: object
      properties:
        pipeline:
          type: string
          description: The unique identifier of the query pipeline enforced in search requests.
          example: 8652e601-fdc3-4ec9-90f8-510763ec0956
        sources:
          type: array
          description: The list of sources with which to filter items in search requests. Only items from target sources may
            be returned.
          example:
          - sourceNameA
          - sourceNameB
          items:
            type: string
    interface-pipeline-content:
      type: object
      properties:
        pipeline:
          type: string
          description: The unique identifier of the query pipeline enforced in search requests.
          example: 8652e601-fdc3-4ec9-90f8-510763ec0956
    interface-access:
      type: object
      properties:
        users:
          $ref: '#/components/schemas/interface-user-list'
        domains:
          type: array
          description: The list of domains that are allowed to access the search interface.
          example:
          - example.com
          - sample.com
          items:
            type: string
        sharingLinkEnabled:
          type: boolean
          example: true
        sharingDomainEnabled:
          type: boolean
          example: true
    interface-user-list:
      type: array
      description: The list of users that are allowed to access the search interface.
      example:
      - alice@example.com
      - bob@example.com
      items:
        type: string
    interface-add-user:
      type: object
      properties:
        users:
          $ref: '#/components/schemas/interface-user-list'
        message:
          type: string
          description: Message to send as part of email notifications, when `notify` is set to `true`.
          example: Hey, check out this new search page
          required: false
    interface-access-request:
      type: object
      properties:
        user:
          type: string
          example: jdoe@gmail.com
    interface-manifest-request:
      type: object
      properties:
        pagePlaceholders:
          type: object
          description: The placeholders for the page.
          properties:
            results:
              type: string
              description: A placeholder for the result list and result templates.
              example: --results--
    interface-manifest:
      type: object
      properties:
        markup:
          type: string
          description: The HTML markup of the search interface along with configured placeholders.
          example: <atomic-search-interface> ... </atomic-search-interface>
        results:
          $ref: '#/components/schemas/interface-manifest-results'
        style:
          $ref: '#/components/schemas/interface-manifest-style'
        config:
          $ref: '#/components/schemas/interface-config'
      required:
      - markup
      - results
      - style
      - config
    interface-manifest-results:
      type: object
      description: The Atomic results configuration information.
      properties:
        placeholder:
          type: string
          description: The placeholder for the result list and result templates.
          example: --results--
        attributes:
          type: object
          description: The Atomic [result list component](https://docs.coveo.com/en/atomic/latest/reference/components/atomic-result-list/#properties)'s
            properties.
          additionalProperties:
            type: string
          example:
            display: grid
            fields-to-include: source,filetype
            density: comfortable
        templates:
          type: array
          items:
            $ref: '#/components/schemas/interface-manifest-result-template'
    interface-manifest-result-template:
      type: object
      description: The Atomic result template configuration information.
      properties:
        markup:
          type: string
          description: The HTML markup of the content of the result template.
          example: <atomic-result-link></atomic-result-link>
        attributes:
          type: object
          description: The Atomic [result template component](https://docs.coveo.com/en/atomic/latest/reference/components/atomic-result-template/)'s
            properties.
          additionalProperties:
            type: string
          example:
            must-match-source: salesforce
    interface-manifest-style:
      type: object
      description: The Atomic related styling in CSS format.
      properties:
        theme:
          type: string
          description: The CSS to set [Atomic theme variables](https://docs.coveo.com/en/atomic/latest/usage/themes-and-visual-customization/#theme-variables).
          example: ':root { --atomic-primary: #B6254F; }'
        layout:
          type: string
          description: The page layout CSS.
          example: 'body { margin: 0; }'
    hostedpage:
      type: object
      properties:
        name:
          type: string
          description: A short descriptive name to help manage hosted pages.
          example: ExStore
        html:
          type: string
          description: The HTML markup of the hosted page.
          example: <atomic-search-interface> ... </atomic-search-interface>
        javascript:
          type: array
          items:
            $ref: '#/components/schemas/hostedpage-file-javascript'
        css:
          type: array
          items:
            $ref: '#/components/schemas/hostedpage-file-css'
      required:
      - name
      - html
    hostedpage-id:
      type: object
      properties:
        id:
          type: string
          description: The unique identifier of the hosted page.
          example: 123e4567-e89b-12d3-a456-426614174000
        name:
          type: string
          description: A short descriptive name to help manage hosted pages.
          example: ExStore
        html:
          type: string
          description: The HTML markup of the hosted page.
          example: <atomic-search-interface> ... </atomic-search-interface>
        javascript:
          type: array
          description: List of JavaScript resources appended to the header of a specific hosted page in the target Coveo organization.
            There is a limit of 20 JavaScript resources per hosted page.
          items:
            $ref: '#/components/schemas/hostedpage-file-javascript'
        css:
          type: array
          description: List of CSS resources appended to the header of a specific hosted page in the target Coveo organization.
            There is a limit of 20 CSS resources per hosted page.
          items:
            $ref: '#/components/schemas/hostedpage-file-css'
        created:
          type: string
          format: date-time
          description: The creation timestamp. (ISO 8601)
          example: '2021-12-31T12:46:00.000Z'
        createdBy:
          type: string
          description: The creator principal.
          example: jdoe@gmail.com-google
        updated:
          type: string
          format: date-time
          description: The last update timestamp. (ISO 8601)
          example: '2001-12-31T13:03:00.000Z'
        updatedBy:
          type: string
          description: The last updater principal.
          example: jdoe@gmail.com-google
      required:
      - id
      - name
      - html
    hostedpage-file-javascript:
      type: object
      description: JavaScript resource appended to the header of a specific hosted page in the target Coveo organization.
      properties:
        isModule:
          type: boolean
          description: Whether the inline code should be treated as a JavaScript module. If this property is `true`, the `type`
            property will be set to `module` on the `script` tag.
          required: true
        inlineContent:
          type: string
          description: The content of the header `script` tag. If this property is defined, the `url` property should not
            be specified.
          example: window.location = 'about:blank';
        url:
          type: string
          description: The URL of the JavaScript source file. If this property is defined, the `inlineContent` property should
            not be specified.
          example: https://static.cloud.coveo.com/atomic/v2/index.esm.js
    hostedpage-file-css:
      type: object
      description: CSS resource appended in the header, pertaining to a specific hosted page in the target Coveo organization.
      properties:
        inlineContent:
          type: string
          description: The content of the header `style` tag. If this property is defined, the `url` property should not be
            specified.
          example: 'body { color: #e0e0e0; background-color: #2a2aa2; }'
        url:
          type: string
          description: The URL of CSS stylesheet. If this property is defined, the `inlineContent` property should not be
            specified.
          example: https://static.cloud.coveo.com/atomic/v2/themes/coveo.css
    ipx-interface-config:
      type: object
      properties:
        name:
          type: string
          description: A short descriptive name to help manage IPXs.
          example: ExStore
        facets:
          type: array
          description: The list of facets to display in the IPX interface.
          items:
            properties:
              field:
                type: string
                description: The [field](https://docs.coveo.com/en/200) on which the facet is based.
              label:
                type: string
                description: The label of the facet.
          example:
          - field: source
            label: Source
          - field: objecttype
            label: Object Type
        tabs:
          type: array
          description: The list of tabs to display in the IPX interface.
          items:
            properties:
              label:
                type: string
                description: The label of the facet.
              conditions:
                type: array
                description: The conditions of the tab to use on fields.
                items:
                  properties:
                    conditionType:
                      type: string
                      description: The type of condition to apply on a field.
                    field:
                      type: string
                      description: The [field](https://docs.coveo.com/en/200) on which the tab is based.
                    values:
                      type: array
                      description: The value to use for the tab condition.
          example:
          - label: All
            conditions: []
          - label: Pdf
            conditions:
              conditionType: mustMatch
              field: fileType
              values:
              - pdf
        container:
          type: object
          description: The IPX container that defines how to display the IPX search interface on your web page.
          properties:
            button:
              type: object
              description: The IPX button.
              properties:
                label:
                  type: string
                  description: The label of the button.
                  example: Coveo search
                openIcon:
                  type: string
                  description: The SVG open icon of the button.
                  example: <svg viewBox='0 0 10 10' ... ></svg
            targetSelector:
              type: string
              description: CSS selector to target the HTML element on your web page.
              example: '#sidepanel'
            usesTargetSelector:
              type: boolean
              description: Whether to use the target selector.
        footer:
          type: array
          description: The list of the IPX footer parts.
          items:
            properties:
              label:
                type: string
                description: The footer part's label to display.
                example: Coveo
              link:
                type: string
                description: The redirect URL.
                example: https://www.coveo.com
              icon:
                type: string
                description: The SVG logo to display.
                example: <svg viewBox='0 0 10 10' ... ></svg
        resultTemplates:
          type: array
          description: The list of IPX result templates.
          items:
            properties:
              name:
                type: string
                description: The result template name.
              layout:
                type: string
                description: The result template layout.
              badge:
                type: object
                description: The result template badge.
                properties:
                  field:
                    type: string
                    description: The [field](https://docs.coveo.com/en/200) on which the tab is based.
                  color:
                    type: string
                    description: The color of the result template badge.
              details:
                type: array
                description: The result template details.
                items:
                  properties:
                    field:
                      type: string
                      description: The [field](https://docs.coveo.com/en/200) on which the tab is based.
                    label:
                      type: string
                      description: The label of the result template detail.
              conditions:
                type: array
                description: The conditions of the tab to use on fields.
                items:
                  properties:
                    conditionType:
                      type: string
                      description: The type of condition to apply on a field.
                    field:
                      type: string
                      description: The [field](https://docs.coveo.com/en/200) on which the tab is based.
                    values:
                      type: array
                      description: The value to use for the tab condition.
          example:
          - name: Default
            layout: default
            badge:
              field: documenttype
              color: '#d057bf'
            details:
            - field: source
              label: source
            conditions: []
          - name: My Custom Template
            layout: default
            badge:
              field: documenttype
              color: '#e4e3e3'
            details:
            - field: source
              label: source
            conditions:
            - conditionType: isDefined
              field: filetype
            - conditionType: mustMatch
              field: sourcetype
              values:
              - youtube
        style:
          type: object
          description: The IPX styling.
          properties:
            fontFamily:
              type: string
              description: The font-family
              example: Comic Sans MS
            colors:
              type: object
              description: All changeable HEX colors of the IPX interface.
              properties:
                primary:
                  type: string
                  description: The primary color.
                  example: '#1372ec'
                neutral:
                  type: string
                  description: The secondary color.
                background:
                  type: string
                  description: The background color.
                visitedLink:
                  type: string
                  description: The visited link color.
                titles:
                  type: string
                  description: The color of the titles.
                button:
                  type: string
                  description: The color of the IPX button.
                buttonLabel:
                  type: string
                  description: The color of the IPX button label.
        settings:
          type: object
          description: The IPX settings.
          properties:
            smartSnippets:
              type: object
              description: The smart snippets settings.
              properties:
                enabled:
                  type: boolean
            genQA:
              type: object
              description: Whether to enable GenQA.
              properties:
                enabled:
                  type: boolean
                allowed:
                  type: boolean
            peopleAlsoAsk:
              type: object
              description: Whether to enable People Also Ask.
              properties:
                enabled:
                  type: boolean
            disableDynamicNavigation:
              type: boolean
              description: Whether to disable dynamic navigation.
              properties:
                enabled:
                  type: boolean
        pipelines:
          type: object
          description: The IPX pipelines, conditions and models that were created on IPX creation.
          properties:
            searchPipeline:
              $ref: '#/components/schemas/associated-pipeline'
            recsPipeline:
              $ref: '#/components/schemas/associated-pipeline'
      required:
      - name
    ipx-interface-config-id:
      type: object
      properties:
        id:
          type: string
          description: The unique identifier of the search interface configuration.
          example: 123e4567-e89b-12d3-a456-426614174000
        name:
          type: string
          description: A short descriptive name to help manage IPXs.
          example: ExStore
        title:
          type: string
          description: The title of the IPX interface configuration. Will be displayed as the HTML page title.
          example: My IPX example
        facets:
          type: array
          description: The list of facets to display in the IPX interface.
          items:
            properties:
              field:
                type: string
                description: The [field](https://docs.coveo.com/en/200) on which the facet is based.
              label:
                type: string
                description: The label of the facet.
          example:
          - field: source
            label: Source
          - field: objecttype
            label: Object Type
        tabs:
          type: array
          description: The list of tabs to display in the IPX interface.
          items:
            properties:
              label:
                type: string
                description: The label of the facet.
              conditions:
                type: array
                description: The conditions of the tab to use on fields.
                items:
                  properties:
                    conditionType:
                      type: string
                      description: The type of condition to apply on a field.
                    field:
                      type: string
                      description: The [field](https://docs.coveo.com/en/200) on which the tab is based.
                    values:
                      type: array
                      description: The value to use for the tab condition.
          example:
          - label: All
            conditions: []
          - label: Pdf
            conditions:
              conditionType: mustMatch
              field: fileType
              values:
              - pdf
        container:
          type: object
          description: The IPX container that defines how to display the IPX search interface on your web page.
          properties:
            button:
              type: object
              description: The IPX button.
              properties:
                label:
                  type: string
                  description: The label of the button.
                  example: Coveo search
                openIcon:
                  type: string
                  description: The SVG open icon of the button.
                  example: <svg viewBox='0 0 10 10' ... ></svg
            targetSelector:
              type: string
              description: CSS selector to target the HTML element on your web page.
              example: '#sidepanel'
            usesTargetSelector:
              type: boolean
              description: Whether to use the target selector.
        footer:
          type: array
          description: The list of the IPX footer parts.
          items:
            properties:
              label:
                type: string
                description: The footer part's label to display.
                example: Coveo
              link:
                type: string
                description: The redirect URL.
                example: https://www.coveo.com
              icon:
                type: string
                description: The SVG logo to display.
                example: <svg viewBox='0 0 10 10' ... ></svg
        resultTemplates:
          type: array
          description: The list of IPX result templates.
          items:
            properties:
              name:
                type: string
                description: The result template name.
              layout:
                type: string
                description: The result template layout.
              badge:
                type: object
                description: The result template badge.
                properties:
                  field:
                    type: string
                    description: The [field](https://docs.coveo.com/en/200) on which the tab is based.
                  color:
                    type: string
                    description: The color of the result template badge.
              details:
                type: array
                description: The result template details.
                items:
                  properties:
                    field:
                      type: string
                      description: The [field](https://docs.coveo.com/en/200) on which the tab is based.
                    label:
                      type: string
                      description: The label of the result template detail.
              conditions:
                type: array
                description: The conditions of the tab to use on fields.
                items:
                  properties:
                    conditionType:
                      type: string
                      description: The type of condition to apply on a field.
                    field:
                      type: string
                      description: The [field](https://docs.coveo.com/en/200) on which the tab is based.
                    values:
                      type: array
                      description: The value to use for the tab condition.
          example:
          - name: Default
            layout: default
            badge:
              field: documenttype
              color: '#d057bf'
            details:
            - field: source
              label: source
            conditions: []
          - name: My Custom Template
            layout: default
            badge:
              field: documenttype
              color: '#e4e3e3'
            details:
            - field: source
              label: source
            conditions:
            - conditionType: isDefined
              field: filetype
            - conditionType: mustMatch
              field: sourcetype
              values:
              - youtube
        style:
          type: object
          description: The IPX styling.
          properties:
            fontFamily:
              type: string
              description: The font-family
              example: Comic Sans MS
            colors:
              type: object
              description: All changeable HEX colors of the IPX interface.
              properties:
                primary:
                  type: string
                  description: The primary color.
                  example: '#1372ec'
                neutral:
                  type: string
                  description: The secondary color.
                background:
                  type: string
                  description: The background color.
                visitedLink:
                  type: string
                  description: The visited link color.
                titles:
                  type: string
                  description: The color of the titles.
                button:
                  type: string
                  description: The color of the IPX button.
                buttonLabel:
                  type: string
                  description: The color of the IPX button label.
        settings:
          type: object
          description: The IPX settings.
          properties:
            smartSnippets:
              type: object
              description: The smart snippets settings.
              properties:
                enabled:
                  type: boolean
            genQA:
              type: object
              description: Whether to enable GenQA.
              properties:
                enabled:
                  type: boolean
                allowed:
                  type: boolean
            peopleAlsoAsk:
              type: object
              description: Whether to enable People Also Ask.
              properties:
                enabled:
                  type: boolean
            disableDynamicNavigation:
              type: boolean
              description: Whether to disable dynamic navigation.
              properties:
                enabled:
                  type: boolean
        pipelines:
          type: object
          description: The IPX pipelines, conditions and models that were created on IPX creation.
          properties:
            searchPipeline:
              $ref: '#/components/schemas/associated-pipeline'
            recsPipeline:
              $ref: '#/components/schemas/associated-pipeline'
        created:
          type: string
          format: date-time
          description: The creation timestamp. (ISO 8601)
          example: '2021-12-31T12:46:00.000Z'
        createdBy:
          type: string
          description: The creator principal.
          example: jdoe@gmail.com-google
        updated:
          type: string
          format: date-time
          description: The last update timestamp. (ISO 8601)
          example: '2001-12-31T13:03:00.000Z'
        updatedBy:
          type: string
          description: The last updater principal.
          example: jdoe@gmail.com-google
      required:
      - id
      - name
    ipx-interface-config-project:
      allOf:
      - $ref: '#/components/schemas/ipx-interface-config-id'
      - type: object
        properties:
          projectIds:
            description: The list of project IDs associated with the IPX interface.
            items:
              type: string
    search-page-interface-config:
      type: object
      properties:
        name:
          type: string
          description: A short descriptive name to help manage search pages.
          example: ExStore
        facets:
          type: array
          description: The list of facets to display in the search page.
          items:
            properties:
              field:
                type: string
                description: The [field](https://docs.coveo.com/en/200) on which the facet is based.
              label:
                type: string
                description: The label of the facet.
          example:
          - field: source
            label: Source
          - field: objecttype
            label: Object Type
        sortCriteria:
          type: array
          description: The array of sort criteria the end user can select when interacting with the search interface.
          items:
            properties:
              by:
                type: string
                description: 'The kind of sort criterion. Required. <br />**Allowed values:**<br />- `relevancy`<br />- `date`<br
                  />- `field`: sort based on the values of a target field, which you need to specify in the `field` parameter.'
                enum:
                - relevancy
                - date
                - field
              label:
                type: string
                description: The label of the sort criterion. Required.
              field:
                type: string
                description: The [field](https://docs.coveo.com/en/200) on which the sort is based. Required when `by` value
                  is `field`, and ignored otherwise.<br />Must be [sortable in the index](https://docs.coveo.com/en/1833/index-content/add-or-edit-a-field#sortable).
              order:
                type: string
                enum:
                - ASC
                - DESC
                description: 'The sort direction, if applicable.<br />Default behaviour is a follows:<br />- If the `by` value
                  is `relevancy`, this parameter does not apply.<br />- If the `by` value is `date`, the default value is
                  `DESC`.<br />- If the `by` value is anything else, the default value is `ASC`.<br />**Allowed values:**
                  <br />- `ASC`: ascending <br>- `DESC`: descending'
            required:
            - by
            - label
        accesses:
          $ref: '#/components/schemas/interface-access'
        layout:
          type: string
          description: The search page layout.
          enum:
          - list
          - grid
        resultTemplates:
          type: array
          description: The list of search page result templates.
          items:
            properties:
              name:
                type: string
                description: The result template name.
              badges:
                type: array
                description: The result template badges.
                items:
                  properties:
                    field:
                      type: string
                      description: The [field](https://docs.coveo.com/en/200) on which the badge is based.
                    color:
                      type: string
                      description: The color of the result template badge.
              details:
                type: array
                description: The result template details.
                items:
                  properties:
                    field:
                      type: string
                      description: The [field](https://docs.coveo.com/en/200) on which the tab is based.
                    label:
                      type: string
                      description: The label of the result template detail.
              conditions:
                type: array
                description: The conditions of the tab to use on fields.
                items:
                  properties:
                    conditionType:
                      type: string
                      description: The type of condition to apply on a field.
                    field:
                      type: string
                      description: The [field](https://docs.coveo.com/en/200) on which the tab is based.
                    values:
                      type: array
                      description: The value to use for the tab condition.
              imageSize:
                type: string
                description: The size of the result template image.
                enum:
                - NONE
                - SMALL
                - MEDIUM
                - LARGE
              descriptionEnabled:
                type: boolean
                description: Whether to display the result template description.
              resultActions:
                type: object
                description: The result template actions.
                properties:
                  copyToClipboard:
                    type: object
                    properties:
                      enabled:
                        type: boolean
                  quickView:
                    type: object
                    properties:
                      enabled:
                        type: boolean
          example:
          - name: Default
            layout: default
            badges:
            - field: documenttype
              color: '#d057bf'
            details:
            - field: source
              label: source
            conditions: []
          - name: My Custom Template
            layout: default
            badges:
            - field: documenttype
              color: '#e4e3e3'
            details:
            - field: source
              label: source
            conditions:
            - conditionType: isDefined
              field: filetype
            - conditionType: mustMatch
              field: sourcetype
              values:
              - youtube
        style:
          type: object
          description: The search page styling.
          properties:
            fontFamily:
              type: string
              description: The font-family
              example: Comic Sans MS
            colors:
              type: object
              description: All changeable HEX colors of the search page.
              properties:
                accent1:
                  type: string
                  description: The primary color.
                  example: '#1372ec'
                accent2:
                  type: string
                  description: The secondary color.
                background:
                  type: string
                  description: The background color.
                titles:
                  type: string
                  description: The color of the titles.
                normalText:
                  type: string
                  description: The color of other text.
                navigationBackground:
                  type: string
                  description: The color of the navigation background.
        settings:
          type: object
          description: The search page settings.
          properties:
            targetSelector:
              type: string
              description: CSS selector to target the HTML element in which the search page will render.
              example: '#sidepanel'
            querySuggestions:
              type: object
              description: Whether to enable query suggestions.
              properties:
                enabled:
                  type: boolean
            queryHistory:
              type: object
              description: Whether to enable query history.
              properties:
                enabled:
                  type: boolean
            smartSnippets:
              type: object
              description: Whether to enable smart snippets.
              properties:
                enabled:
                  type: boolean
            peopleAlsoAsk:
              type: object
              description: Whether to enable people also ask.
              properties:
                enabled:
                  type: boolean
            genQA:
              type: object
              description: Whether to enable GenQA.
              properties:
                enabled:
                  type: boolean
            agent:
              type: object
              description: Whether to enable the agent-based generated answer. Mutually exclusive with genQA.
              properties:
                enabled:
                  type: boolean
                  default: false
      required:
      - name
    search-page-interface-config-id:
      type: object
      properties:
        id:
          type: string
          description: The unique identifier of the search interface configuration.
          example: 123e4567-e89b-12d3-a456-426614174000
        name:
          type: string
          description: A short descriptive name to help manage search pages.
          example: ExStore
        facets:
          type: array
          description: The list of facets to display in the search page.
          items:
            properties:
              field:
                type: string
                description: The [field](https://docs.coveo.com/en/200) on which the facet is based.
              label:
                type: string
                description: The label of the facet.
          example:
          - field: source
            label: Source
          - field: objecttype
            label: Object Type
        sortCriteria:
          type: array
          description: The array of sort criteria the end user can select when interacting with the search interface.
          items:
            properties:
              by:
                type: string
                description: 'The kind of sort criterion. Required. <br />**Allowed values:**<br />- `relevancy`<br />- `date`<br
                  />- `field`: sort based on the values of a target field, which you need to specify in the `field` parameter.'
                enum:
                - relevancy
                - date
                - field
              label:
                type: string
                description: The label of the sort criterion. Required.
              field:
                type: string
                description: The [field](https://docs.coveo.com/en/200) on which the sort is based. Required when `by` value
                  is `field`, and ignored otherwise.<br />Must be [sortable in the index](https://docs.coveo.com/en/1833/index-content/add-or-edit-a-field#sortable).
              order:
                type: string
                enum:
                - ASC
                - DESC
                description: 'The sort direction, if applicable.<br />Default behaviour is a follows:<br />- If the `by` value
                  is `relevancy`, this parameter does not apply.<br />- If the `by` value is `date`, the default value is
                  `DESC`.<br />- If the `by` value is anything else, the default value is `ASC`.<br />**Allowed values:**
                  <br />- `ASC`: ascending <br>- `DESC`: descending'
            required:
            - by
            - label
        accesses:
          $ref: '#/components/schemas/interface-access'
        layout:
          type: string
          description: The search page layout.
          enum:
          - list
          - grid
        resultTemplates:
          type: array
          description: The list of search page result templates.
          items:
            properties:
              name:
                type: string
                description: The result template name.
              badges:
                type: array
                description: The result template badges.
                items:
                  properties:
                    field:
                      type: string
                      description: The [field](https://docs.coveo.com/en/200) on which the badge is based.
                    color:
                      type: string
                      description: The color of the result template badge.
              details:
                type: array
                description: The result template details.
                items:
                  properties:
                    field:
                      type: string
                      description: The [field](https://docs.coveo.com/en/200) on which the tab is based.
                    label:
                      type: string
                      description: The label of the result template detail.
              conditions:
                type: array
                description: The conditions of the tab to use on fields.
                items:
                  properties:
                    conditionType:
                      type: string
                      description: The type of condition to apply on a field.
                    field:
                      type: string
                      description: The [field](https://docs.coveo.com/en/200) on which the tab is based.
                    values:
                      type: array
                      description: The value to use for the tab condition.
              imageSize:
                type: string
                description: The size of the result template image.
                enum:
                - NONE
                - SMALL
                - MEDIUM
                - LARGE
              descriptionEnabled:
                type: boolean
                description: Whether to display the result template description.
              resultActions:
                type: object
                description: The result template actions.
                properties:
                  copyToClipboard:
                    type: object
                    properties:
                      enabled:
                        type: boolean
                  quickView:
                    type: object
                    properties:
                      enabled:
                        type: boolean
          example:
          - name: Default
            layout: default
            badges:
            - field: documenttype
              color: '#d057bf'
            details:
            - field: source
              label: source
            conditions: []
          - name: My Custom Template
            layout: default
            badges:
            - field: documenttype
              color: '#e4e3e3'
            details:
            - field: source
              label: source
            conditions:
            - conditionType: isDefined
              field: filetype
            - conditionType: mustMatch
              field: sourcetype
              values:
              - youtube
        style:
          type: object
          description: The search page styling.
          properties:
            fontFamily:
              type: string
              description: The font-family
              example: Comic Sans MS
            colors:
              type: object
              description: All changeable HEX colors of the search page.
              properties:
                accent1:
                  type: string
                  description: The primary color.
                  example: '#1372ec'
                accent2:
                  type: string
                  description: The secondary color.
                background:
                  type: string
                  description: The background color.
                titles:
                  type: string
                  description: The color of the titles.
                normalText:
                  type: string
                  description: The color of other text.
                navigationBackground:
                  type: string
                  description: The color of the navigation background.
        settings:
          type: object
          description: The search page settings.
          properties:
            targetSelector:
              type: string
              description: CSS selector to target the HTML element in which the search page will render.
              example: '#sidepanel'
            querySuggestions:
              type: object
              description: Whether to enable query suggestions.
              properties:
                enabled:
                  type: boolean
            queryHistory:
              type: object
              description: Whether to enable query history.
              properties:
                enabled:
                  type: boolean
            smartSnippets:
              type: object
              description: Whether to enable smart snippets.
              properties:
                enabled:
                  type: boolean
            peopleAlsoAsk:
              type: object
              description: Whether to enable people also ask.
              properties:
                enabled:
                  type: boolean
            genQA:
              type: object
              description: Whether to enable GenQA.
              properties:
                enabled:
                  type: boolean
            agent:
              type: object
              description: Whether to enable the agent-based generated answer. Mutually exclusive with genQA.
              properties:
                enabled:
                  type: boolean
                  default: false
        created:
          type: string
          format: date-time
          description: The creation timestamp. (ISO 8601)
          example: '2021-12-31T12:46:00.000Z'
        createdBy:
          type: string
          description: The creator principal.
          example: jdoe@gmail.com-google
        updated:
          type: string
          format: date-time
          description: The last update timestamp. (ISO 8601)
          example: '2001-12-31T13:03:00.000Z'
        updatedBy:
          type: string
          description: The last updater principal.
          example: jdoe@gmail.com-google
      required:
      - id
      - name
    search-page-interface-config-project:
      allOf:
      - $ref: '#/components/schemas/search-page-interface-config'
      - type: object
        properties:
          projectIds:
            type: array
            description: The list of project IDs associated with the search page interface.
            items:
              type: string
    pipelines-status:
      type: array
      description: A list containing the pipeline(s) used by the interface.
      items:
        $ref: '#/components/schemas/pipeline-status'
    pipeline-status:
      type: object
      description: The status of a pipeline.
      properties:
        id:
          type: string
          description: The unique identifier of the pipeline.
          example: aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa
        name:
          type: string
          description: The name of the pipeline.
          example: My pipeline
        pipelineType:
          type: string
          description: The type of the pipeline.
          example: search
        conditionId:
          type: string
          description: The unique identifier of the associated condition.
          example: bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb
        models:
          type: array
          items:
            description: The list of models used by the pipeline.
            properties:
              id:
                type: string
                description: The unique identifier of the model.
                example: cccccccc-cccc-cccc-cccc-cccccccccccc
              modelStatus:
                type: string
                description: The status of the model.
                example: ACTIVE
              modelEngine:
                type: string
                description: The type of the model.
                example: genqa
    associated-pipeline:
      type: object
      description: The associated pipeline.
      properties:
        id:
          type: string
          description: The unique identifier of the search pipeline.
          example: aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa
        name:
          type: string
          description: The name of the search pipeline.
          example: My pipeline
        pipelineType:
          type: string
          description: The type of the pipeline.
          example: search
        conditionId:
          type: string
          description: The unique identifier of the condition.
          example: bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb
        models:
          type: array
          description: The list of models.
          items:
            properties:
              modelId:
                type: string
                description: The unique identifier of the model.
                example: cccccccc-cccc-cccc-cccc-cccccccccccc
              modelDisplayName:
                type: string
                description: The name of the model.
                example: My model
              engineId:
                type: string
                description: The type of the model.
                example: topclicks
              exportPeriod:
                type: string
                description: The export period of the model.
                example: P3M
              intervalTime:
                type: integer
                description: The interval time of the model.
                example: 1
              intervalUnit:
                type: string
                description: The interval unit of the model.
                example: WEEK
              exportOffset:
                type: string
                description: The export offset of the model.
                example: PT0S
              extraConfig:
                type: object
                description: The extra configuration of the model.
                properties:
                  commerceSupport:
                    type: object
                    description: Whether the model should support commerce use-cases.
                    properties:
                      enabled:
                        type: boolean
    InsightPanelInterface:
      type: object
      properties:
        id:
          type: string
          description: The unique identifier of the Insight Panel interface.
          example: e35eb3f4-353e-4ab8-96b8-35c09d5951c9
          required: true
        name:
          type: string
          description: The name of the Insight Panel interface
          example: Example Insight Panel
          required: true
        resultTemplates:
          type: array
          items:
            $ref: '#/components/schemas/InsightPanelResultTemplate'
        facets:
          type: array
          items:
            $ref: '#/components/schemas/Facet'
        tabs:
          type: array
          items:
            $ref: '#/components/schemas/Tab'
        settings:
          $ref: '#/components/schemas/SettingsSection'
    InsightPanelBodyParams:
      type: object
      properties:
        name:
          type: string
          description: The name of the Insight Panel interface
          example: Example Insight Panel
          required: true
        resultTemplates:
          type: array
          required: true
          items:
            $ref: '#/components/schemas/InsightPanelResultTemplate'
        facets:
          type: array
          required: true
          items:
            $ref: '#/components/schemas/Facet'
        tabs:
          type: array
          required: true
          items:
            $ref: '#/components/schemas/Tab'
        settings:
          $ref: '#/components/schemas/SettingsSection'
    InsightPanelResultTemplate:
      type: object
      description: Template
      properties:
        name:
          type: string
          description: The name of the template
          example: Example Template
          required: true
        layout:
          $ref: '#/components/schemas/TemplateLayout'
        conditions:
          type: array
          items:
            $ref: '#/components/schemas/Condition'
        badge:
          $ref: '#/components/schemas/Badge'
        details:
          type: array
          items:
            $ref: '#/components/schemas/Detail'
        resultActions:
          $ref: '#/components/schemas/ResultActions'
        tags:
          $ref: '#/components/schemas/Tags'
    TemplateLayout:
      type: string
      description: The template layout to use.
      enum:
      - default
      - thumbnail
    Condition:
      type: object
      description: The conditions a result needs to meet to use the template.
      properties:
        field:
          type: string
        conditionType:
          type: string
          description: The type of condition to apply on a field.
          enum:
          - isDefined
          - isNotDefined
          - mustMatch
          - mustNotMatch
    Badge:
      type: object
      description: The badge to display.
      properties:
        field:
          type: string
        label:
          type: string
        color:
          type: string
          example: '#FF00AA'
    Detail:
      type: object
      description: The metadata details to display.
      properties:
        field:
          type: string
        label:
          type: string
    ResultActions:
      type: object
      description: The available result actions.
      enum:
      - attachToCase
      - copyToClipboard
      - quickView
      - sendAsEmail
      - sendToFeed
      properties:
        attachToCase:
          type: object
          properties:
            enabled:
              type: boolean
        copyToClipboard:
          type: object
          properties:
            enabled:
              type: boolean
        quickView:
          type: object
          properties:
            enabled:
              type: boolean
        sendAsEmail:
          type: object
          properties:
            enabled:
              type: boolean
        sendToFeed:
          type: object
          properties:
            enabled:
              type: boolean
    Tags:
      type: object
      description: The tags allowed to be displayed.
      properties:
        recommended:
          $ref: '#/components/schemas/TagParam'
        viewedByCustomer:
          $ref: '#/components/schemas/TagParam'
        featured:
          $ref: '#/components/schemas/TagParam'
    TagParam:
      type: object
      properties:
        enabled:
          type: boolean
        color:
          type: string
          example: '#FF00AA'
    Facet:
      type: object
      description: The list of facets to display.
      properties:
        field:
          type: string
          required: true
        label:
          type: string
        displayValueAs:
          type: string
    Tab:
      type: object
      description: The list of tabs to display.
      properties:
        label:
          type: string
          required: true
        conditions:
          type: array
          items:
            $ref: '#/components/schemas/Condition'
    UserActionsOptions:
      type: object
      description: Options to configure a view of the actions taken by the user who submitted the case.
      properties:
        enabled:
          type: boolean
          description: Whether to enable the feature.
          required: true
        recentClickedDocuments:
          type: object
          description: Whether to show documents recently clicked by the user.
          required: true
          properties:
            enabled:
              type: boolean
        recentQueries:
          type: object
          description: Whether to show recent queries performed by the user.
          required: true
          properties:
            enabled:
              type: boolean
        timeline:
          type: object
          description: Whether to show a timeline of the user's actions.
          required: true
          properties:
            enabled:
              type: boolean
    SettingsSection:
      type: object
      properties:
        createArticle:
          type: object
          description: Display a button to create a knowledge article.
          required: true
          properties:
            enabled:
              type: boolean
        fullSearch:
          type: object
          description: Display a button to open a full search page.
          required: true
          properties:
            enabled:
              type: boolean
        userActions:
          $ref: '#/components/schemas/UserActionsOptions'
    Page:
      type: object
      properties:
        totalPages:
          type: integer
          description: The total number of pages.
        totalEntries:
          type: integer
          description: The total number of items.
    InterfaceVersionInfoPage:
      allOf:
      - $ref: '#/components/schemas/Page'
      - type: object
        properties:
          items:
            type: array
            description: The list of interface versions.
            items:
              $ref: '#/components/schemas/InterfaceVersionInfo'
    InterfaceVersionInfo:
      type: object
      properties:
        version:
          type: integer
          description: The sequential number attributed to the version.
        label:
          type: string
          description: An optional label describing the version changes.
          required: false
        created:
          type: object
          $ref: '#/components/schemas/CreatedChangeInfo'
        updated:
          type: object
          $ref: '#/components/schemas/UpdatedChangeInfo'
        isPublished:
          type: boolean
          description: Indicates whether the version is currently published.
        restoredFromVersion:
          type: integer
          description: Indicates the origin of the current version, if it was restored.
          required: false
    InsightInterfaceVersionInfo:
      allOf:
      - $ref: '#/components/schemas/InterfaceVersionInfo'
      - type: object
        description: Information about a specific Insight Panel interface version.
        properties:
          configuration:
            type: object
            $ref: '#/components/schemas/InsightPanelInterface'
    IpxInterfaceVersionInfo:
      allOf:
      - $ref: '#/components/schemas/InterfaceVersionInfo'
      - type: object
        description: Information about a specific IPX interface version.
        properties:
          configuration:
            type: object
            $ref: '#/components/schemas/ipx-interface-config-id'
    ChangeInfo:
      type: object
      properties:
        by:
          type: string
          description: The identity of the user who performed the change.
        date:
          type: string
          description: The date and time at which the change was performed, in ISO-8601 format.
        firstName:
          type: string
          description: The first name of the user who performed the change.
        lastName:
          type: string
          description: The last name of the user who performed the change.
    CreatedChangeInfo:
      allOf:
      - $ref: '#/components/schemas/ChangeInfo'
      - type: object
        description: Information about the version creation.
    UpdatedChangeInfo:
      allOf:
      - $ref: '#/components/schemas/ChangeInfo'
      - type: object
        description: Information about the most recent version update.
    VersionLabelParams:
      type: object
      properties:
        label:
          type: string
          description: The label to set on the version. This value can be empty.
          required: true
  parameters:
    organization-id:
      name: organizationId
      description: The unique identifier of the target [organization](https://docs.coveo.com/en/185/).
      example: mycoveocloudv2organizationg8tp8wu3
      in: path
      required: true
      schema:
        type: string
    interface-id:
      name: interfaceId
      description: The unique identifier of the target search interface.
      example: 123e4567-e89b-12d3-a456-426614174000
      in: path
      required: true
      schema:
        type: string
    insight-panel-interface-id:
      name: interfaceId
      description: The unique identifier of the target Insight Panel interface.
      example: 123e4567-e89b-12d3-a456-426614174000
      in: path
      required: true
      schema:
        type: string
    insight-panel-config-id:
      name: insightConfigId
      description: The unique identifier of the target Insight Panel configuration.
      example: 123e4567-e89b-12d3-a456-426614174000
      in: query
      required: true
      schema:
        type: string
    filter:
      name: filter
      description: A substring that must appear in a search interface configuration name for this configuration to appear
        in results.
      example: Store
      in: query
      schema:
        type: string
    order:
      name: order
      description: 'The sort direction of the results.<br />Possible values:<br /> - `asc`: ascending order<br /> - `desc`:
        descending order'
      in: query
      schema:
        type: string
        enum:
        - asc
        - desc
    page:
      name: page
      description: The 0-based number of the page of configurations to list.
      in: query
      schema:
        type: integer
        minimum: 0
        maximum: 100
    perPage:
      name: perPage
      description: The maximum number of configurations to include per page.
      in: query
      schema:
        type: integer
        minimum: 0
        maximum: 20
    projectId:
      name: projectId
      description: The id of the project to which the resource belongs.
      in: query
      schema:
        type: string
    notify:
      name: notify
      description: Whether to send an email notification to new search page users.
      example: false
      in: query
      schema:
        type: boolean
    version-number:
      name: versionNumber
      description: The sequential number identifying a version.
      in: path
      required: true
      schema:
        type: integer
        minimum: 1
    versions-page:
      name: page
      description: The 0-based number of the page of versions to list.
      in: query
      schema:
        type: integer
        default: 0
        minimum: 0
        maximum: 100
    versions-per-page:
      name: perPage
      description: The number of versions to include per page.
      in: query
      schema:
        type: integer
        default: 10
        minimum: 1
        maximum: 100
    versions-filter:
      name: filter
      description: A substring that must appear in a version label for this version to appear in results.
      in: query
      schema:
        type: string
    versions-order:
      name: order
      description: 'The sort direction of the versions based on the version number.<br />Possible values:<br /> - `asc`: ascending
        order<br /> - `desc`: descending order'
      in: query
      schema:
        type: string
        default: desc
  securitySchemes:
    oauth2:
      type: oauth2
      description: This API uses OAuth 2 with the implicit grant flow
      flows:
        implicit:
          authorizationUrl: /oauth/authorize
          scopes:
            full: full
security:
- oauth2:
  - full
servers:
- url: https://platform.cloud.coveo.com
  description: Coveo public API endpoint