Skip to main content

Releases

Track public documentation and API-surface changes here.

Current Public API​

The current public API includes:

  • POST /api/v1/snap for Predict Profile.
  • POST /api/v1/snap/comms for Analyse Comms.
  • API-key-only authentication through x-api-key.

Documentation Updates​

Global Rate Limiting​

  • POST /api/v1/snap and POST /api/v1/snap/comms are now rate-limited to 120 requests per minute, tracked per client IP address (not per API key).
  • Documented the X-RateLimit-Limit / X-RateLimit-Remaining / X-RateLimit-Reset response headers, the 429 error shape, and the Retry-After header in Authentication, with error cases added to Predict Profile and Analyse Comms.
  • Requests authenticated with a valid dashboard session (JWT) are exempt from this limit; API-key requests are not.

API Credits Tab Moved Off The Developer Console​

  • The API Credits tab moved from the Developer Console (/dashboard/developers) to the new Subscription & Billing page (/dashboard/subscription?tab=credits, tab label unchanged). The Developer Console now only has Overview and API Keys tabs.
  • Updated the API credits dashboard link, Getting Started, and Overview to point to the correct page.
  • No change to API key management (/dashboard/developers?tab=api) or to the public API surface.

API Credits: Subscription Plans & Packs Replace Payment Methods​

  • Removed the Payment Methods dashboard tab and card-on-file billing flow — replaced by a single API Credits tab (?tab=credits) covering plans, packs, and billing history, checked out through Stripe with no card-on-file prerequisite.
  • Documented the new recurring credit plans (Starter, Core, Growth, Scale — monthly or yearly) and one-time credit packs (Small, Medium, Large) in Getting Started and Overview.
  • Documented per-call API credit costs for the first time: Predict Profile costs 1 credit per call, Analyse Comms costs 2 credits per call (both snapId and primaryCode requests).
  • The API Keys & Credits tab was split into API Keys and API Credits — updated tab references throughout the docs.
  • The Insufficient API Credits error response (400) and its exact message are unchanged.
  • Request and response bodies for POST /api/v1/snap and POST /api/v1/snap/comms are unchanged by this update.

Analyse Comms: Profile Code Support​

  • POST /api/v1/snap/comms now accepts a primaryCode (+ optional secondaryCode) as an alternative to snapId.
  • Added the Decision Profile Codes reference table (DP-01–DP-07).
  • Documented that secondaryCode cannot be DP-07 (Visionary), and that snapId/primaryCode are mutually exclusive.
  • Documented the commsId: null response shape returned when analysing via profile code (no comms record is persisted).

Initial API Documentation​

  • Added a professional docs homepage.
  • Documented API-key authentication.
  • Documented Predict Profile and Analyse Comms.
  • Removed generic starter documentation.