GET /api/walkthrough

Request	`GET /api/walkthrough`
Authentication	Session cookie optional
Handler	`flowfinds-organ/app/api/walkthrough/route.ts`

What it does

Serves the step list and where the caller has reached. When the feature flag is off the response is `{ enabled: false }` and nothing else — the client is told the feature is absent rather than being given an empty walkthrough.

Authentication

Session cookie optional. The endpoint answers with or without ff_session, but the body is scoped to the session when one is present.

Parameters

This endpoint takes no parameters.

Request

The cookie jar carries the session between calls. Angle-bracketed values are the parameter types from the table above.

cURLJavaScriptPython

curl -s -b cookies.txt -c cookies.txt \
  "https://flowfinds.ai/api/walkthrough"

const res = await fetch("https://flowfinds.ai/api/walkthrough", {
  method: "GET",
  credentials: "include",
});
const data = await res.json();

import requests

s = requests.Session()
r = s.get("https://flowfinds.ai/api/walkthrough")
data = r.json()

Recorded example

curl -s -b cookies.txt -c cookies.txt \
  "$FLOWFINDS_ORIGIN/api/walkthrough"

Responses

`200` — The feature is off.

Field	Type	Description
`enabled`	`boolean`	False.

`200` — The feature is on.

Field	Type	Description
`enabled`	`boolean`	True.
`authenticated`	`boolean`	Whether a user was resolved.
`stepIndex`	`number`	Position in the walkthrough. 0 for an unauthenticated caller.
`dismissedAt`	`string \| null`	When it was dismissed.
`complete`	`boolean`	Whether it has been finished.
`steps`	`array`	`id`, `label` and `prompt` per step.
`total`	`number`	How many steps there are.

Errors

This endpoint has no failure path of its own. An uncaught exception anywhere in the engine is still returned as structured JSON by the shared guard.

POST /api/intent — Ask the commerce assistant, or resolve a navigation intent.
POST /api/pages — Generate a page from an intent.
POST /api/journey — Issue a single-use journey carrier.
POST /api/journey/[id]/consume — Redeem a journey carrier once.
POST /api/walkthrough/advance — Move forward or back a step.
POST /api/walkthrough/dismiss — Dismiss the walkthrough.
POST /api/auth/request-link — Request a magic sign-in link.
GET /api/auth/callback — Redeem a magic link.

Back to the API reference index, or read the cookbook for recipes that compose this endpoint with others.