> ## Documentation Index
> Fetch the complete documentation index at: https://siglo.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# API Reference Overview

> Comprehensive API reference for Siglo: orchestration combinators, Flow and Step methods, execution options, storage adapters, error hierarchy, and deterministic testing.

# Siglo API Reference

Welcome to the comprehensive API Reference for **Siglo** — zero-daemon, in-process workflow orchestration with durable checkpoints, Sagas, network guardrails, and live visual DevTools.

***

## Reference Sections

| Section | Description |
| - | - |
| ⛓️ **[Orchestration and Combinators](https://siglo.dev/api/orchestration-and-combinators.md)** | Workflow composition (`flow`), parallel execution (`parallel`, `all`, `allSettled`, `race`), branching (`when`, `branch`), dynamic mapping (`map`), durable waits (`waitForEvent`, `wait`, `resumeWorkflow`), and AST exports (`toMermaid`, `toDot`, `toJSON`). |
| 🌊 **[Flow Instance Methods (`Flow`)](https://siglo.dev/api/flow)** | Primary workflow instance interface (`run`, `execute`, `start`), SLA timeouts (`flow.timeout`), versioning (`flow.version`), network guardrails (`flow.networkPolicy`), live monitoring (`flow.monitor`), execution hooks (`flow.hook`), manual compensations (`flow.compensate`), resumption (`flow.resume`), and AST inspection. |
| 🧱 **[Step Methods (`Step`)](https://siglo.dev/api/step)** | Core execution unit construction (`Step.create`), Standard Schema validation (`schema`, `spec`, `strict`), lifecycle hooks (`onBefore`, `onSkip`, `onAfter`), retries (`onFail`), sagas (`compensate`), idempotency (`idempotent`), caching (`cache`), DI (`withDependencies`, `requireDependency`), output reduction (`reduce`), and network egress guardrails (`allowNetwork`, `allowUnixSockets`, `denyNetwork`, `networkPolicy`). |
| ⚙️ **[Execution Options (`ExecutionOptions`)](https://siglo.dev/api/execution-options)** | Runtime configuration options passed to `.run()` and `.resume()`: POJO mode (`pojo`, `mode`), cooperative cancellation (`signal`), deadlines (`timeout`), dependency injection (`services`), durability (`durable`), multi-tenancy (`namespace`), idempotency (`idempotencyKey`), execution hooks (`stepExecutionHook`), and live monitoring (`monitor`). |
| 💾 **[Storage and Persistence Utilities](https://siglo.dev/api/storage-and-persistence.md)** | Persistent checkpoint management (`useStorage`, `getStorageAdapter`), error modes (`setErrorMode`), optimistic concurrency control (OCC), serialized snapshot creation (`checkpoint`, `restoreCheckpoint`), and expiration cleanup (`cleanExpiredCheckpoints`). |
| 🚨 **[Error Hierarchy and Exceptions (`SigloError`)](https://siglo.dev/api/error-hierarchy)** | Strongly typed runtime exception model rooted at `SigloError`: timeouts, cancellations, schema validation failures, saga rollbacks (`CompensationException`, `UnresolvableCompensationException`), network guardrail violations (`NetworkPolicyViolationException`), idempotency conflicts, version mismatches, and `normalizeError()`. |
| 🧪 **[Deterministic Testing (`@siglo/testing`)](https://siglo.dev/api/testing)** | Deterministic test harness (`createWorkflowHarness`), virtual clocks (`FakeClock`), step spies (`spyStep`), step mocking (`mockStep`), event injection (`injectEvent`), test assertions, execution fixtures, and replay (`replayExecution`). |

***

## Architectural Guides and Topic References

For higher-level design patterns, system architecture, and production topologies, consult the topic guides:

### Step-by-Step Guides

* [01. Getting Started](https://siglo.dev/01-getting-started.md)
* [02. Core Concepts](https://siglo.dev/02-core-concepts.md)
* [03. Sequential Workflows](https://siglo.dev/03-sequential-workflows.md)
* [04. Branching and Parallelism](https://siglo.dev/04-branching-and-parallelism.md)
* [05. Retries, Timeouts, and Cancellation](https://siglo.dev/05-retries-timeouts-and-cancellation.md)
* [06. Durable Workflows](https://siglo.dev/06-durable-workflows.md)
* [07. Storage and Adapters](https://siglo.dev/07-storage-and-adapters.md)
* [08. Observability](https://siglo.dev/08-observability.md)
* [09. Testing and Replay](https://siglo.dev/09-testing-and-replay.md)
* [10. TypeScript Reference](https://siglo.dev/10-typescript-reference.md)
* [11. Production Operations](https://siglo.dev/11-production-operations.md)

### Formal Contracts and Architecture

* [Execution Semantics](https://siglo.dev/execution-semantics.md)
* [Concurrency and Parallelism](https://siglo.dev/concurrency-and-parallelism.md)
* [Error Model and Hierarchy](https://siglo.dev/error-model.md)
* [Storage and Checkpoint Contract](https://siglo.dev/storage-contract.md)
* [Compensation and Sagas Contract](https://siglo.dev/compensation-and-sagas.md)
* [Durable Waits Contract](https://siglo.dev/durable-waits.md)
* [Idempotency Contract](https://siglo.dev/idempotency.md)
* [Network Egress Policy](https://siglo.dev/network-egress-policy.md)
* [Production Best Practices](https://siglo.dev/production-best-practices.md)
* [Workflow Graph AST](https://siglo.dev/workflow-graph.md)
* [Workflow Versioning and Migrations](https://siglo.dev/workflow-versioning.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.