Documentation

Add Hopfield search to your site

Hopfield gives you hosted, AI-powered site search: automatic crawling, hybrid semantic + keyword ranking, typeahead, and analytics, with SDKs and a REST API. Pick a guide below and you can be live in a few minutes.

How it fits together

A collection holds your indexed content. Point it at a sitemap and Hopfield crawls and embeds every page automatically, or push records yourself with the indexing API. Your site then queries the index through a public API key, using the search widget, an SDK, or plain HTTP.

Everything shares one index: the React widget, the Vue composable, server-side calls from Node, and the REST endpoints all return the same ranked results.

Start here

QuickstartCreate a collection, index your site, and run your first search in ~5 minutes.ReactDrop in the <Search /> widget or build a custom UI with hooks.Next.jsApp Router integration with server and client components.VueUse the @hopfield/vue composables in any Vue 3 app.Node & ExpressServer-side search, proxy routes, and admin indexing.ShopifyAdd semantic storefront search to a Shopify theme.REST APISearch, typeahead, and AI answers over plain HTTP.Indexing APIManually index pages, records, and shortcuts.

Keys and authentication

Browser-side reads use a public API key (x-hopfield-public-api-key) that is safe to ship to clients and scoped to allowed origins. Server-side writes (creating and deleting records) use your admin token (x-hopfield-admin-token), which must never leave your backend. Create public keys in the dashboard under Search → Settings.