Documentation Index

---

Documentation Index

Getting Started

• Getting Started Guide — Install, env setup, and 3 levels (1 line → 3 lines → 5 lines)
• README — Installation and quick start
• High-Level API — generateText(), streamText(), generateImage(), generateVideo(), analyzeVideo(), generateMusic(), generateSFX(), performOCR(), agent(), and agency()
• Examples Cookbook — 12 complete runnable examples, including QueryRouter host hooks and finalized agency streaming
• CHANGELOG — Version history and release notes

Architecture & Core Concepts

• Architecture Overview — Complete system architecture and design principles

Features & Capabilities

Planning & Orchestration

• Orchestration Guide — Graphs, workflows, missions, voice nodes, checkpointing, YAML authoring
• Unified Orchestration Layer — One runtime, three authoring APIs (AgentGraph, workflow(), mission())
• AgentGraph — Full graph builder with typed nodes, conditional edges, and subgraphs
• workflow() DSL — Deterministic DAG pipelines with branching and parallel joins
• mission() API — Goal-first orchestration driven by the PlanningEngine
• Checkpointing — Resume, fork, replay, and memory consistency semantics
• Planning Engine — Multi-step task planning and execution
• Human-in-the-Loop — Approval workflows and human oversight
• Agent Communication — Inter-agent messaging and coordination

Safety & Security

• Guardrails System — Two-phase guardrail dispatch, built-in packs (PII, ML classifiers, topicality, code safety, grounding), and folder-level filesystem permissions
• Safety Primitives — Circuit breakers, cost guards, stuck detection, and tool execution guards

Memory & Storage

• Cognitive Memory Guide — Working memory, encoding, retrieval, consolidation, prospective memory
• Cognitive Memory System — Personality-modulated memory with Ebbinghaus decay, Baddeley's working memory, spreading activation, and HEXACO-driven encoding
• RAG Memory Configuration — Vector storage and retrieval setup
• SQL Storage Quickstart — Database integration guide
• Client-Side Storage — Browser-based persistence
• Immutable Agents — Sealing lifecycle, toolset pinning, secret rotation, and soft-forget
• Provenance Guide — HashChain, ChainVerifier, BundleExporter, proof levels, external anchors
• Provenance & Immutability — Sealed storage policy, signed ledger, and anchoring

AI & LLM

• Structured Output — JSON schema validation and structured generation
• Streaming Semantics — Raw live chunks vs finalized approved output across textStream, fullStream, text, and finalTextStream
• Evaluation Guide — Test cases, graders, LLM-as-judge, A/B testing, experiment tracking
• Evaluation Framework — Testing, scoring, and quality assurance
• Query Router — Tiered query classification, retrieval routing, keyword fallback, and grounded answer generation
• Image Generation Guide — Provider-agnostic image generation across cloud and local backends
• Capability Discovery Guide — Three-tier semantic discovery, CAPABILITY.yaml, meta-tool
• Capability Discovery — Full architecture reference
• Cost Optimization — Token usage and API cost management

Extensions & Customization

• RFC Extension Standards — Extension development guidelines
• Recursive Self-Building Agents — Advanced agent patterns
• Skills (SKILL.md) — Prompt modules loaded from directories/registries

Channels & Social

• Channels Guide — Multi-channel adapters with setup for Discord, Slack, Telegram, Twitter, and WhatsApp
• Social Posting Guide — SocialPostManager, content adaptation, scheduling, analytics

Platform & Infrastructure

• Platform Support — Supported environments and requirements
• Observability (OpenTelemetry) — Tracing, metrics, and log correlation/export (opt-in)
• Logging (Pino + OpenTelemetry) — Structured logs, trace correlation, and OTEL LogRecord export (opt-in)

Ecosystem

• Ecosystem — Related packages, extensions, and resources
• Releasing — Automated release process

API Reference

• TypeDoc API — Auto-generated API documentation

---

Quick Links

Resource	Link
Website	agentos.sh
GitHub	framersai/agentos
npm	@framers/agentos
Issues	GitHub Issues
Discussions	GitHub Discussions

---

How to Use This Documentation

1. New to AgentOS? Start with the README for installation and basic usage
2. Understanding the system? Read the Architecture Overview
3. Building features? Check the relevant feature guide (Planning, HITL, Guardrails, etc.)
4. API details? Browse the TypeDoc API Reference
5. Troubleshooting? See Platform Support

---