Documentation
Guides & Tutorials
In-depth guides covering architecture, features, integrations, and best practices for building with AgentOS.
Getting Started
Install the package and run a first agent.
Architecture Overview
The system architecture and how a request moves through it.
Planning Engine
How agents plan and run multi-step tasks.
Human-in-the-Loop
Approval gates and human review of agent actions.
RAG & Memory
Retrieval and memory configuration.
Cognitive Memory
Memory types, decay and the eight memory mechanisms.
Agent Communication
Messages between agents on the communication bus.
Guardrails
The guardrail packs and how to enable them.
Voice Pipeline
Streaming speech-to-text, the agent and text-to-speech in one loop.
Looking for API Reference?
The TypeDoc reference lists the classes, functions and interfaces that @framers/agentos exports, generated from the TypeScript source.