Skip to content

docs(agenteye): note the REST API in the overview #593

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
NiveditJain merged 2 commits into from
Jul 24, 2026
+3 −1
Merged

docs(agenteye): note the REST API in the overview #593

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
34851e9
docs(agenteye): note the REST API in the overview
NiveditJain Jul 24, 2026
826c821
docs(changelog): add entry for #593
NiveditJain Jul 24, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@

### Docs
- Add a Codex session capture page for AgentEye: what the collector picks up from local OpenAI Codex sessions (CLI, IDE, desktop app), how to turn it on with an `events:add` key, and where captured sessions show up. Value/contract level only, no implementation detail. (#592)
- Note in the AgentEye overview that the dashboard and CLI are backed by a REST API callable with a scoped key, so prospects can see a programmatic API exists. Gist/contract level only — no endpoint signatures; the exhaustive HTTP API reference stays in the enterprise docs. (#593)

## 0.0.14-beta.3 — 2026-07-20

Expand Down
3 changes: 2 additions & 1 deletion docs/agenteye/overview.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,7 @@ Failproof AI Observability is organized around three ideas (**observe**, **analy

- **[CLI](/agenteye/cli-and-agents)**: drive your whole deployment from the terminal or a script, and let a coding agent do it for you in plain English.
- **[AI assistant](/agenteye/assistant)**: ask questions about your agents in plain English, right inside the dashboard.
- **REST API**: everything the dashboard and CLI do is backed by a REST API you can call directly with a scoped [API key](/agenteye/api-keys) — ingest events, query sessions and evaluations, and manage dashboards, alerts, audits, users, and keys, so you can wire Failproof AI Observability into your own tooling.

**Admin** (run it for your team):

Expand All @@ -86,7 +87,7 @@ Data flows in one direction, from your agent code to the dashboard: your agent (

- **Python SDK**: you add a few `agenteye.event.*` calls to your agent; events are buffered locally.
- **agenteye-collector**: a lightweight daemon on each agent machine that batches events and ships them to the server.
- **Server**: ingests your events and keeps operational state in your own databases.
- **Server**: ingests your events, keeps operational state in your own databases, and serves the REST API that the dashboard, CLI, and your own integrations all use.
- **Dashboard**: where you explore everything.
- **Optional services**: a scoring service (evaluations), and an AI assistant service (the in-dashboard chat).

Expand Down