Emporix · Schema

IndexConfiguration

CompanyCommerceE-CommerceB2B CommerceHeadless CommerceComposable CommerceCommerce OrchestrationAgentic CommerceiPaaSSoftware-as-a-Service

Properties

Name Type Description
searchKey string API Key used for search purposes.
applicationId string Application id of an indexer provider.
indexName string Identifier of an index.
provider string Index provider name. Supported providers: `ALGOLIA` (https://www.algolia.com), `BATTERY_INCLUDED` (https://www.batteryincluded.io). Only one provider can be active per tenant at a time.
active boolean Indicates if the configuration is active or not.
writeKey string API key used for write purposes. For `BATTERY_INCLUDED`, this key is validated before the configuration is created or updated.
excludedMixinKeys array Optional list of root product mixin keys to exclude from indexing. When set, the specified mixin keys are omitted from both the non-localized and localized portions of the indexed document. Applies on
includedMixinPaths array Optional allowlist of product mixin paths to include in indexing for the `BATTERY_INCLUDED` provider. Patterns are matched against full dot-notation paths rooted at the mixin key, for example `class_E
View JSON Schema on GitHub

JSON Schema

emporix-index-configuration-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/emporix/main/json-schema/emporix-index-configuration-schema.json",
  "title": "IndexConfiguration",
  "x-generated": "2026-10-18",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/emporix-indexing-service-openapi.yml#/components/schemas/IndexConfiguration",
  "allOf": [
    {
      "$ref": "#/$defs/IndexPublicConfiguration"
    },
    {
      "type": "object",
      "properties": {
        "writeKey": {
          "type": "string",
          "description": "API key used for write purposes. For `BATTERY_INCLUDED`, this key is validated before the configuration is created or updated."
        },
        "excludedMixinKeys": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "Optional list of root product mixin keys to exclude from indexing. When set, the specified mixin keys are omitted from both the non-localized and localized portions of the indexed document. Applies only to the `BATTERY_INCLUDED` provider."
        },
        "includedMixinPaths": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "Optional allowlist of product mixin paths to include in indexing for the `BATTERY_INCLUDED` provider. Patterns are matched against full dot-notation paths rooted at the mixin key, for example `class_EA673_toolsClassification.sk.OnlineIsService_P`.\n`*` matches within a single path segment, `**` matches across one or more path segments, and matching is case sensitive.\nIf a matched path points to an object, the entire subtree under that object is included. When this field is absent or an empty list, path filtering is inactive and existing `excludedMixinKeys` behavior applies.\n`includedMixinPaths` and `excludedMixinKeys` are mutually exclusive when `includedMixinPaths` is non-empty. Malformed glob patterns are rejected with a validation error on configuration writes."
        }
      },
      "required": [
        "provider"
      ]
    }
  ],
  "$defs": {
    "IndexPublicConfiguration": {
      "title": "IndexPublicConfiguration",
      "type": "object",
      "properties": {
        "searchKey": {
          "type": "string",
          "description": "API Key used for search purposes."
        },
        "applicationId": {
          "type": "string",
          "description": "Application id of an indexer provider."
        },
        "indexName": {
          "type": "string",
          "description": "Identifier of an index."
        },
        "provider": {
          "type": "string",
          "description": "Index provider name. Supported providers: `ALGOLIA` (https://www.algolia.com), `BATTERY_INCLUDED` (https://www.batteryincluded.io). Only one provider can be active per tenant at a time.",
          "enum": [
            "ALGOLIA",
            "BATTERY_INCLUDED"
          ]
        },
        "active": {
          "type": "boolean",
          "description": "Indicates if the configuration is active or not."
        }
      }
    }
  }
}

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/emporix-index-configuration"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.