Documentation

POST /api/notify_me

Watch a product that is currently unavailable.

RequestPOST /api/notify_me
AuthenticationSession cookie required
Handlerbackend/server.py

What it does

Places a watch on a product held or claimed by someone else. `/api/offer` closes the watch when the offer it was waiting on becomes real — the place that observes the change is the place that resolves the watch.

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.
emailbodystringRequiredWhere to send the notice.
product_idbodystringRequiredThe product to watch.

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 \
  -X POST -H 'Content-Type: application/json' \
  -d '{"email":"<string>","product_id":"<string>"}' \
  "https://flowfinds.ai/api/notify_me"
const res = await fetch("https://flowfinds.ai/api/notify_me", {
  method: "POST",
  credentials: "include",
  headers: { "Content-Type": "application/json" },
  body: JSON.stringify({
    "email": "<string>",
    "product_id": "<string>"
  }),
});
const data = await res.json();
import requests

s = requests.Session()
r = s.post("https://flowfinds.ai/api/notify_me", json={
    "email": "<string>",
    "product_id": "<string>"
  })
data = r.json()

Recorded example

curl -s -b cookies.txt -c cookies.txt \
  -X POST -H 'Content-Type: application/json' \
  -d '{"email":"[email protected]","product_id":"…"}' \
  "$FLOWFINDS_ORIGIN/api/notify_me"

Responses

200The watch was recorded, or refused by name (`nothing_to_watch`, `invalid_email`).

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.