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

[NiveditJain]

What

Adds a short, value-level mention to the public overview that Failproof AI
Observability exposes a REST API you can call directly with a scoped key. It
lands in two natural spots:

• the Interfaces ("reach your data your way") list — a new bullet alongside CLI
  and the AI assistant;
• the How the pieces fit component summary — the Server now notes it serves the
  REST API that the dashboard, CLI, and your own integrations use.

Why

Prospects reading the public docs had no signal that a programmatic API exists. This
conveys that a rich API set is available — enough to wire the product into your own
tooling — without publishing the endpoint signatures.

Scope (deliberate)

Value/contract level only. No endpoint request/response shapes, headers, or paths are
added to the public docs; the exhaustive HTTP API reference lives in the enterprise
docs (signed readers only). The bullet links to the existing API Keys page, which
already documents the permission-scoped routes at the contract level.

English en only; the daily translate-docs cron regenerates the localized copies.
No new page, so no docs.json nav change.

🤖 Generated with Claude Code

https://claude.ai/code/session_01LJKNJufLLwN4k1fgRHdeUS

Summary by CodeRabbit

• Documentation
  • Documented the REST API supporting the dashboard and CLI.
  • Added details about ingesting events, querying sessions and evaluations, and managing related resources with a scoped API key.
  • Clarified that the server supports custom integrations through the REST API.

[coderabbitai]

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: f1ceea51-ada0-466d-bb43-a37958c792f7

📥 Commits

Reviewing files that changed from the base of the PR and between 2847466 and 826c821.

📒 Files selected for processing (2)

• CHANGELOG.md
• docs/agenteye/overview.mdx

---

📝 Walkthrough

Walkthrough

AgentEye documentation now describes REST API capabilities, scoped API key usage, and the server’s role in serving the API to the dashboard, CLI, and custom integrations. The changelog records this documentation update.

Changes

AgentEye API documentation

Layer / File(s)	Summary
REST API overview and architecture docs/agenteye/overview.mdx, CHANGELOG.md	The overview documents REST API capabilities, scoped API key usage, and server API delivery; the changelog records the update.

Estimated code review effort: 1 (Trivial) | ~2 minutes

Possibly related PRs

• FailproofAI/failproofai#518: Earlier updates to the same AgentEye overview documentation.

Suggested labels: enhancement

Suggested reviewers: hermes-exosphere

Poem

I’m a rabbit with a RESTful trail,
Scoping keys beneath the moonlit veil.
The dashboard hops, the CLI follows too,
While the server tells the API what to do.
Documentation carrots—crunchy and bright!

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Description check	⚠️ Warning	It covers what, why, and scope, but it doesn't use the required Description, Type of Change, and Checklist template sections.	Add the template's Description, Type of Change, and Checklist sections, and fill in the checkbox items or mark them not applicable.

✅ Passed checks (4 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title is concise and accurately summarizes the main change: adding a REST API note to the AgentEye overview.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.

Warning

There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure.

🔧 ESLint

If the error stems from missing dependencies, add them to the package.json file. For unrecoverable errors (e.g., due to private dependencies), disable the tool in the CodeRabbit configuration.

docs/agenteye/overview.mdx

ESLint skipped: missing config or dependency (missing-dependency). The ESLint configuration references a package that is not available in the sandbox.

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands.}

[hermes-exosphere]

[PASS] Approved — LGTM

Clean docs-only update. Two changes (+3/-1 across CHANGELOG.md and overview.mdx) that surface the REST API at the right level of detail.

What's good:

• New "REST API" bullet in the Interfaces section lands naturally alongside CLI and AI assistant — the three primary ways to interact with the product.
• The Server description in "How the pieces fit" now accurately reflects that it serves the API the dashboard/CLI/integrations consume — a concrete, correct clarification.
• Link to the existing API Keys page (scoped key) is the right call — no new page, no endpoint signatures exposed. Contract-level only, as stated.
• CHANGELOG entry is terse and self-describing with PR number.
• All 9 CI checks green, mergeable cleanly.

No issues found. The scope is exactly what the PR description promises — value/contract level, no implementation detail, English-only (translate-docs cron handles localizations).