Run.start()

The .start() method starts a workflow run with input data, allowing you to execute the workflow from the beginning.

Usage example


const run = await workflow.createRunAsync();
 
const result = await run.start({
  inputData: {
    value: "initial data",
  },
});

Parameters

inputData?:

z.infer<TInput>

Input data that matches the workflow's input schema

runtimeContext?:

RuntimeContext

Runtime context data to use during workflow execution

writableStream?:

WritableStream<ChunkType>

Optional writable stream for streaming workflow output

Returns

result:

Promise<WorkflowResult<TOutput, TSteps>>

A promise that resolves to the workflow execution result containing step outputs and status

Extended usage example


import { RuntimeContext } from "@mastra/core/runtime-context";
 
const run = await workflow.createRunAsync();
 
const runtimeContext = new RuntimeContext();
runtimeContext.set("variable", false);
 
const result = await run.start({
  inputData: {
    value: "initial data"
  },
  runtimeContext
});