Skip to main content

Health dashboard

Get an overview of your knowledge base health.
integer
Total number of pages.
integer
Pages past their review-by date in frontmatter.
integer
Pages with no incoming backlinks.
Wiki links pointing to nonexistent pages.
integer
Pages with no content beyond frontmatter.
integer
Pages missing YAML frontmatter.
Percentage of wiki links that resolve to existing pages.
array
Most recently modified pages.

Analytics overview

Compact dashboard for the web UI engagement panel:

Page views

views/v2 returns richer per-page engagement when tracking is enabled.

Search analytics

Failed searches help identify content gaps agents could not answer.
Dismiss a content gap suggestion:

Import sources analytics

Summarizes pages by _source frontmatter from imports.

Per-page health check

Analyze the health of a single page.
string
required
File path to check.
When issues are detected, they appear in the issues array:

Stale pages

List pages that are past their review date.

Contradictions

Detect pages with potentially conflicting claims.

Janitor scan

Run a full knowledge health scan across the entire knowledge base.

Memory report

Get an overview of your episodic memory structure — useful for agents that use the episode/merge pattern.
string
Path prefix for episodes directory. Uses the configured default if omitted.

Context

Retrieve the knowledge base context files used by agents — the playbook, schema description, and index.
These map to .kiwi/playbook.md, .kiwi/SCHEMA.md, and .kiwi/index.md.

Theme

Read or update the web UI theme.

Get theme

Set theme

Returns 403 if ui.theme_locked = true in configuration.

Comments

Add, list, resolve, and delete inline comments on pages.

List comments

string
required
File path to list comments for.

Add a comment

Resolve a comment

Delete a comment


Sharing

Create and manage share links for pages.
expiresIn is a Go duration string (168h for seven days). Omit it for links that never expire.
Readers open GET /api/kiwi/public/:token (see Utilities).
path is required — the handler returns every active link for that page.
Returns JSON { "revoked": "<id>" } using the share id field (not the long token).

Real-time events (SSE)

Subscribe to a Server-Sent Events stream that emits events on every write and delete. Use this for real-time UI updates or external integrations.
The SSE connection stays open indefinitely. Use curl -N (no-buffer) to see events as they arrive. In production, implement reconnection logic with the Last-Event-ID header.

Event types

Last modified on May 22, 2026