POST /api/analyze

Request	`POST /api/analyze`
Authentication	Session cookie required
Handler	`backend/server.py`

What it does

Analyse a product that is not in the catalog and not held. The analyser returns a verdict with its basis; it does not create a claim, a hold or a catalog entry.

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

Parameter	In	Type	Required	Description
`ff_session`	cookie	`string`	Optional	The 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.
`name`	body	`string`	Required	The product's name.
`description`	body	`string`	Required	What the product is. An empty or unusable description is refused by name.
`id`	body	`string`	Optional	An identifier to attach to the result, when analysing something the caller already tracks.

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 \
  -X POST -H 'Content-Type: application/json' \
  -d '{"name":"<string>","description":"<string>","id":"<string>"}' \
  "https://flowfinds.ai/api/analyze"

const res = await fetch("https://flowfinds.ai/api/analyze", {
  method: "POST",
  credentials: "include",
  headers: { "Content-Type": "application/json" },
  body: JSON.stringify({
    "name": "<string>",
    "description": "<string>",
    "id": "<string>"
  }),
});
const data = await res.json();

import requests

s = requests.Session()
r = s.post("https://flowfinds.ai/api/analyze", json={
    "name": "<string>",
    "description": "<string>",
    "id": "<string>"
  })
data = r.json()

Recorded example

curl -s -b cookies.txt -c cookies.txt \
  -X POST -H 'Content-Type: application/json' \
  -d '{"name":"…","description":"…"}' \
  "$FLOWFINDS_ORIGIN/api/analyze"

Responses

`200` — The analyser produced a verdict, or refused with a named reason such as `nothing_to_analyze` or `invalid_description`.

Errors

Status	Reason	When
`400`	—	The body is not JSON.

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.
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.
GET /api/discovery-research — Read the state of the external discovery research job.

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