World SDK

Low-level API for inspecting and managing workflow runs, steps, events, hooks, streams, and queues.

The World SDK provides direct access to workflow infrastructure — runs, steps, events, hooks, streams, and queues. Use it to build observability dashboards, admin panels, debugging tools, and custom workflow management logic.

import { getWorld } from "workflow/runtime";

const world = getWorld();

Entities

world.runs

List, filter, and inspect workflow runs with pagination and status filtering.

world.steps

List and inspect step execution data including input/output hydration.

world.hooks

Look up hooks by ID or token for webhook resume flows.

world.events

Query the append-only event log — the source of truth for all workflow state changes.

world.streams

Read, write, and manage real-time data streams for workflow runs.

world.queue

Enqueue workflow runs and create queue handlers for processing.

Observability Utilities

Hydrate step I/O, parse display names, and decrypt workflow data.

The World SDK is the low-level foundation that higher-level functions like getRun() and start() are built on. Use it when you need capabilities beyond what those functions provide.

Data Hydration

Step input/output data is serialized using the devalue format. To display this data in your UI, use the hydration utilities from workflow/observability:

import { hydrateResourceIO, observabilityRevivers } from "workflow/observability"; 

const step = await world.steps.get(runId, stepId);
const hydrated = hydrateResourceIO(step, observabilityRevivers); 
console.log(hydrated.input, hydrated.output);

See Observability Utilities for the full API.