Integrations

Search that fits the stack you already ship.

Headband gives developers one retrieval API, then meets them where they are: React, server-rendered apps, relational databases, commerce systems, webhooks, and A/B/C search experiments.

Adoption path

  1. 01 Pick a framework recipe for the UI.
  2. 02 Sync source data into one or more indexes.
  3. 03 Run A/B/C retrieval experiments before a full rollout.
Start with the React SDK
Framework recipes

UI paths for modern app stacks

Live means a first-party package or endpoint exists today. Recipe means the pattern is documented and uses stable REST/SDK primitives.

Next.js + React

Live

Use @headband/react in App Router or Pages Router search surfaces.

npm i @headband/react
server componentsclient searchfacets

Remix / React Router

Recipe

Call the REST API from loaders/actions and hydrate client-side refinements.

npm i @headband/react
loadersactionsedge-ready

Astro

Recipe

Render static catalog shells and hydrate Headband search islands only where needed.

npm i @headband/react
islandsstaticcommerce

SvelteKit

Recipe

Use fetch against /v1/search from load functions or progressive-enhanced forms.

npm i @headband/client
loadformstypescript

Rails / Laravel / Django

Recipe

Index relational records with sync scripts, then render server-owned search pages.

curl https://headband.dev/api/v1/search
server-renderedpostgresmysql
Sync connectors

Get source data into search safely

Postgres / Neon / Supabase

Recipe

Run a scheduled SQL export into /v1/bulk, then validate with /v1/search.

Sync model

script

Env: DATABASE_URL, HEADBAND_URL, HEADBAND_ADMIN_KEY

MySQL / PlanetScale

Recipe

Map table rows into documents and batch them through the Headband bulk API.

Sync model

script

Env: MYSQL_URL, HEADBAND_URL, HEADBAND_ADMIN_KEY

Shopify

Recipe

Use product webhooks or scheduled exports to keep catalog search fresh.

Sync model

webhook

Env: SHOPIFY_ADMIN_TOKEN, HEADBAND_ADMIN_KEY

Stripe catalog

Recipe

Mirror products/prices into an index for account portals, docs, and internal tools.

Sync model

webhook

Env: STRIPE_SECRET_KEY, HEADBAND_ADMIN_KEY

Hosted connector scheduler

Roadmap

Managed scheduling, retries, logs, and secret storage belong in the connector runtime roadmap.

Sync model

managed-roadmap

A/B/C testing

Experiment with retrieval before betting the product on it.

Use Headband indexes as experiment variants, split traffic in your app, and write analytics events with the variant name. Your app owns traffic allocation; Headband supplies stable search endpoints, and your product analytics remains the source of truth for conversion.

route by variant keep rollback simple

Engine A/B/C test

Recipe

Split traffic across Meilisearch, Typesense, and Elasticsearch indexes for the same corpus.

Metrics: conversion, zero_result_rate, p95_latency_ms

Ranking rules test

Recipe

Compare synonyms, typo tolerance, filters, and boosts without changing client code.

Metrics: click_through_rate, add_to_cart_rate, search_exit_rate

Hybrid/RAG quality test

Recipe

Compare lexical, vector, and hybrid retrieval before rolling a RAG flow to everyone.

Metrics: answer_acceptance, grounding_failure, latency_ms