Guides¶
Practical guides for configuring, operating, and extending your synthetic organisation. Each guide is self-contained with a clear goal. Start with the Quickstart Tutorial if you are new to SynthOrg. Note: the platform and configuration surface are available today; the agent runtime that executes work is in active development (see the Roadmap).
New to SynthOrg?
Start with the Quickstart Tutorial to stand up the platform and configure a company in about 5 minutes.
-
Quickstart Tutorial
Install the CLI, pick a template, and stand up the platform in about 5 minutes.
-
Company Configuration
Complete YAML reference for every configuration option.
-
Agent Roles & Hierarchy
Define agents, seniority levels, personality, departments, and reporting lines.
-
Budget & Cost Control
Per-agent budgets, alert thresholds, auto-downgrade, and spending reports.
-
Security & Trust Policies
Trust strategies, autonomy levels, approval gates, and custom security policies.
-
Tool Integration (MCP)
Connect external tools via MCP servers with stdio or HTTP transports.
-
Deployment (Docker)
Run SynthOrg in production with Docker, hardening, and image verification.
-
Memory Configuration
Agent memory, shared org memory, retrieval pipeline, and consolidation.
-
Centralized Logging
Route structured logs to syslog, HTTP, OTLP, or external log aggregators.
-
Settings Reference
Resolve, view, and edit the 20 settings namespaces at runtime.
-
Notifications & Events
Configure notification sinks and subscribe to WebSocket event channels.
-
Workflow API Tutorial
curl tutorials for creating, versioning, activating, and executing workflows.
-
Agent Management
Hire, fire, promote, and customise agents through the REST API.
-
Human Interaction & API
REST + WebSocket API surface, rate limiting, RFC 9457 errors, Web UI features.
-
Contributing
Development workflow, testing, code style, and pull request process.