Documentation

POST /api/presence

Record which screen the operator is on.

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

What it does

A presence ping. Used to decide when a surface is worth polling for new inbound work.

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.
areabodystringRequiredThe product area — for example `growth` or `activity`.
screenbodystringRequiredThe screen within that area.

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' \
  -d '{"area":"<string>","screen":"<string>"}' \
  "https://flowfinds.ai/api/presence"
const res = await fetch("https://flowfinds.ai/api/presence", {
  method: "POST",
  credentials: "include",
  headers: { "Content-Type": "application/json" },
  body: JSON.stringify({
    "area": "<string>",
    "screen": "<string>"
  }),
});
const data = await res.json();
import requests

s = requests.Session()
r = s.post("https://flowfinds.ai/api/presence", json={
    "area": "<string>",
    "screen": "<string>"
  })
data = r.json()

Recorded example

curl -s -b cookies.txt -c cookies.txt \
  -X POST -H 'Content-Type: application/json' \
  -d '{"area":"growth","screen":"ads"}' \
  "$FLOWFINDS_ORIGIN/api/presence"

Responses

200Recorded.

FieldTypeDescription
statusstring`recorded`.

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.