Assistant API

Use the Assistant API when you want full control over a structured question-and-answer product discovery flow. Start with the implementation guide when you are planning the flow, use the quickstart when you want a hands-on build, then use the technical reference for the exact request and response schema.

Guides

Implementation flow

Plan request state, rendering, history behavior, runtime fields, and completion handling.

Analytics

Connect assistant flow data to downstream product clicks, cart actions, and conversion metrics.

Quickstarts

Build a custom shopping assistant

Learn how to manage assistant state, render questions, keep hit payloads lean, and apply runtime field overrides.

API reference

Assistant API endpoint

Run an assistant flow, send the current answers, and receive matching hits plus the next question.