Documentation
POST /api/share
Record that the share control was used, unlocking the next find.
| Request | POST /api/share |
|---|---|
| Authentication | Session cookie required |
| Handler | backend/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
| 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.
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
200 — Recorded.
| Field | Type | Description |
|---|---|---|
status | string | `share_recorded`. |
shared | boolean | True. |
url | string | The coded referral link. |
allowance | number | This session's total claim allowance. |
claims_made | number | Claims already made. |
finds_remaining | number | Allowance minus claims made, floored at zero. |
explanation | string | 'Your second find is unlocked.' |
observed | string | What 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
GET /api/ad— The ad artifact for the session's product, with its pass criteria.POST /api/ad/edit— Override the ad copy, or reset it to the generated version.POST /api/growth/edit— Edit a growth artifact in natural language.GET /api/ads-manager— The campaign book.POST /api/ads-manager— Save the campaign book.GET /api/adbalance— The advertising balance, its ledger and any pending top-ups.POST /api/adbalance— Start a balance top-up.GET /api/adbalance/confirm— Retired. Balance confirmation is no longer client-driven.
Back to the API reference index, or read the cookbook for recipes that compose this endpoint with others.