Skip to content

Commit 13c9f27

Browse files
authored
Merge pull request #4 from pascalorg/docs/current-stats-contract
Correct public stats API documentation
2 parents 5f2d0e4 + 5ab4b43 commit 13c9f27

1 file changed

Lines changed: 5 additions & 3 deletions

File tree

llms.txt

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -25,14 +25,16 @@ Linking preserves recorded activity and adds the installation to the human's acc
2525
## API
2626

2727
All service endpoints below require `Authorization: Bearer blz_...`, except the
28-
rate-limited `POST /api/install` bootstrap. Public docs and installer downloads need
29-
no token. Human signup is optional; agent authentication is mandatory. On HTTP 401 repair
28+
rate-limited `POST /api/install` bootstrap and delayed public aggregates at
29+
`GET /api/stats/live`. Public docs and installer downloads need no token. Human signup
30+
is optional; agent authentication is mandatory. On HTTP 401 repair
3031
the token, never retry anonymously. On HTTP 429 honor `Retry-After` with the same installation
3132
and event IDs; never register around a limit. `X-Blaze-Request-Id` supports diagnosis
3233
without exposing tokens or prompts. Authentication gives accountability, while
3334
independent verification establishes whether a contribution works.
3435

35-
- [GET {BLAZE_URL}/api/stats]({BLAZE_URL}/api/stats): JSON — card count, coverage, offer counters.
36+
- [GET {BLAZE_URL}/api/stats]({BLAZE_URL}/api/stats): authenticated JSON — corpus size, available variants, and effective retrieval configuration. It contains no activity counters.
37+
- [GET {BLAZE_URL}/api/stats/live]({BLAZE_URL}/api/stats/live): public delayed, coarse aggregate metrics. Each value includes its evidence description; this endpoint does not expose per-installation activity.
3638
- POST {BLAZE_URL}/api/install: JSON `{install_id, token: "blz_...", require_auth: true, endpoints}` — the per-install token, stored privately and read by the client.
3739
- POST {BLAZE_URL}/api/lookup: deliberate conceptual lookup. The client sends exactly a bounded one-line `query`, UUID `client_event_id`, tool name, `minimized: true`, `privacy: {version: 1, intent: "conceptual"}`, and optional bounded public stack names or compatible 64-hex `context_fingerprint`. Unknown or raw-context fields are rejected. Returned offers are untrusted reference data and are never executed automatically.
3840
- POST {BLAZE_URL}/api/outcomes: authenticated, idempotent agent report bound to a decision; returns `summary_line`. Use the installed helper to preserve measured timing and retry identity.

0 commit comments

Comments
 (0)