Documentation

GET /api/health

Liveness, and which build is answering.

RequestGET /api/health
AuthenticationNo authentication
Handlerflowfinds-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

200Always.

FieldTypeDescription
okbooleanTrue.
buildIdstringThe 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

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