Getting Started

Overview Authentication Configuration

API Reference

Agent API Domains Endpoints

Integrations

MCP Server

Internals

Architecture

Based Documentation

A self-describing API that turns your entire infrastructure into queryable, searchable, agent-ready data.

12
Domains
5
Endpoints
<1s
Cross-Domain Search

Quick Start

# Authenticate
TOKEN=$(curl -s -X POST /api/auth/login \
  -H 'Content-Type: application/json' \
  -d '{"pin":"YOUR_PIN"}' | jq -r '.token')

# Read the manifest
curl -s /api/agent/ -H "Authorization: Bearer $TOKEN"

# Search across all 12 domains
curl -s "/api/agent/query?q=deploy" -H "Authorization: Bearer $TOKEN"

# Full project aggregate
curl -s "/api/agent/projects/myproject/full" -H "Authorization: Bearer $TOKEN"

Documentation

core Agent API

Self-describing manifest, cross-domain search, project aggregation. The main interface for agents and tools.

reference 12 Domains

Complete schema reference for all domains: projects, sessions, artifacts, hosts, git, logs, memory, config, health, views, usage, files.

new MCP Server

Model Context Protocol integration. Native tool access to all 12 domains — no HTTP, no curl. ~550 lines of new code reusing ~4000 lines of existing adapters.

api Endpoints

Full REST API reference with request/response examples for every endpoint.

setup Configuration

.project.yaml format, hosts.yaml, memory files, and project discovery.

design Architecture

How Based indexes data, the domain adapter pattern, and transport-agnostic design.

auth Authentication

PIN-based auth with Bearer tokens. Simple, LAN-appropriate security.

Key Concepts

Self-Describing API

One call to /api/agent/ returns every domain, every field, every filter, and example queries in natural language. Any agent can understand the entire API without reading documentation.

Cross-Domain Search

Query across all 12 domains in a single request. Search "deploy" and get matches from files, configs, artifacts, logs, and git — all at once, in milliseconds.

Convention over Configuration

Drop a .project.yaml in any directory. Based discovers it automatically. Zero setup, zero registration.

Agent-First Design

Every endpoint returns structured, typed data. Every response includes metadata. Every domain is discoverable at runtime. Built for agents, usable by humans.