WorkflowStore
Defined in: packages/core/src/observability/workflow-store.ts:50
Workflow run persistence: materialized run/step I/O plus append-only RunEvents.
Observers (WorkflowObserver) are push-only — no reads. WorkflowStore supports
queries (listRuns, listEvents, getStepOutput) for UI and step skip on retry.
RunRecorder writes to both when configured. Separate from MessageStore.
Default implementation: inMemoryWorkflowStore.
Methods
Section titled “Methods”deleteRun()
Section titled “deleteRun()”deleteRun(
workflowRunId):Promise<void>
Defined in: packages/core/src/observability/workflow-store.ts:82
Remove a run and its events / step records.
Parameters
Section titled “Parameters”workflowRunId
Section titled “workflowRunId”string
Returns
Section titled “Returns”Promise<void>
getLatestEvent()
Section titled “getLatestEvent()”getLatestEvent<
T>(scope,type):Promise<RunEventOfType<T> |null>
Defined in: packages/core/src/observability/workflow-store.ts:60
Type Parameters
Section titled “Type Parameters”T extends "custom" | "workflow_started" | "workflow_finished" | "workflow_failed" | "workflow_cancelled" | "step_started" | "step_finished" | "step_skipped" | "step_failed" | "workflow_title_set" | "agent_started" | "agent_finished" | "agent_failed" | "agent_warning" | "agent_tool_call" | "agent_tool_result" | "agent_text_delta" | "agent_messages_committed" | "agent_title_set" | "conversation_forked"
Parameters
Section titled “Parameters”T
Returns
Section titled “Returns”Promise<RunEventOfType<T> | null>
getRun()
Section titled “getRun()”getRun(
workflowRunId):Promise<WorkflowRunSummary|null>
Defined in: packages/core/src/observability/workflow-store.ts:65
Parameters
Section titled “Parameters”workflowRunId
Section titled “workflowRunId”string
Returns
Section titled “Returns”Promise<WorkflowRunSummary | null>
getRunInput()
Section titled “getRunInput()”getRunInput(
workflowRunId):Promise<unknown>
Defined in: packages/core/src/observability/workflow-store.ts:72
Parameters
Section titled “Parameters”workflowRunId
Section titled “workflowRunId”string
Returns
Section titled “Returns”Promise<unknown>
getRunOutput()
Section titled “getRunOutput()”getRunOutput(
workflowRunId):Promise<unknown>
Defined in: packages/core/src/observability/workflow-store.ts:73
Parameters
Section titled “Parameters”workflowRunId
Section titled “workflowRunId”string
Returns
Section titled “Returns”Promise<unknown>
getStepById()
Section titled “getStepById()”getStepById(
workflowRunId,stepId):Promise<StepRecord|null>
Defined in: packages/core/src/observability/workflow-store.ts:75
Parameters
Section titled “Parameters”workflowRunId
Section titled “workflowRunId”string
stepId
Section titled “stepId”string
Returns
Section titled “Returns”Promise<StepRecord | null>
getStepOutput()
Section titled “getStepOutput()”getStepOutput(
workflowRunId,slot):Promise<unknown>
Defined in: packages/core/src/observability/workflow-store.ts:74
Parameters
Section titled “Parameters”workflowRunId
Section titled “workflowRunId”string
Returns
Section titled “Returns”Promise<unknown>
listAgentEpisodes()
Section titled “listAgentEpisodes()”listAgentEpisodes(
filter?):Promise<AgentEpisodeSummary[]>
Defined in: packages/core/src/observability/workflow-store.ts:85
Standalone and in-workflow agent episodes, newest first.
Parameters
Section titled “Parameters”filter?
Section titled “filter?”agentId?
Section titled “agentId?”string
limit?
Section titled “limit?”number
Returns
Section titled “Returns”Promise<AgentEpisodeSummary[]>
listEvents()
Section titled “listEvents()”listEvents(
scope,filter?):Promise<RunEvent[]>
Defined in: packages/core/src/observability/workflow-store.ts:58
Read events for a workflow run or a standalone agent episode.
Workflow-scoped queries return workflow + step + custom events for that workflowRunId.
Agent-scoped queries return agent events for that agentCallId.
Parameters
Section titled “Parameters”filter?
Section titled “filter?”Returns
Section titled “Returns”Promise<RunEvent[]>
listRuns()
Section titled “listRuns()”listRuns(
filter?):Promise<WorkflowRunSummary[]>
Defined in: packages/core/src/observability/workflow-store.ts:67
tags matches runs carrying any of the given tags (OR semantics).
Parameters
Section titled “Parameters”filter?
Section titled “filter?”limit?
Section titled “limit?”number
string[]
workflowId?
Section titled “workflowId?”string
Returns
Section titled “Returns”Promise<WorkflowRunSummary[]>
recordEvent()
Section titled “recordEvent()”recordEvent(
event):Promise<void>
Defined in: packages/core/src/observability/workflow-store.ts:51
Parameters
Section titled “Parameters”Returns
Section titled “Returns”Promise<void>
setRunTags()
Section titled “setRunTags()”setRunTags(
workflowRunId,tags):Promise<void>
Defined in: packages/core/src/observability/workflow-store.ts:80
Replace a run’s WorkflowRunSummary.tags.
Parameters
Section titled “Parameters”workflowRunId
Section titled “workflowRunId”string
string[]
Returns
Section titled “Returns”Promise<void>
setRunTitle()
Section titled “setRunTitle()”setRunTitle(
workflowRunId,title):Promise<void>
Defined in: packages/core/src/observability/workflow-store.ts:78
Set a display title without changing WorkflowRunSummary.workflowRunId.
Parameters
Section titled “Parameters”workflowRunId
Section titled “workflowRunId”string
string
Returns
Section titled “Returns”Promise<void>