Headband Documentation

What Headband is, core concepts, and how to get your first index searching in minutes.

API key types, the bearer header, and what admin vs. search keys can do.

Create, list, fetch, and delete indexes across Meilisearch, Typesense, and Elasticsearch.

Read and update per-index search settings and see what each engine supports.

Add, list, fetch, delete, and bulk-import documents into an index.

Search endpoint parameters, filters, facets, sorting, and highlighting.

Run multiple search queries against one or more indexes in a single request.

Poll asynchronous write tasks by UID until they succeed or fail.

Retrieval-augmented search: the AI search endpoint and its response format.

Combine keyword and vector search in a single hybrid query.

Conversational search over your indexes, providers, and conversation state.

Set up the Headband MCP server and see the tools and resources it exposes.

Serve an llms.txt file describing your indexes for LLM crawlers.

Copyable integration recipes, sync connectors, A/B testing, and managed experiment rules.

Install the React SDK, use the provider, hooks, and components, and see a full example.

Feature-by-feature compatibility matrix and sizing guidance across engines.

Error response shape and status codes returned by the API.