[{"data":1,"prerenderedAt":558},["ShallowReactive",2],{"docs-navigation":3,"docs-\u002Fdocs\u002Fgetting-started\u002Fintroduction":313,"docs-\u002Fdocs\u002Fgetting-started\u002Fintroduction-surround":555},[4],{"title":5,"path":6,"stem":7,"children":8,"page":34},"Docs","\u002Fdocs","docs",[9,35,60,78,120,186,223,234,258,283],{"title":10,"description":11,"icon":12,"path":13,"stem":14,"children":15,"page":34},"Getting started","What Zaproo Search is, a quickstart, and wiring search into a storefront.","i-lucide-rocket","\u002Fdocs\u002Fgetting-started","docs\u002F1.getting-started",[16,22,28],{"title":17,"path":18,"stem":19,"description":20,"icon":21},"Introduction","\u002Fdocs\u002Fgetting-started\u002Fintroduction","docs\u002F1.getting-started\u002F1.introduction","What Zaproo Search is, the five things you work with, and how a product catalog becomes a search box on your shop.","i-lucide-book-open-text",{"title":23,"path":24,"stem":25,"description":26,"icon":27},"Quickstart","\u002Fdocs\u002Fgetting-started\u002Fquickstart","docs\u002F1.getting-started\u002F2.quickstart","From a new account to a first search request in six steps, with curl or from your AI agent.","i-lucide-zap",{"title":29,"path":30,"stem":31,"description":32,"icon":33},"Integrate a storefront","\u002Fdocs\u002Fgetting-started\u002Fstorefront","docs\u002F1.getting-started\u002F3.storefront","Build a search results page with facets and an autocomplete box on top of the search and suggest routes.","i-lucide-store",false,{"title":36,"description":37,"icon":38,"path":39,"stem":40,"children":41,"page":34},"Account and team","Sign-in, sessions, organizations, members, roles and projects.","i-lucide-users","\u002Fdocs\u002Faccount","docs\u002F2.account",[42,48,54],{"title":43,"path":44,"stem":45,"description":46,"icon":47},"Account and sign-in","\u002Fdocs\u002Faccount\u002Fsign-in","docs\u002F2.account\u002F1.sign-in","Create an account, verify your email, stay signed in, manage signed-in devices and change or reset your password.","i-lucide-log-in",{"title":49,"path":50,"stem":51,"description":52,"icon":53},"Organizations, members and roles","\u002Fdocs\u002Faccount\u002Forganizations","docs\u002F2.account\u002F2.organizations","What an organization holds, how to add members, and what owners, admins and members may do.","i-lucide-building-2",{"title":55,"path":56,"stem":57,"description":58,"icon":59},"Projects","\u002Fdocs\u002Faccount\u002Fprojects","docs\u002F2.account\u002F3.projects","Group the indices and API keys of one shop or one environment, and keep staging apart from production.","i-lucide-folder-kanban",{"title":61,"description":62,"icon":63,"path":64,"stem":65,"children":66,"page":34},"API keys and security","Secret and public keys, scopes, allowed origins, rate limits and errors.","i-lucide-key-round","\u002Fdocs\u002Fkeys","docs\u002F3.keys",[67,72],{"title":68,"path":69,"stem":70,"description":71,"icon":63},"API keys","\u002Fdocs\u002Fkeys\u002Fapi-keys","docs\u002F3.keys\u002F1.api-keys","Secret and public keys, full and read access, index scope, allowed origins, expiry, and how to revoke a key.",{"title":73,"path":74,"stem":75,"description":76,"icon":77},"Rate limits and errors","\u002Fdocs\u002Fkeys\u002Frate-limits","docs\u002F3.keys\u002F2.rate-limits","How many requests each route accepts per minute, what a 429 looks like, the error format and every error code with its HTTP status.","i-lucide-gauge",{"title":79,"description":80,"icon":81,"path":82,"stem":83,"children":84,"page":34},"Indexing","Indices, languages, mappings, documents, tasks, full catalog sync and reindexing.","i-lucide-database","\u002Fdocs\u002Findexing","docs\u002F4.indexing",[85,90,96,102,108,114],{"title":86,"path":87,"stem":88,"description":89,"icon":81},"Indices and languages","\u002Fdocs\u002Findexing\u002Findices","docs\u002F4.indexing\u002F1.indices","Create an index, pick its language, read its status, and change the language later with a reindex.",{"title":91,"path":92,"stem":93,"description":94,"icon":95},"Mapping and fields","\u002Fdocs\u002Findexing\u002Fmapping","docs\u002F4.indexing\u002F2.mapping","Field types, the five flags that decide what a field is used for, text analysis options, unmapped fields, and which changes need a reindex.","i-lucide-table-properties",{"title":97,"path":98,"stem":99,"description":100,"icon":101},"Documents and tasks","\u002Fdocs\u002Findexing\u002Fdocuments","docs\u002F4.indexing\u002F3.documents","Upload and delete documents in batches, follow each write as a task, retry safely with Idempotency-Key, and browse what the index holds.","i-lucide-file-json",{"title":103,"path":104,"stem":105,"description":106,"icon":107},"Full catalog sync","\u002Fdocs\u002Findexing\u002Ffull-sync","docs\u002F4.indexing\u002F4.full-sync","Replace the whole catalog with a replace session, so products missing from your export disappear from search, without downtime.","i-lucide-refresh-cw",{"title":109,"path":110,"stem":111,"description":112,"icon":113},"Reindex and versions","\u002Fdocs\u002Findexing\u002Fversions","docs\u002F4.indexing\u002F5.versions","Rebuild an index with its saved mapping and swap it in without downtime, follow or cancel the rebuild, and read activeVersion and buildingVersion.","i-lucide-git-compare-arrows",{"title":115,"path":116,"stem":117,"description":118,"icon":119},"Data source","\u002Fdocs\u002Findexing\u002Fdata-source","docs\u002F4.indexing\u002F6.data-source","Let Zaproo download your product feed on a schedule, map it to documents, write only what changed and delete what left the feed.","i-lucide-rss",{"title":121,"description":122,"icon":123,"path":124,"stem":125,"children":126,"page":34},"Integrations","Connect your shop. Magento 2, product feeds and the API work today; more platforms are coming.","i-lucide-plug-zap","\u002Fdocs\u002Fintegrations","docs\u002F4.integrations",[127,133,139,144,150,156,161,166,171,176,181],{"title":128,"path":129,"stem":130,"description":131,"icon":132},"Integrations overview","\u002Fdocs\u002Fintegrations\u002Foverview","docs\u002F4.integrations\u002F01.overview","The ways to get your catalog into Zaproo Search, which one to pick, and how an integration shows up in the cabinet.","i-lucide-layout-grid",{"title":134,"path":135,"stem":136,"description":137,"icon":138},"Magento 2","\u002Fdocs\u002Fintegrations\u002Fmagento","docs\u002F4.integrations\u002F02.magento","Install the Zaproo Search module for Magento 2, connect each store view to its own index, and keep the catalog in sync.","i-lucide-shopping-cart",{"title":140,"path":141,"stem":142,"description":143,"icon":119},"Product feed","\u002Fdocs\u002Fintegrations\u002Fproduct-feed","docs\u002F4.integrations\u002F03.product-feed","Connect any shop that can publish its catalog as a feed. Zaproo downloads it on a schedule and writes only what changed.",{"title":145,"path":146,"stem":147,"description":148,"icon":149},"REST API and MCP","\u002Fdocs\u002Fintegrations\u002Frest-api-and-mcp","docs\u002F4.integrations\u002F04.rest-api-and-mcp","Send documents from your own code with the REST API, or let an AI agent manage the index over MCP.","i-lucide-code",{"title":151,"path":152,"stem":153,"description":154,"icon":155},"Shopify","\u002Fdocs\u002Fintegrations\u002Fshopify","docs\u002F4.integrations\u002F05.shopify","A Zaproo Search integration for Shopify is coming soon. Until then, connect the shop through a product feed or the REST API.","i-lucide-shopping-bag",{"title":157,"path":158,"stem":159,"description":160,"icon":155},"WooCommerce","\u002Fdocs\u002Fintegrations\u002Fwoocommerce","docs\u002F4.integrations\u002F06.woocommerce","A Zaproo Search integration for WooCommerce is coming soon. Until then, connect the shop through a product feed or the REST API.",{"title":162,"path":163,"stem":164,"description":165,"icon":155},"Shopware","\u002Fdocs\u002Fintegrations\u002Fshopware","docs\u002F4.integrations\u002F07.shopware","A Zaproo Search integration for Shopware is coming soon. Until then, connect the shop through a product feed or the REST API.",{"title":167,"path":168,"stem":169,"description":170,"icon":155},"BigCommerce","\u002Fdocs\u002Fintegrations\u002Fbigcommerce","docs\u002F4.integrations\u002F08.bigcommerce","A Zaproo Search integration for BigCommerce is coming soon. Until then, connect the shop through a product feed or the REST API.",{"title":172,"path":173,"stem":174,"description":175,"icon":155},"PrestaShop","\u002Fdocs\u002Fintegrations\u002Fprestashop","docs\u002F4.integrations\u002F09.prestashop","A Zaproo Search integration for PrestaShop is coming soon. Until then, connect the shop through a product feed or the REST API.",{"title":177,"path":178,"stem":179,"description":180,"icon":155},"commercetools","\u002Fdocs\u002Fintegrations\u002Fcommercetools","docs\u002F4.integrations\u002F10.commercetools","A Zaproo Search integration for commercetools is coming soon. Until then, connect the shop through a product feed or the REST API.",{"title":182,"path":183,"stem":184,"description":185,"icon":155},"Salesforce Commerce Cloud","\u002Fdocs\u002Fintegrations\u002Fsalesforce-commerce-cloud","docs\u002F4.integrations\u002F11.salesforce-commerce-cloud","A Zaproo Search integration for Salesforce Commerce Cloud is coming soon. Until then, connect the shop through a product feed or the REST API.",{"title":187,"description":188,"icon":189,"path":190,"stem":191,"children":192,"page":34},"Search and relevance","The search API, search profiles, facets, synonyms and ranking rules.","i-lucide-search","\u002Fdocs\u002Fsearch","docs\u002F5.search",[193,199,205,211,217],{"title":194,"path":195,"stem":196,"description":197,"icon":198},"Search API","\u002Fdocs\u002Fsearch\u002Fsearch-api","docs\u002F5.search\u002F1.search-api","The search request and response, every filter form, sorting, paging, highlighting and the inline profile for previews.","i-lucide-search-code",{"title":200,"path":201,"stem":202,"description":203,"icon":204},"Search profiles","\u002Fdocs\u002Fsearch\u002Fprofiles","docs\u002F5.search\u002F2.profiles","Every setting of a search profile, what it does to results, and the mistakes to avoid.","i-lucide-sliders-horizontal",{"title":206,"path":207,"stem":208,"description":209,"icon":210},"Facets","\u002Fdocs\u002Fsearch\u002Ffacets","docs\u002F5.search\u002F3.facets","The filter panels next to the results, the four facet types, index facets and profile facets, and how a shopper's clicks change the counts.","i-lucide-list-filter",{"title":212,"path":213,"stem":214,"description":215,"icon":216},"Synonyms","\u002Fdocs\u002Fsearch\u002Fsynonyms","docs\u002F5.search\u002F4.synonyms","Let different words find the same products, with equivalent and one-way rules, bulk import and export in the Solr format, and no reindex.","i-lucide-arrow-left-right",{"title":218,"path":219,"stem":220,"description":221,"icon":222},"Ranking rules","\u002Fdocs\u002Fsearch\u002Frules","docs\u002F5.search\u002F5.rules","Change the results for chosen searches. Put products first, hide them, lift or lower a brand, narrow the results or weigh fields differently, on a schedule and per profile.","i-lucide-list-ordered",{"title":224,"description":225,"icon":226,"path":227,"stem":228,"children":229,"page":34},"Autocomplete","Query suggestions as the shopper types.","i-lucide-text-cursor-input","\u002Fdocs\u002Fautocomplete","docs\u002F6.autocomplete",[230],{"title":224,"path":231,"stem":232,"description":233,"icon":226},"\u002Fdocs\u002Fautocomplete\u002Fsuggestions","docs\u002F6.autocomplete\u002F1.suggestions","Query suggestions as the shopper types, built every hour from your own searches, field values and custom entries.",{"title":235,"description":236,"icon":237,"path":238,"stem":239,"children":240,"page":34},"Analytics","Searches, zero-result queries and latency.","i-lucide-chart-line","\u002Fdocs\u002Fanalytics","docs\u002F7.analytics",[241,246,252],{"title":242,"path":243,"stem":244,"description":245,"icon":237},"Search analytics","\u002Fdocs\u002Fanalytics\u002Fsearch-analytics","docs\u002F7.analytics\u002F1.search-analytics","What the analytics page counts, which traffic it leaves out, how the headline numbers are defined, how comparisons and retention work, and how to get the weekly digest.",{"title":247,"path":248,"stem":249,"description":250,"icon":251},"Reports","\u002Fdocs\u002Fanalytics\u002Freports","docs\u002F7.analytics\u002F2.reports","Every analytics report with the definition of each column, the opportunities list and its fix buttons, the per-query view with before and after, and the CSV download.","i-lucide-table",{"title":253,"path":254,"stem":255,"description":256,"icon":257},"Event tracking","\u002Fdocs\u002Fanalytics\u002Fevent-tracking","docs\u002F7.analytics\u002F3.event-tracking","Send clicks, add-to-cart, purchases and suggestion clicks from your storefront, tie them to the search with searchId, and a copy-paste script that does it.","i-lucide-mouse-pointer-click",{"title":259,"description":260,"icon":261,"path":262,"stem":263,"children":264,"page":34},"AI agents (MCP)","Connect Claude Code or any MCP client and manage search from an agent.","i-lucide-bot","\u002Fdocs\u002Fmcp","docs\u002F8.mcp",[265,271,277],{"title":266,"path":267,"stem":268,"description":269,"icon":270},"MCP setup","\u002Fdocs\u002Fmcp\u002Fsetup","docs\u002F8.mcp\u002F1.setup","Connect Claude Code or any MCP client to Zaproo Search and manage indices, documents, profiles, synonyms and ranking rules from your agent.","i-lucide-plug",{"title":272,"path":273,"stem":274,"description":275,"icon":276},"MCP tools","\u002Fdocs\u002Fmcp\u002Ftools","docs\u002F8.mcp\u002F2.tools","Every tool the Zaproo Search MCP server offers, what an agent can do with each group, and prompts to start from.","i-lucide-wrench",{"title":278,"path":279,"stem":280,"description":281,"icon":282},"Resources and prompts","\u002Fdocs\u002Fmcp\u002Fresources","docs\u002F8.mcp\u002F3.resources","The index resources an MCP client can read, the tune_relevance prompt, and the errors the MCP server answers.","i-lucide-library",{"title":284,"description":285,"icon":286,"path":287,"stem":288,"children":289,"page":34},"Reference","Every REST route, every limit, plans and billing, and status.","i-lucide-book-open","\u002Fdocs\u002Freference","docs\u002F9.reference",[290,296,301,307],{"title":291,"path":292,"stem":293,"description":294,"icon":295},"REST API","\u002Fdocs\u002Freference\u002Frest-api","docs\u002F9.reference\u002F1.rest-api","The routes of the Zaproo Search REST API, grouped by area, with who may call it.","i-lucide-list-tree",{"title":297,"path":298,"stem":299,"description":300,"icon":77},"Limits","\u002Fdocs\u002Freference\u002Flimits","docs\u002F9.reference\u002F2.limits","Every size limit, cap and default of the Zaproo Search API in one place, with what happens when you reach it.",{"title":302,"path":303,"stem":304,"description":305,"icon":306},"Plans and billing","\u002Fdocs\u002Freference\u002Fbilling","docs\u002F9.reference\u002F3.billing","The plans, how usage is measured, what happens near a quota, and how plan changes and invoices work.","i-lucide-credit-card",{"title":308,"path":309,"stem":310,"description":311,"icon":312},"Status","\u002Fdocs\u002Freference\u002Fstatus","docs\u002F9.reference\u002F4.status","The status page and the status route, what each service covers and how to use them in your own monitoring.","i-lucide-activity",{"id":314,"title":17,"body":315,"description":20,"extension":550,"meta":551,"navigation":552,"path":18,"seo":553,"stem":19,"__hash__":554},"docs\u002Fdocs\u002F1.getting-started\u002F1.introduction.md",{"type":316,"value":317,"toc":536},"minimark",[318,323,327,330,368,372,375,385,390,395,399,408,412,418,422,435,438,458,462,480,488,492],[319,320,322],"h2",{"id":321},"what-zaproo-search-is","What Zaproo Search is",[324,325,326],"p",{},"Zaproo Search is hosted site search for online shops. You send your product catalog as JSON, decide how it is searched, and your storefront asks the API for results, facets and autocomplete suggestions. Zaproo runs the search engine, keeps the index up to date and records what shoppers search for.",[324,328,329],{},"You can do everything three ways, and they share the same rules and limits:",[331,332,333,347,357],"ul",{},[334,335,336,337,341,342,346],"li",{},"In the ",[338,339,340],"strong",{},"cabinet"," at ",[343,344,345],"a",{"href":345},"\u002Fapp",", with forms, previews and analytics.",[334,348,349,350,341,352,356],{},"Over the ",[338,351,291],{},[353,354,355],"code",{},"https:\u002F\u002Fapi.zaproo-search.com\u002Fv1",", with an API key.",[334,358,359,360,363,364,367],{},"From an ",[338,361,362],{},"AI agent"," such as Claude Code, through the MCP server at ",[353,365,366],{},"https:\u002F\u002Fapi.zaproo-search.com\u002Fmcp",".",[319,369,371],{"id":370},"how-the-pieces-fit","How the pieces fit",[324,373,374],{},"Everything you create sits in one tree. Each level belongs to exactly one parent.",[376,377,383],"pre",{"className":378,"code":380,"language":381,"meta":382},[379],"language-text","Organization            your company: members, roles, plan and billing\n└── Project             one shop or one environment (staging, production)\n    ├── API keys        secret keys for your servers, public keys for browsers\n    └── Index           one catalog in one language: mapping, documents, synonyms, rules\n        ├── Search profiles   how one search box searches the index\n        └── Autocomplete      suggestions while the shopper types\n","text","",[353,384,380],{"__ignoreMap":382},[386,387,389],"h3",{"id":388},"organization","Organization",[324,391,392,393,367],{},"The organization is the account your team shares. It holds the members and their roles, the plan and the invoices. Registering creates an organization named after your company, with you as its owner. See ",[343,394,49],{"href":50},[386,396,398],{"id":397},"project","Project",[324,400,401,402,405,406,367],{},"A project groups the indices and API keys of one shop. Use separate projects for staging and production, so a staging key can never touch production data. Every organization starts with a project called ",[338,403,404],{},"Default",". See ",[343,407,55],{"href":56},[386,409,411],{"id":410},"index","Index",[324,413,414,415,367],{},"An index holds one catalog in one language. Its mapping says which fields exist and what each field may be used for: searching, filtering, facets, sorting or returning. You add, change and delete products by uploading documents, and every upload runs as a task you can follow. See ",[343,416,417],{"href":87},"Indices",[386,419,421],{"id":420},"search-profile","Search profile",[324,423,424,425,428,429,432,433,367],{},"A search profile is the recipe for one search box: which fields a query looks in, typo tolerance, facets, sort orders and fixed filters. Each profile has a ",[353,426,427],{},"profileKey",", and your storefront searches with ",[353,430,431],{},"POST \u002Fv1\u002Fsearch\u002F\u003CprofileKey>",". One index can serve several profiles, for example the shop search page and a B2B catalog. See ",[343,434,200],{"href":201},[386,436,68],{"id":437},"api-keys",[324,439,440,441,444,445,448,449,444,452,455,456,367],{},"API keys let programs call the API. A ",[338,442,443],{},"secret"," key (",[353,446,447],{},"zs_sk_…",") is for your servers and your AI agent. A ",[338,450,451],{},"public",[353,453,454],{},"zs_pk_…",") can only search and suggest, and only from the web origins you list. A storefront searches from the shopper's browser with a public key, or from its server with a read-only secret key. See ",[343,457,68],{"href":69},[319,459,461],{"id":460},"from-catalog-to-search-box","From catalog to search box",[463,464,465,468,471,474,477],"ol",{},[334,466,467],{},"Create an index and pick its language.",[334,469,470],{},"Upload your products as a JSON array. The first upload can map the fields for you.",[334,472,473],{},"Create a search profile: the fields to search, the facets and the sort orders.",[334,475,476],{},"Call the search and suggest routes from your storefront.",[334,478,479],{},"Watch Analytics for queries with no results, then fix them with synonyms and ranking rules.",[324,481,482,484,485,487],{},[343,483,23],{"href":24}," walks through steps 1 to 4 with curl. ",[343,486,29],{"href":30}," shows how a search page, facets and autocomplete call the API.",[319,489,491],{"id":490},"every-topic","Every topic",[493,494,495,501,506,511,516,520,524,528,532],"card-group",{},[496,497,498],"card",{"icon":12,"title":10,"to":24},[324,499,500],{},"A first search in six steps, and wiring search into a storefront.",[496,502,503],{"icon":38,"title":36,"to":44},[324,504,505],{},"Sign-in, devices, organizations, members, roles and projects.",[496,507,508],{"icon":63,"title":61,"to":69},[324,509,510],{},"Secret and public keys, allowed origins, rate limits and errors.",[496,512,513],{"icon":81,"title":79,"to":87},[324,514,515],{},"Indices, languages, mappings, documents, tasks and reindexing.",[496,517,518],{"icon":189,"title":187,"to":195},[324,519,188],{},[496,521,522],{"icon":226,"title":224,"to":231},[324,523,225],{},[496,525,526],{"icon":237,"title":235,"to":243},[324,527,236],{},[496,529,530],{"icon":261,"title":259,"to":267},[324,531,260],{},[496,533,534],{"icon":286,"title":284,"to":292},[324,535,285],{},{"title":382,"searchDepth":537,"depth":537,"links":538},2,[539,540,548,549],{"id":321,"depth":537,"text":322},{"id":370,"depth":537,"text":371,"children":541},[542,544,545,546,547],{"id":388,"depth":543,"text":389},3,{"id":397,"depth":543,"text":398},{"id":410,"depth":543,"text":411},{"id":420,"depth":543,"text":421},{"id":437,"depth":543,"text":68},{"id":460,"depth":537,"text":461},{"id":490,"depth":537,"text":491},"md",{},{"icon":21},{"title":17,"description":20},"imFFgLmnwfPXtu0uNb8hQOhF-j_H16YD5iaYoxc3ss0",[556,557],null,{"title":23,"path":24,"stem":25,"description":26,"icon":27,"children":-1},1792679791124]