Documentation

POST /api/share

Record that the share control was used, unlocking the next find.

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

What it does

Using the control is the observation; the response says so in `observed` rather than implying the link was seen by anyone. Unlocking the second find is what this endpoint actually does, and `finds_remaining` states the result.

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

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

Recorded example

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

Responses

200Recorded.

FieldTypeDescription
statusstring`share_recorded`.
sharedbooleanTrue.
urlstringThe coded referral link.
allowancenumberThis session's total claim allowance.
claims_madenumberClaims already made.
finds_remainingnumberAllowance minus claims made, floored at zero.
explanationstring'Your second find is unlocked.'
observedstringWhat was actually observed — the control being used.

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

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