Quick Start Guide
Get FlowSearch running on your website in under 5 minutes. No backend required.
Before you begin
- • A website (published or in development)
- • Access to add custom code to your site
- • A FlowSearch account — sign up free here
Add your website to FlowSearch
Create your account and register your website domain
- Sign up for FlowSearch (it's free to start)
- Click "Add Website" in your dashboard
- Enter your website domain (e.g.,
preview.example.comor your custom domain) - Click "Start Crawl" — we'll index your pages automatically
Tip: FlowSearch uses your sitemap.xml to discover pages. Make sure your sitemap is enabled in your website settings.
Add the FlowSearch scripts
Add each script to the correct website head/custom-code section
Search Bar Script (all pages)
Open your site-wide head/custom-code area and add this script so search bars work across your site:
<script
src="https://www.flowsearch.io/widget.js"
data-key="YOUR_API_KEY"
data-results-page="/search-results"
data-live="true">
</script>Results Page Script (search results page only)
Create a new website page at /search-results, then open that page's page-specific head/custom-code area and add:
<script
src="https://www.flowsearch.io/results.js"
data-key="YOUR_API_KEY"
data-summary="true">
</script>Some sites already use /search, so use /search-results or another custom slug. If you choose a different slug, update data-results-page to match it. data-summary="true" enables the initial AI Summary; follow-up chat appears only on paid-plan sites.
Where to find your API key: Go to your FlowSearch dashboard → Select your website → Click "Integration" tab. Your API key will be displayed there.
Add data attributes to your elements
Tell FlowSearch which elements to enhance
FlowSearch works with your existing website elements. Add HTML with an HTML/custom-code block, or build the elements with your site's normal elements and add these data attributes:
<!-- Search Bar HTML -->
<form data-fs-search>
<input data-fs-input type="text" placeholder="Search..." />
<button data-fs-submit type="submit">Search</button>
</form>
<!-- Results Page HTML, on /search-results only -->
<div data-fs-results>
<a data-fs-result data-fs-url href="#">
<h3 data-fs-title></h3>
<p data-fs-snippet></p>
</a>
</div>
<div data-fs-pagination></div>In site editor:
- Select your search input element
- Open the Settings panel (gear icon)
- Scroll to Custom Attributes
- Add attribute: Name =
data-fs-input, Value = (leave empty) - Repeat for the form, submit button, results container, and result template attributes
data-fs-inputYour text input for search queries
data-fs-resultsContainer where results appear
data-fs-submitOptional button to trigger search
That's it! You're done!
Publish your site and enjoy instant search
Publish your website and try searching. You should see:
- Results appearing as you type
- Typo correction (try misspelling something!)
- Keyboard navigation with arrow keys
- Clickable results that link to your pages
What's Next?
Need help?
If something isn't working as expected, check our troubleshooting guide, open Dashboard Help & Support, or email us at support@flowsearch.io.