Introduction

What Zaproo Search is

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.

You can do everything three ways, and they share the same rules and limits:

• In the cabinet at /app, with forms, previews and analytics.
• Over the REST API at https://api.zaproo-search.com/v1, with an API key.
• From an AI agent such as Claude Code, through the MCP server at https://api.zaproo-search.com/mcp.

How the pieces fit

Everything you create sits in one tree. Each level belongs to exactly one parent.

Organization            your company: members, roles, plan and billing
└── Project             one shop or one environment (staging, production)
    ├── API keys        secret keys for your servers, public keys for browsers
    └── Index           one catalog in one language: mapping, documents, synonyms, rules
        ├── Search profiles   how one search box searches the index
        └── Autocomplete      suggestions while the shopper types

Organization

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 Organizations, members and roles.

Project

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 Default. See Projects.

Index

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 Indices.

Search profile

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 profileKey, and your storefront searches with POST /v1/search/<profileKey>. One index can serve several profiles, for example the shop search page and a B2B catalog. See Search profiles.

API keys

API keys let programs call the API. A secret key (zs_sk_…) is for your servers and your AI agent. A public key (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 API keys.

From catalog to search box

1. Create an index and pick its language.
2. Upload your products as a JSON array. The first upload can map the fields for you.
3. Create a search profile: the fields to search, the facets and the sort orders.
4. Call the search and suggest routes from your storefront.
5. Watch Analytics for queries with no results, then fix them with synonyms and ranking rules.

Quickstart walks through steps 1 to 4 with curl. Integrate a storefront shows how a search page, facets and autocomplete call the API.

Every topic