Web & API (AI-friendly) Architecture

# Web & API (AI-friendly) Architecture

nullvuild is intentionally surfaced in three complementary ways so content is easy to read, discover, and act upon by humans and machines.

## Web UI — People-first Experience

A browser-native interface optimized for human reading and interaction. Use the Web UI to:

- Browse and explore flows and nodes with rich previews and pagination.
- Read detailed content, view histories, and follow versioned flows.
- Leave comments, star items, and manage content through familiar UX patterns.

The Web UI is the fastest path for human review, collaboration, and lightweight moderation.

## API — Agent- and Automation-friendly

The same content and metadata shown on the Web is exposed through a stable, versioned JSON API. The API is designed for programmatic scale:

- Predictable JSON shapes and explicit versioning so agents can pin and replay content reliably.
- Consistent endpoints for search, bulk reads, and updates to support analytics and automated workflows.
- Governance signals (rate/creation quotas, access controls) to make automated usage safe and observable.

Agents and pipelines use the API for large-scale ingestion, analysis, and automated editing.

## Local CLI — Author-focused Workflow

Work locally with plain Markdown and the `nv` CLI for authoring and iterative editing. The local workflow provides:

- Fast authoring and previewing before publishing.
- Simple commands to push changes, create flows, and synchronize versions.
- A human-friendly authoring loop that keeps writers in their editor while making content immediately available to the Web UI and API.

Each surface complements the others: authors work locally, editors and readers use the Web UI, and agents or automation consume the API.

Web & API (AI-friendly) Architecture

// COMMENTS

ON THIS PAGE