GET /api/research-workspace

Request	`GET /api/research-workspace`
Authentication	Session cookie required
Handler	`backend/external_discovery.py`

What it does

The persisted workspace behind external discovery: what has been researched and what state each item is in.

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.

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/research-workspace"

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

import requests

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

Recorded example

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

Responses

`200` — The workspace was read.

Errors

Status	Reason	When
`401`	—	The session has no account.

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.