Coveo Catalog Management API — Catalog Configurations

naftiko: 1.0.0-alpha2
info:
  label: Coveo Catalog Management API — Catalog Configurations
  description: 'Coveo Catalog Management API — Catalog Configurations. 6 operations. Lead operation: List Catalog Configurations.
    Self-contained Naftiko capability covering one Coveo business surface.'
  tags:
  - Coveo
  - Catalog Management
  - Catalog Configurations
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    COVEO_API_KEY: COVEO_API_KEY
capability:
  consumes:
  - type: http
    namespace: catalog-management-catalog-configurations
    baseUri: https://platform.cloud.coveo.com
    description: Coveo Catalog Management API — Catalog Configurations business capability. Self-contained, no shared references.
    authentication:
      type: bearer
      token: '{{env.COVEO_API_KEY}}'
    resources:
    - name: rest-organizations-organizationId-catalogconfigurations
      path: /rest/organizations/{organizationId}/catalogconfigurations
      operations:
      - name: getcatalogconfigurations
        method: GET
        description: List Catalog Configurations
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: organizationId
          in: path
          type: string
          description: The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br />**Example:**
            `acmecorporation8tp8wu3`
          required: true
        - name: page
          in: query
          type: integer
          description: The 0-based index number of the page of catalog configurations to retrieve.</br>**Minimum:** `0`</br>**Default:**
            `0`
        - name: pageSize
          in: query
          type: integer
          description: The number of catalog configurations to list per page.</br>**Minimum:** `1`</br>**Maximum:** `1000`</br>**Default:**
            `10`
      - name: createcatalogconfiguration
        method: POST
        description: Create Configuration
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: organizationId
          in: path
          type: string
          description: The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br />**Example:**
            `acmecorporation8tp8wu3`
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: rest-organizations-organizationId-catalogconfigurations-source-sourceId
      path: /rest/organizations/{organizationId}/catalogconfigurations/source/{sourceId}
      operations:
      - name: getcatalogconfigurationfromsource
        method: GET
        description: Show Catalog Configuration from a Source ID
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: organizationId
          in: path
          type: string
          description: The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br />**Example:**
            `acmecorporation8tp8wu3`
          required: true
        - name: sourceId
          in: path
          type: string
          description: A source containing the product content of the catalog
          required: true
    - name: rest-organizations-organizationId-catalogconfigurations-configurationId
      path: /rest/organizations/{organizationId}/catalogconfigurations/{configurationId}
      operations:
      - name: getcatalogconfiguration
        method: GET
        description: Show Catalog Configuration
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: organizationId
          in: path
          type: string
          description: The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br />**Example:**
            `acmecorporation8tp8wu3`
          required: true
        - name: configurationId
          in: path
          type: string
          description: The unique identifier of the catalog configuration to show.<br />**Example:** `644e1dd7-2a7f-18fb-b8ed-ed78c3f92c2b`
          required: true
      - name: updatecatalogconfiguration
        method: PUT
        description: Update Catalog Configuration
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: organizationId
          in: path
          type: string
          description: The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br />**Example:**
            `acmecorporation8tp8wu3`
          required: true
        - name: configurationId
          in: path
          type: string
          description: The unique identifier of the catalog configuration to update.<br />**Example:** `644e1dd7-2a7f-18fb-b8ed-ed78c3f92c2b`
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: deletecatalogconfiguration
        method: DELETE
        description: Delete Catalog Configuration
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: organizationId
          in: path
          type: string
          description: The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br />**Example:**
            `acmecorporation8tp8wu3`
          required: true
        - name: configurationId
          in: path
          type: string
          description: The unique identifier of the catalog configuration to delete.<br />**Example:** `644e1dd7-2a7f-18fb-b8ed-ed78c3f92c2b`
          required: true
  exposes:
  - type: rest
    namespace: catalog-management-catalog-configurations-rest
    port: 8080
    description: REST adapter for Coveo Catalog Management API — Catalog Configurations. One Spectral-compliant resource per
      consumed operation, prefixed with /v1.
    resources:
    - path: /v1/organizations/{organizationid}/catalogconfigurations
      name: rest-organizations-organizationid-catalogconfigurations
      description: REST surface for rest-organizations-organizationId-catalogconfigurations.
      operations:
      - method: GET
        name: getcatalogconfigurations
        description: List Catalog Configurations
        call: catalog-management-catalog-configurations.getcatalogconfigurations
        with:
          organizationId: rest.organizationId
          page: rest.page
          pageSize: rest.pageSize
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createcatalogconfiguration
        description: Create Configuration
        call: catalog-management-catalog-configurations.createcatalogconfiguration
        with:
          organizationId: rest.organizationId
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/organizations/{organizationid}/catalogconfigurations/source/{sourceid}
      name: rest-organizations-organizationid-catalogconfigurations-source-sourceid
      description: REST surface for rest-organizations-organizationId-catalogconfigurations-source-sourceId.
      operations:
      - method: GET
        name: getcatalogconfigurationfromsource
        description: Show Catalog Configuration from a Source ID
        call: catalog-management-catalog-configurations.getcatalogconfigurationfromsource
        with:
          organizationId: rest.organizationId
          sourceId: rest.sourceId
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/organizations/{organizationid}/catalogconfigurations/{configurationid}
      name: rest-organizations-organizationid-catalogconfigurations-configurationid
      description: REST surface for rest-organizations-organizationId-catalogconfigurations-configurationId.
      operations:
      - method: GET
        name: getcatalogconfiguration
        description: Show Catalog Configuration
        call: catalog-management-catalog-configurations.getcatalogconfiguration
        with:
          organizationId: rest.organizationId
          configurationId: rest.configurationId
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: updatecatalogconfiguration
        description: Update Catalog Configuration
        call: catalog-management-catalog-configurations.updatecatalogconfiguration
        with:
          organizationId: rest.organizationId
          configurationId: rest.configurationId
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deletecatalogconfiguration
        description: Delete Catalog Configuration
        call: catalog-management-catalog-configurations.deletecatalogconfiguration
        with:
          organizationId: rest.organizationId
          configurationId: rest.configurationId
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: catalog-management-catalog-configurations-mcp
    port: 9090
    transport: http
    description: MCP adapter for Coveo Catalog Management API — Catalog Configurations. One tool per consumed operation, routed
      inline through this capability's consumes block.
    tools:
    - name: list-catalog-configurations
      description: List Catalog Configurations
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: catalog-management-catalog-configurations.getcatalogconfigurations
      with:
        organizationId: tools.organizationId
        page: tools.page
        pageSize: tools.pageSize
      outputParameters:
      - type: object
        mapping: $.
    - name: create-configuration
      description: Create Configuration
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: catalog-management-catalog-configurations.createcatalogconfiguration
      with:
        organizationId: tools.organizationId
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: show-catalog-configuration-source-id
      description: Show Catalog Configuration from a Source ID
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: catalog-management-catalog-configurations.getcatalogconfigurationfromsource
      with:
        organizationId: tools.organizationId
        sourceId: tools.sourceId
      outputParameters:
      - type: object
        mapping: $.
    - name: show-catalog-configuration
      description: Show Catalog Configuration
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: catalog-management-catalog-configurations.getcatalogconfiguration
      with:
        organizationId: tools.organizationId
        configurationId: tools.configurationId
      outputParameters:
      - type: object
        mapping: $.
    - name: update-catalog-configuration
      description: Update Catalog Configuration
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: catalog-management-catalog-configurations.updatecatalogconfiguration
      with:
        organizationId: tools.organizationId
        configurationId: tools.configurationId
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-catalog-configuration
      description: Delete Catalog Configuration
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: catalog-management-catalog-configurations.deletecatalogconfiguration
      with:
        organizationId: tools.organizationId
        configurationId: tools.configurationId
      outputParameters:
      - type: object
        mapping: $.