API Changelog

Track changes to the NotAI Public REST API across versions.

Nov 22, 20261.0.55.0

Minor fixes and improvements

Nov 22, 20261.0.54.0

Minor fixes and improvements

Nov 21, 20261.0.53.0

Documentation and site updates (no API changes).

Nov 21, 20261.0.53.0

Minor fixes and improvements

Nov 21, 20261.0.52.0

Changes

  • Security scheme bearer_auth bearer format updated: Not AI API key (aik_v1_*) → NotAI API key (aik_v1_*)
  • API description text updated
  • The spec names the product NotAI: info.title is "NotAI Public REST API", and the description, the contact name and the API key's bearer format ("NotAI API key (aik_v1_*)") follow. No route, field, status code or behavior changed.
  • A test delivery (POST /v1/webhooks/{subscriptionId}/test) now carries data.message "This is a test webhook delivery from the NotAI Public REST API." Recognise a test delivery by data.test being true, never by the text of its message.
Nov 21, 20261.0.51.0

Changes

  • Added new optional field: remoteMcp
Nov 21, 20261.0.50.0

Minor fixes and improvements

Nov 13, 20261.0.49.0

Breaking

  • Changed botAt minimum: 0 → 50

Other Changes

  • Added response code
Nov 9, 20261.0.48.0

Minor fixes and improvements

Nov 7, 20261.0.47.0

Changes

  • New response on every API-key route: 503 with the error code AUTH_UNAVAILABLE and a Retry-After header. It means the key check itself could not complete, for example during a brief storage outage. It says nothing about whether the key is valid, so do not rotate or discard the key. Wait the number of seconds in Retry-After and send the same request again: the request was refused before it ran, so the retry is safe on every route. See Error Handling and Authentication.
  • Every 401 (MISSING_API_KEY, INVALID_API_KEY) is now the answer of a completed key check. A failed check used to answer 401 too, which looked like a revoked key.
Nov 7, 20261.0.45.0

Documentation and site updates (no API changes).

Nov 7, 20261.0.45.0

Changes

  • Parameter cursor description updated on GET /v1/users
Nov 4, 20261.0.44.0

Minor fixes and improvements

Nov 4, 20261.0.43.0

Minor fixes and improvements

Nov 3, 20261.0.41.0 – 1.0.42.0

Changes

  • Parameter cursor description updated on GET /v1/users/{userId}/sessions and 2 other endpoints
Oct 26, 20261.0.39.0 – 1.0.40.0

Changes

  • Added new optional field: emptySessions
  • Added new optional field: emptySessionsToday
  • GET /v1/stats: totalSessions and sessionsToday leave out sessions that closed without recording any activity, and two new fields count them: emptySessions and emptySessionsToday. totalSessions + emptySessions is every session, the value totalSessions had before. GET /v1/analytics already left these sessions out.
  • GET /v1/stats: botsDetected now counts sessions at or above the platform's fixed bot flag (botScore 0.70 or higher), the rule behind the session status flagged. This is a correction to match the documented 0.70 rule: it counted from 0.50, so the number can be lower. It still does not follow your risk thresholds.
  • GET /v1/usage?metric=... now returns the metered rows for that metric. A filtered request returned an empty list; unfiltered requests are unchanged.
  • GET /v1/stats averageBotScore and GET /v1/users averageBotScore and maxBotScore never round up onto 0.40 or 0.70 when the score is below it: 0.6999 reads 0.69. averageBotScore in GET /v1/stats averages numeric scores only. When that average sits on 0.40 or 0.70, the scores are read again (up to 200,000) so the exact mean decides: 0.4, 0.71 and 0.99 still read 0.70. If that second read fails or there are more scores, the first average stands, and an exact 0.70 can read 0.69.
  • GET /v1/users: a stored score of NaN no longer fails the page. It is skipped: the user's average and peak come from the other scores, or read 0 when there are none.
Oct 21, 20261.0.36.0 – 1.0.38.0

Changes

  • Added response code
  • Parameter cursor description updated on GET /v1/users/{userId}/sessions and 2 other endpoints
  • Parameter status description updated on GET /v1/sessions
  • Parameter botOnly description updated on GET /v1/sessions
  • GET /v1/analytics and GET /v1/users now follow your integration's risk thresholds, set with PUT /v1/settings/risk-thresholds (defaults: mediumAt 40, botAt 70). An integration that never set them sees no change. Each response uses the thresholds read for it: normally the saved values; if the primary read fails, a regional copy can briefly still return the previous values, and if no read succeeds in time the response uses the defaults and still succeeds.
  • GET /v1/analytics: summary.uniqueBots, timeSeries[].botCount and topOrigins[].botPercentage count sessions whose botScore is at or above botAt. The botDetection bands follow the same thresholds: highConfidenceBots starts at the higher of botAt and 0.90, mediumConfidenceBots runs from botAt up to that, lowConfidenceBots from mediumAt up to botAt, and likelyHumans is below mediumAt or unscored.
  • GET /v1/users: riskLevel (high at or above botAt, medium from mediumAt up to botAt, low below mediumAt or unscored), botSessionCount and mediumSessionCount use the same thresholds on each user's raw session botScore.
  • Unchanged, still on the platform's fixed bot flag (botScore 0.70 or higher): the botOnly filter and the session status flagged of GET /v1/sessions, and BotDetected webhooks.
  • Unchanged: botsDetected in GET /v1/stats keeps its own fixed platform rule and does not follow the risk thresholds.
Oct 20, 20261.0.35.0

Minor fixes and improvements

Oct 17, 20261.0.34.0

Minor fixes and improvements

Oct 15, 20261.0.32.0 – 1.0.33.0

Minor fixes and improvements

Sep 25, 20261.0.31.0

Minor fixes and improvements

Sep 10, 20261.0.30.0

Minor fixes and improvements

Sep 9, 20261.0.29.0

Documentation and site updates (no API changes).

Aug 30, 20261.0.29.0

Documentation and site updates (no API changes).

Aug 28, 20261.0.29.0

Changes

  • Added new optional field: subsystems
  • Added new optional field: edgeAuthSnapshotAgeSeconds
  • New schema healthSubsystems added
Aug 15, 20261.0.28.0

Documentation and site updates (no API changes).

Aug 15, 20261.0.28.0

Documentation and site updates (no API changes).

Aug 15, 20261.0.28.0

Changes

  • Fixed: webhook threshold subscriptions now work end to end. Previously, threshold conditions (pass/block score cutpoints) could be stored corrupted, causing threshold-filtered deliveries to fail and threshold subscriptions to error on read.
  • Spec correction: nullability is now annotated accurately across request and response schemas (response fields that can return null, and optional request fields such as notes and session label properties, are marked nullable).
  • Schema documentation refactor: existing schema references (webhook threshold, subscription tier info) are wrapped in allOf so nullability can be attached. Wire shapes are unchanged; the automated differential showed the wrapping as field removals and additions.
Aug 14, 20261.0.26.0

Changes

  • Webhook event payload schemas are now fully documented: botDetectedPayload, sessionAnomalyPayload, thresholdExceededPayload, alertTriggeredPayload, reportReadyPayload, sessionCorrelatedPayload, and writingSessionScoredPayload.
  • API key header authentication (x-api-key) is now documented as an accepted alternative to Authorization: Bearer on every endpoint. Both methods have always been accepted; earlier specs documented only Bearer.
  • Spec correction: webhook eventType and lastDeliveryStatus are documented as their string names (for example botDetected, delivered). The API has always sent strings; earlier specs misdocumented these fields as integers.
  • Spec correction: required/optional flags and validation constraints now match server behavior exactly across request and response schemas (webhook url and eventType, error code/message/details, session label isBot, risk thresholds, notes length cap, timestamp formats). No server-side validation changed.
  • Spec cleanup: removed the phantom jsonElement schema and its valueKind/item fields, a serializer artifact that never appeared on the wire and previously left webhook schemas unresolvable.
  • The allowed values of the status filter on GET /v1/sessions and the enum/default semantics of the session label confidence field are now documented (both existed before; their constraints were unspecified).
  • API description text updated (the spec no longer claims the API is read-only; it declares its write operations).
Aug 13, 20261.0.25.0

Minor fixes and improvements

Aug 6, 20261.0.24.0

Minor fixes and improvements

Jul 16, 20261.0.23.0

Minor fixes and improvements

Jul 14, 20261.0.22.0

Minor fixes and improvements

Jul 7, 20261.0.21.0

Minor fixes and improvements

Jul 4, 20261.0.20.0

Minor fixes and improvements

Jul 1, 20261.0.19.0

Initial release of the public API documentation for this environment.