Headband documentation
Everything you need to add search with Headband: one REST API in front of Meilisearch, Typesense, Elasticsearch and Visor, where each index picks its own engine. Start with Getting started, or jump to a topic below.
Start here
Keys and access
- AuthenticationAPI key types, the bearer header, and what admin vs. search keys can do.
- Tenant tokensLet each of your customers search from the browser and see only its own documents, with a signed token and a filter Headband forces.
- BranchesA separate copy of a project's search data per environment, like a database branch for a preview deploy.
Indexes and documents
- IndexesCreate, list, fetch, and delete indexes across Meilisearch, Typesense, Elasticsearch and Visor.
- Index settingsRead and update per-index search settings and see what each engine supports.
- DocumentsAdd, list, fetch, delete, and bulk-import documents into an index.
- TasksPoll asynchronous write tasks by UID until they succeed or fail.
Search
- SearchSearch endpoint parameters, filters, facets, sorting, and highlighting.
- Multi-searchRun multiple search queries against one or more indexes in a single request.
- Hybrid searchCombine keyword and vector search in a single hybrid query.
- AI search (RAG)Retrieval-augmented search: the AI search endpoint and its response format.
- Click feedbackRecord which results people click and buy, per query, and move those results up for that query.
- Try other settings
- A/B test enginesSplit traffic between two engines or two settings: hosted assignment, tagged searches, outcome events and results.
Engines
- Engine compatibilityFeature-by-feature compatibility matrix and sizing guidance across engines.
- Index into more than one engineThe same data in Meilisearch, Typesense, Elasticsearch and Visor side by side: equivalent settings and what does not carry over.
- VisorZVN's own engine: instant and retrieval search modes on one index, where it runs, and what it supports.
- Dedicated enginesPrivate Meilisearch, Typesense, Elasticsearch and Visor servers: create, connect, keys, cold starts and limits.
- BurstMore CPU for your engine within a minute when search traffic spikes, given back when the spike ends.
- Native clients (api.headband.dev)Keep the official client you use: every engine's own API at api.headband.dev, one branch key per environment, Laravel Scout included.
Build with Headband
- React SDKInstall the React SDK, use the provider, hooks, and components, and see a full example.
- Framework recipesFramework recipes, and sync connector scripts for Postgres, MySQL, Shopify, Stripe and BataDB.
- SyncKeep a search index in step with your Postgres tables: sources, setup SQL, definitions, pause, rebuild and delete. Early access.
- CLIInstall the headband command, log in with a device code, and manage indexes, engines, Sync and schema from your terminal.
- MCP serverSet up the Headband MCP server and see the tools and resources it exposes.
- llms.txtServe an llms.txt file describing your indexes for LLM crawlers.