API reference

Everything from loomflow import … will resolve. Grouped by purpose; click through to the relevant docs page for usage.

The framework ships with a py.typed marker, so IDEs (Pylance, Pyright, mypy) get autocomplete and go-to-definition on every public symbol. If your IDE doesn’t pick this up, see Common pitfall: stale install.

Agent


from loomflow import Agent, Tuning

The configured loop driver. See What is an Agent.

Tuning (0.10.24+) groups the rarely-touched knobs (retry_policy, secrets, auto_consolidate, response_tone, stop_hooks, max_stop_hook_iterations, and the tool-transcript / auto-compact tuning fields) into one optional dataclass — pass Agent(..., tuning=Tuning(...)). The flat kwarg form still works but is deprecated and warns.

Architectures


from loomflow import Architecture, ReAct
from loomflow.architecture import ActorCritic, Blackboard, BlackboardArchitecture, BlackboardEntry, MultiAgentDebate, Plan, PlanAndExecute, PlanStep, Reflexion, ReWOO, ReWOOPlan, ReWOOStep, ReWOOStepResult, Router, RouterRoute, SelfRefine, StepResult, Supervisor, Swarm, Handoff, ThoughtNode, TreeOfThoughts, AgentSession, Dependencies, resolve_architecture
from loomflow.team import Team, run_architecture

See Architectures.

Models


from loomflow import EchoModel, ScriptedModel, ScriptedTurn
from loomflow.model.anthropic import AnthropicModel
from loomflow.model.litellm import LiteLLMModel
from loomflow.model.openai import OpenAIModel

See Models.

Memory


from loomflow import HashEmbedder, InMemoryMemory, resolve_memory
from loomflow.memory import ChromaFactStore, ConsolidationWorker, Consolidator, FactStore, InMemoryFactStore, PostgresFactStore, RedisFactStore, SqliteFactStore
from loomflow.memory.auto_extract import AutoExtractMemory
from loomflow.memory.chroma import ChromaMemory
from loomflow.memory.embedder import CohereEmbedder, OpenAIEmbedder, VoyageEmbedder
from loomflow.memory.lazy import LazyMemory
from loomflow.memory.postgres import PostgresMemory
from loomflow.memory.redis import RedisMemory
from loomflow.memory.sqlite import SqliteMemory
from loomflow.memory.vector import VectorMemory

See Memory.

Vector stores


from loomflow.vectorstore import ChromaVectorStore, FAISSVectorStore, InMemoryVectorStore, PostgresVectorStore, SearchResult, VectorStore

See RAG.

Tools


from loomflow import LivingPlan, LivingPlanStep, Tool, tool
from loomflow.tools import InProcessToolHost, PathEscapeError, bash_tool, default_workdir, edit_tool, filesystem_tools, read_tool, write_tool
from loomflow.tools.plan import get_active_plan, make_plan_tools, make_recall_past_plans_tool

See Tools · Living plan.

Workspace


from loomflow import (
    InMemoryWorkspace,
    LocalDiskWorkspace,
    Workspace,
    WorkspaceMembership,
    resolve_workspace,
)
from loomflow.workspace import (
    Note,
    NoteKind,
    NoteMatch,
    NoteSummary,
    NoteVersion,
    PruneResult,
    make_workspace_tools,
    workspace_prompt_section,
)

See Workspace · Workspace lifecycle.

Skills


from loomflow.skills import Skill, SkillError, SkillMetadata, SkillRegistry, SkillSource

See Skills.

MCP


from loomflow.mcp import MCPClient, MCPRegistry, MCPServerSpec

See MCP.

Runtime


from loomflow import InProcRuntime
from loomflow.runtime import InMemoryJournalStore, JournaledRuntime, JournalStore, PostgresJournalStore, PostgresRuntime, SqliteJournalStore, SqliteRuntime

See Runtime.

Security


from loomflow import AllowAll, AuditLog, HookRegistry, InMemoryAuditLog, Mode, NoSandbox, StandardPermissions
from loomflow.security import DictSecrets, EnvSecrets, FileAuditLog, FilesystemSandbox, FullTranscriptAuditLog, PerUserPermissions, SubprocessSandbox

See Security.

Governance


from loomflow.governance import RetryPolicy, classify_model_error
from loomflow.governance.budget import BudgetConfig, StandardBudget

See RetryPolicy + error taxonomy · Per-user budget caps.

Observability


from loomflow import NoTelemetry
from loomflow.observability import (
    InMemoryTelemetry,
    ConsoleTelemetry,
    FileTelemetry,
    MultiTelemetry,
    OTelTelemetry,
    CapturedSpan,
    CapturedMetric,
)
from loomflow.graph import AgentGraph, build_graph, write_graph

See OpenTelemetry · AgentGraph.

Data lineage


from loomflow.data import FreshnessPolicy, LineagePolicy

Core types


from loomflow import BudgetStatus, Episode, EpisodeMatch, Event, EventKind, Fact, MemoryBlock, MemoryExport, MemoryProfile, Message, PermissionDecision, Role, RunResult, ToolCall, ToolDef, ToolResult, Usage
from loomflow.core.types import AuditEntry, PromptCacheConfig, Span
from loomflow.data import CertifiedValue
from loomflow import ModelChunk, ToolEvent

PromptCacheConfig is what the Agent(prompt_caching=) kwarg resolves to. Usage and RunResult carry the cached_input_tokens / cache_write_tokens accounting. See Prompt caching.

Protocols


from loomflow import Budget, Embedder, HookHost, Memory, Model, Permissions, Runtime, Sandbox, Secrets, Telemetry, ToolHost
from loomflow import RuntimeSession, NB:, verify  # NB: verify

Implement any of these to add a new backend without forking the framework.

RunContext


from loomflow import IsolationWarning, RunContext, get_run_context, set_run_context

See Run vs Session vs RunContext.

Errors


from loomflow import BudgetExceeded, ConfigError, LoomError, OutputValidationError
from loomflow.core.errors import AuthenticationError, CancelledByUser, ContentFilterError, InvalidRequestError, MCPError, MemoryStoreError, ModelError, PermanentModelError, PermissionDenied, RateLimitError, RuntimeJournalError, SandboxError, ToolError, TransientModelError
from loomflow.data import FreshnessError, LineageError
from loomflow.model._effort import EffortNotSupportedError

See Errors.

Identity helpers


from loomflow import new_id
from loomflow.core.ids import deterministic_hash

new_id() returns a fresh ULID. deterministic_hash(obj) returns a stable hash of any JSON-serializable object. Used internally for journal keys; useful in custom architectures.

Version


from loomflow import __version__

The current pinned version is 0.10.24.