Documentation
GET /api/health
Liveness, and which build is answering.
| Request | GET /api/health |
|---|---|
| Authentication | No authentication |
| Handler | flowfinds-organ/app/api/health/route.ts |
What it does
Answers `ok` and the build identifier the deployment was built with, so a caller can tell which revision responded. `dev` when the build id is not set.
Authentication
No authentication. The response does not depend on a session.
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.
curl -s -b cookies.txt -c cookies.txt \
"https://flowfinds.ai/api/health"const res = await fetch("https://flowfinds.ai/api/health", {
method: "GET",
credentials: "include",
});
const data = await res.json();import requests
s = requests.Session()
r = s.get("https://flowfinds.ai/api/health")
data = r.json()Recorded example
curl -s -b cookies.txt -c cookies.txt \
"$FLOWFINDS_ORIGIN/api/health"Responses
200 — Always.
| Field | Type | Description |
|---|---|---|
ok | boolean | True. |
buildId | string | The build identifier, or `dev`. |
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.
Related
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.GET /api/walkthrough— The walkthrough's steps and this user's position in it.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.
Back to the API reference index, or read the cookbook for recipes that compose this endpoint with others.