Documentation

POST /api/research-workspace

Mutate the research workspace.

RequestPOST /api/research-workspace
AuthenticationSession cookie required
Handlerbackend/external_discovery.py

What it does

Applies a change to the workspace. Conflicting mutations are refused with 409 rather than silently resolved.

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.

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

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

Recorded example

curl -s -b cookies.txt -c cookies.txt \
  -X POST -H 'Content-Type: application/json' \
  -d '{}' \
  "$FLOWFINDS_ORIGIN/api/research-workspace"

Responses

200The change was applied.

Errors

StatusReasonWhen
400The body is not JSON or the change is not understood.
401The session has no account.
409The change conflicts with the workspace's current state.

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.