API Reference

This is the complete reference for PenguiFlow's public API. Every symbol documented here is re-exported from penguiflow (or one of its public sub-packages penguiflow.planner, penguiflow.llm, penguiflow.tools) and is covered by the library's backward-compatibility guarantees.

Symbols are grouped by area below. Internal modules and private helpers are intentionally omitted — only the curated public surface appears here.

• Flow runtime — PenguiFlow, Context, nodes, registry, pattern helpers
• Messages & types — Message, Headers, WM, StreamChunk, and related types
• Errors — FlowError, FlowErrorCode, CycleError
• Metrics & middleware — FlowEvent, middleware hooks, logging helpers
• Routing policies — config-driven routing types
• Artifacts — artifact stores and references
• Streaming — stream helpers and SSE/WebSocket adapters
• Visualization — Mermaid/DOT exporters
• Remote execution — remote node and task types
• Sessions & scheduling — session manager, transports, job scheduler
• State stores — state persistence protocols and adapters
• Skills — skill providers and configuration
• Steering — steering inbox and events
• Testing kit — FlowTestKit helpers
• Planner — ReactPlanner and planner configuration
• LLM layer — native LLM client, providers, request/result types
• Tools — ToolNode, OAuth, and presets