IntentFlow Documentation

IntentFlow helps merchants add intent-aware product autocomplete to a storefront without rebuilding their commerce platform. Merchants upload or sync a product catalog, generate a store API key, place the widget script on their storefront, and serve search suggestions from the IntentFlow API.

This documentation is intentionally high-level in the first pass. Sections marked TODO or PLACEHOLDER should be filled with production values before the docs are published.

Who this is for

Audience	Start here	Goal
Merchant operators	Journey Search	Understand the flagship search journey experience and rollout options.
Merchant operators	Setup	Create a store, import products, and install the widget.
Storefront developers	Widget Placement	Place and configure the JavaScript widget.
Backend developers	Developer API	Call the autocomplete API directly or build platform integrations.
Integration partners	Integrations	Connect ecommerce platforms and catalog feeds.

Core workflow

1. Create a store with the correct domain, language, and currency.
2. Add products through CSV import or an integration.
3. Generate a store API key.
4. Add the widget script to the storefront search page, header, or theme template.
5. Test autocomplete suggestions, category chips, and product results on the live storefront.
6. Monitor aggregate analytics, improve product metadata, and rotate keys when needed.

Documentation status

Area	Status	Notes
Merchant setup	Draft	Needs screenshots and final dashboard labels.
Product index	Draft	Needs final CSV templates and limits.
Journey Search	Draft	Defines positioning, modules, setup, privacy, and packaging.
Widget placement	Draft	Includes current script-tag contract.
API reference	Draft	Includes detailed endpoint placeholders for developers.
Integrations	Placeholder	Platform-specific guides still need production steps.

Placeholder checklist

• Replace https://app.example.com with the production application URL.
• Replace sample store UUIDs, API keys, product IDs, and domains.
• Add screenshots for each merchant dashboard step.
• Confirm final request limits, cache behavior, and error envelope.
• Add SDK, plugin, and platform-specific examples as they become available.