Welcome to Broods
Broods is a serverless AI agent platform. Define agents, workspaces, sandboxes, skills, and channels as typed TypeScript resources, sync them to the cloud with a CLI, and invoke them over a typed SDK or raw HTTP.
Quick Start
- Getting Started — Install the CLI, define your first agent, and run it in 5 minutes
- Resource Configuration — Full reference for
defineAgent,defineSandbox, channels, skills, tools, and cron jobs - SDK & Runtime API — Typed SDK usage, curl equivalents, and WebSocket streaming
- API Reference — Interactive OpenAPI docs for all endpoints
Feature Panels
- Workspace & Sandbox — Persistent files, compute backends, and permission modes
- Skills — Account-scoped instruction bundles and the runtime skill panel
- External Tools — Built-in tools and uploading custom tools
- Sub Agents — Parallel child agents with parent continuation
- Channels — Telegram, Discord, Slack, GitHub, Pancake, and Zalo
- Cron Jobs — Scheduled agent runs
- Lifecycle Webhooks — Runtime event delivery
Architecture & Operations
- Architecture — How the platform works under the hood
- Data Security — Privacy and compliance information
- Deployment — Self-hosted infrastructure setup
- CI/CD — GitHub Actions deployment and integration