PARACOSM AGENTOS | API Reference v0.9.1035

Home Simulation API Docs GitHub npm

Home Simulation API Docs GitHub npm AgentOS Discord

Function compileScenario

compileScenario(
scenarioJson: Record<string, unknown>,
options?: CompileOptions,
): Promise<ScenarioPackage>
Compile a scenario JSON draft into a complete ScenarioPackage with generated hooks.
Parameters
- scenarioJson: Record<string, unknown>
  Canonical world draft (labels, departments, metrics, effects, etc.)
- options: CompileOptions = {}
  Compiler options (provider, model, cache settings, seed text / URL grounding)
Returns Promise<ScenarioPackage>
A complete ScenarioPackage ready for WorldModel.fromScenario(...).simulate()
- Defined in engine/compiler/index.ts:163