API referencev1
Rank products
/catalog/ranked, /search, /rerank and /suggest.
POST /catalog/ranked
Ranks the catalogue already synced to PULSE.
curl -X POST "https://api.thepulseapi.com/api/v1/catalog/ranked" \
-H "Content-Type: application/json" \
-H "x-api-key: pk_live_..." \
-d '{
"sessionId": "sess_abc123",
"organizationId": "org_abc123",
"limit": 24
}'const { items } = await pulse.rankedCatalog({ limit: 24 });POST /search
Ranks products you pass in, against the session.
const { results } = await pulse.search(products, { limit: 24 });
results[0].scoreBreakdown; // the signals that matched, and their weightsPOST /rerank
Reorders an existing result set you already produced elsewhere, which is the lightest way to put PULSE in front of a search engine you are keeping.
POST /suggest
Query suggestions scored against the current session.
search and rankedCatalog are not interchangeable. One ranks what you hand it, the other
ranks what PULSE holds. Sending a catalogue you already synced to search is a wasted payload.