Documentation

GET /api/curriculum

Curriculum material for a named subject.

RequestGET /api/curriculum
AuthenticationSession cookie required
Handlerbackend/curriculum.py

What it does

Serves curriculum entries for the query. With no question the engine abstains by name rather than serving a default.

Authentication

Session cookie required. Send the ff_session cookie. Without one the engine treats the caller as a new visitor with no holds and no claims, and returns a new cookie to use from then on.

Parameters

ParameterInTypeRequiredDescription
ff_sessioncookiestringOptionalThe session identifier. Omit it on the first call and store the value the response sets; every later call must send the same one or the engine treats the caller as a new visitor with no holds and no claims.
qquerystringOptionalThe subject. Absent or empty produces `abstained` / `no_question`.

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/curriculum"
const res = await fetch("https://flowfinds.ai/api/curriculum", {
  method: "GET",
  credentials: "include",
});
const data = await res.json();
import requests

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

Recorded example

curl -s -b cookies.txt -c cookies.txt \
  "$FLOWFINDS_ORIGIN/api/curriculum?q=…"

Responses

200Material was found.

200No question was asked.

FieldTypeDescription
statusstring`abstained`.
reasonstring`no_question`.
explanationstringThe reason's sentence.

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

  • 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.