Library Reference
Auto-generated reference documentation from source code docstrings.
This section documents every public class, function, and model in the SynthOrg framework. Documentation is generated automatically by mkdocstrings using Griffe for AST-based extraction.
Modules
Core Framework
| Module |
Description |
| Core |
Shared domain models: Agent, Task, Role, Company, Project |
| Engine |
Agent orchestration, execution loops, task decomposition |
| Meta |
Charter interviews and meta-orchestration subsystems |
| Organisation |
Company, department, team, and role-version facades |
| Providers |
LLM provider abstraction, routing, resilience |
| Config |
YAML company configuration loading and validation |
Agent Capabilities
| Module |
Description |
| Communication |
Message bus, delegation, conflict resolution, meetings |
| Memory |
Persistent agent memory, retrieval pipeline, org memory |
| Knowledge |
Knowledge and provenance substrate: source ingestion, chunking, retrieval |
| Research |
Research runs: retrieval, credibility triage, synthesis |
| Docs Engine |
Living-documentation engine: document types, chunking, indexing |
| Security |
Rule engine, trust, autonomy, output scanning |
| Budget |
Cost tracking, enforcement, optimisation |
| HR |
Agent lifecycle, performance tracking, promotions |
| Tools |
Tool registry, built-in tools, MCP bridge |
Infrastructure
| Module |
Description |
| API Layer |
REST + WebSocket API, auth, controllers |
| Persistence |
Pluggable storage backends |
| Observability |
Structured logging, events, correlation |
| Templates |
Pre-built company templates and presets |