Reference

API reference for the flowai_harness public surface. Most pages render the exported classes, functions, and type aliases directly from their docstrings; some pages add contract notes where the raw generated signature needs more context.

Common entry points:

For task-oriented guides see Require approvals, Configure a data environment, Studio, Expose Tools Over MCP, Test agents without provider calls, and Streaming events.

Besides dev / serve (see Studio), the CLI also provides flowai-harness docs export to generate the docs content artifact and flowai-harness mcp python MODULE:OBJECT to serve a Python runtime object over MCP (see MCP).

• Runtime — Runtime, create_runtime, define_runtime, RuntimeSpec, and the testing / data-environment configs.
• Studio — define_app, workspace bindings, and the local Studio command surface.
• Evals — eval configs, test cases, structured action ground truth, scorer presets, artifacts, and event envelopes.
• MCP — stdio and Streamable HTTP helpers for exposing runtime tools to MCP clients.
• Agents — define_coordinator, define_planner, define_executor, define_specialist, and AgentSpec.
• Plans — define_plan, PlanSpec, PlanDisplayAlias.
• References — define_reference, ReferenceSpec.
• Tools — define_tool, ToolSpec.
• Prompts — layered_prompt, LayeredPrompt.
• Tenant — define_tenant, TenantIdentity.
• Unions — TaggedUnion.
• Glimpse — glimpse.
• Runtime events — stream event kinds and payload examples.
• Action dispatcher — approved plan action callback contract.
• Schema and utilities — normalize_schema and normalize_data_environment.