Skip to main content
This is the API reference: the complete, dry catalog of everything Smithers exports. Every public function, component, type, and RPC has a page here with its signature, parameters, return shape, the source and tests that back it, and a runnable example. Where the For Humans and For Agents tabs explain why and walk you through tasks, this tab is the lookup you reach for when you already know what you want and need the exact shape of it.

​
Import map

Almost everything lives behind one facade. Import components, agents, tools, scorers, memory, openapi, observability, the server/gateway, db, time-travel, and errors from smithers-orchestrator. 
import { createSmithers, Task } from "smithers-orchestrator";
The browser/React Gateway SDK is the exception: it is published as subpaths so it can ship independently of the engine and stay client-safe.
  • smithers-orchestrator/gateway-client · the framework-free RPC/WS client.
  • smithers-orchestrator/gateway-react · the React hooks and provider built on it.

​
How to read a page

Every export follows the same layout, so once you can read one you can read all of them:
  • A one-line summary of what the export does.
  • A ts signature block - the exact type you call against.
  • ParamField rows for each parameter and ResponseField rows for the return shape, with nested Expandable blocks for object members.
  • A Throws note linking the relevant error in Errors when the export can fail loud.
  • A short, runnable example.
  • A footer line: **Source** · **Tests** · **See also**, linking the GitHub source file, the test file that pins its behavior, and related guides.

​
Reference pages

Authoring

The factory functions that turn Zod schemas into a typed, durable workflow API.

Components

The full JSX component set: Workflow, Task, control flow, and composites.

Agents

Adapters that wrap CLI and SDK coding agents into a uniform interface.

Tools

Built-in tools and helpers for giving agents typed capabilities.

Scorers

Scoring functions that grade node output for loops and evals.

Memory

Cross-run fact storage and retrieval.

OpenAPI

Generate typed agent tools from an OpenAPI spec.

Observability

Metrics, logging, tracing, and OTLP integrations.

Server and gateway

The multi-run control plane: serve runs over RPC and WebSocket.

Gateway client

The framework-free browser RPC/WS client (subpath export).

Gateway React

React hooks and provider for the Gateway (subpath export).

DB

The Drizzle schema and helpers for the durable store.

Time travel

Fork, replay, and rewind runs from checkpoints.

Run a workflow

The runtime entry point that executes a SmithersWorkflow.

Types

The shared type surface: contexts, nodes, and workflow shapes.

Errors

The error classes Smithers throws and how to catch them.

Event types

The run event schema emitted to logs, streams, and the UI.

VCS helpers

Helpers for worktrees, diffs, and version-control operations.

Package configuration

The smithers.config fields and how the backend is resolved.

Launch a run (RPC)

The Gateway RPC method that starts a new run.