GET /api/brief

Request	`GET /api/brief`
Authentication	No authentication
Handler	`backend/server.py`

What it does

`ran` is false when no brief has ever been written on this machine — a different fact from a brief that ran and found nothing, and the screen says which. Public.

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.

cURLJavaScriptPython

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

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

import requests

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

Recorded example

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

Responses

`200` — Always.

Field	Type	Description
`status`	`string`	`ok`.
`ran`	`boolean`	False when the nightly job has never produced a brief here.
`date`	`string \| null`	The brief's date, when one exists.

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.

GET /api/find — Serve this session's product, minting a hold if it does not have one.
GET /api/feed — Serve the whole field: this session's find first, then what it beat.
POST /api/select — Move this session's hold onto a named product from the field.
POST /api/pass — Claim the held product, or pass on it and be shown the next one.
POST /api/analyze — Run the analyser over any product description, claimed or not.
GET /api/analysis — The analysis of the product this session holds.
POST /api/ask — Ask a question against one or more catalog products.
POST /api/discover — Run the discovery script and return its terminal output verbatim.

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