AgentOS Documentation

Complete API reference, guides, and examples for building with AgentOS

API Reference

Complete TypeDoc-generated API documentation for @framers/agentos package. Explore all classes, interfaces, types, and methods.

TypeDoc documentation for all exported modules and types

REST API documentation for the AgentOS backend server. View all endpoints, request/response schemas, and examples.

Auto-generated from Express routes and OpenAPI spec

Explore the full source code, examples, and contribute to AgentOS on GitHub. MIT licensed and open for collaboration.

New to AgentOS? Start here with installation instructions, basic concepts, and your first agent.

pnpm add @framersai/agentos

import { AgentOS } from "@framersai/agentos";

const agentos = new AgentOS();
await agentos.initialize(config);

Documentation is auto-generated from source code. To regenerate locally:

pnpm run docs        # Generate all docs
pnpm run docs:serve  # Serve at localhost:8080