@mastra/core 1.9.0 → 1.10.0

package/dist/docs/references/reference-workflows-run-methods-restart.md

@@ -14,17 +14,29 @@ const restartedResult = await run.restart()
 
 ## Parameters
 
-**requestContext?:** (`RequestContext`): Request Context data to use when resuming
+**requestContext** (`RequestContext`): Request Context data to use when resuming
 
-**tracingContext?:** (`TracingContext`): currentSpan?:SpanCurrent span for creating child spans and adding metadata. Use this to create custom child spans or update span attributes during execution.
+**tracingContext** (`TracingContext`): Tracing context for creating child spans and adding metadata. Automatically injected when using Mastra's tracing system.
 
-**tracingOptions?:** (`TracingOptions`): metadata?:Record\<string, any>Metadata to add to the root trace span. Useful for adding custom attributes like user IDs, session IDs, or feature flags.requestContextKeys?:string\[]Additional RequestContext keys to extract as metadata for this trace. Supports dot notation for nested values (e.g., 'user.id').traceId?:stringTrace ID to use for this execution (1-32 hexadecimal characters). If provided, this trace will be part of the specified trace.parentSpanId?:stringParent span ID to use for this execution (1-16 hexadecimal characters). If provided, the root span will be created as a child of this span.tags?:string\[]Tags to apply to this trace. String labels for categorizing and filtering traces.
+**tracingContext.currentSpan** (`Span`): Current span for creating child spans and adding metadata. Use this to create custom child spans or update span attributes during execution.
+
+**tracingOptions** (`TracingOptions`): Options for Tracing configuration.
+
+**tracingOptions.metadata** (`Record<string, any>`): Metadata to add to the root trace span. Useful for adding custom attributes like user IDs, session IDs, or feature flags.
+
+**tracingOptions.requestContextKeys** (`string[]`): Additional RequestContext keys to extract as metadata for this trace. Supports dot notation for nested values (e.g., 'user.id').
+
+**tracingOptions.traceId** (`string`): Trace ID to use for this execution (1-32 hexadecimal characters). If provided, this trace will be part of the specified trace.
+
+**tracingOptions.parentSpanId** (`string`): Parent span ID to use for this execution (1-16 hexadecimal characters). If provided, the root span will be created as a child of this span.
+
+**tracingOptions.tags** (`string[]`): Tags to apply to this trace. String labels for categorizing and filtering traces.
 
 ## Returns
 
-**result:** (`Promise<WorkflowResult<TState, TOutput, TSteps>>`): A promise that resolves to the workflow execution result containing step outputs and status
+**result** (`Promise<WorkflowResult<TState, TOutput, TSteps>>`): A promise that resolves to the workflow execution result containing step outputs and status
 
-**traceId?:** (`string`): The trace ID associated with this execution when Tracing is enabled. Use this to correlate logs and debug execution flow.
+**traceId** (`string`): The trace ID associated with this execution when Tracing is enabled. Use this to correlate logs and debug execution flow.
 
 ## Related
 

package/dist/docs/references/reference-workflows-run-methods-resume.md

@@ -18,25 +18,39 @@ if (result.status === 'suspended') {
 
 ## Parameters
 
-**resumeData?:** (`z.infer<TResumeSchema>`): Data for resuming the suspended step
+**resumeData** (`z.infer<TResumeSchema>`): Data for resuming the suspended step
 
-**step?:** (`Step<string, any, any, TResumeSchema, any, TEngineType> | [...Step<string, any, any, any, any, TEngineType>[], Step<string, any, any, TResumeSchema, any, TEngineType>] | string | string[]`): The step(s) to resume execution from. Can be a Step instance, array of Steps, step ID string, or array of step ID strings
+**step** (`Step<string, any, any, TResumeSchema, any, TEngineType> | [...Step<string, any, any, any, any, TEngineType>[], Step<string, any, any, TResumeSchema, any, TEngineType>] | string | string[]`): The step(s) to resume execution from. Can be a Step instance, array of Steps, step ID string, or array of step ID strings
 
-**requestContext?:** (`RequestContext`): Request Context data to use when resuming
+**requestContext** (`RequestContext`): Request Context data to use when resuming
 
-**retryCount?:** (`number`): Optional retry count for nested workflow execution
+**retryCount** (`number`): Optional retry count for nested workflow execution
 
-**tracingContext?:** (`TracingContext`): currentSpan?:SpanCurrent span for creating child spans and adding metadata. Use this to create custom child spans or update span attributes during execution.
+**tracingContext** (`TracingContext`): Tracing context for creating child spans and adding metadata. Automatically injected when using Mastra's tracing system.
 
-**tracingOptions?:** (`TracingOptions`): metadata?:Record\<string, any>Metadata to add to the root trace span. Useful for adding custom attributes like user IDs, session IDs, or feature flags.requestContextKeys?:string\[]Additional RequestContext keys to extract as metadata for this trace. Supports dot notation for nested values (e.g., 'user.id').traceId?:stringTrace ID to use for this execution (1-32 hexadecimal characters). If provided, this trace will be part of the specified trace.parentSpanId?:stringParent span ID to use for this execution (1-16 hexadecimal characters). If provided, the root span will be created as a child of this span.tags?:string\[]Tags to apply to this trace. String labels for categorizing and filtering traces.
+**tracingContext.currentSpan** (`Span`): Current span for creating child spans and adding metadata. Use this to create custom child spans or update span attributes during execution.
 
-**outputOptions?:** (`OutputOptions`): includeState?:booleanWhether to include the workflow run state in the result.
+**tracingOptions** (`TracingOptions`): Options for Tracing configuration.
+
+**tracingOptions.metadata** (`Record<string, any>`): Metadata to add to the root trace span. Useful for adding custom attributes like user IDs, session IDs, or feature flags.
+
+**tracingOptions.requestContextKeys** (`string[]`): Additional RequestContext keys to extract as metadata for this trace. Supports dot notation for nested values (e.g., 'user.id').
+
+**tracingOptions.traceId** (`string`): Trace ID to use for this execution (1-32 hexadecimal characters). If provided, this trace will be part of the specified trace.
+
+**tracingOptions.parentSpanId** (`string`): Parent span ID to use for this execution (1-16 hexadecimal characters). If provided, the root span will be created as a child of this span.
+
+**tracingOptions.tags** (`string[]`): Tags to apply to this trace. String labels for categorizing and filtering traces.
+
+**outputOptions** (`OutputOptions`): Options for output configuration.
+
+**outputOptions.includeState** (`boolean`): Whether to include the workflow run state in the result.
 
 ## Returns
 
-**result:** (`Promise<WorkflowResult<TState, TOutput, TSteps>>`): A promise that resolves to the workflow execution result containing step outputs and status
+**result** (`Promise<WorkflowResult<TState, TOutput, TSteps>>`): A promise that resolves to the workflow execution result containing step outputs and status
 
-**traceId?:** (`string`): The trace ID associated with this execution when Tracing is enabled. Use this to correlate logs and debug execution flow.
+**traceId** (`string`): The trace ID associated with this execution when Tracing is enabled. Use this to correlate logs and debug execution flow.
 
 ## Extended usage example
 

package/dist/docs/references/reference-workflows-run-methods-start.md

@@ -16,23 +16,37 @@ const result = await run.start({
 
 ## Parameters
 
-**inputData?:** (`z.infer<TInput>`): Input data that matches the workflow's input schema
+**inputData** (`z.infer<TInput>`): Input data that matches the workflow's input schema
 
-**requestContext?:** (`RequestContext`): Request Context data to use during workflow execution
+**requestContext** (`RequestContext`): Request Context data to use during workflow execution
 
-**outputWriter?:** (`(chunk: TOutput) => Promise<void>`): Optional asynchronous function to handle output chunks as they are produced
+**outputWriter** (`(chunk: TOutput) => Promise<void>`): Optional asynchronous function to handle output chunks as they are produced
 
-**tracingContext?:** (`TracingContext`): currentSpan?:SpanCurrent span for creating child spans and adding metadata. Use this to create custom child spans or update span attributes during execution.
+**tracingContext** (`TracingContext`): Tracing context for creating child spans and adding metadata. Automatically injected when using Mastra's tracing system.
 
-**tracingOptions?:** (`TracingOptions`): metadata?:Record\<string, any>Metadata to add to the root trace span. Useful for adding custom attributes like user IDs, session IDs, or feature flags.requestContextKeys?:string\[]Additional RequestContext keys to extract as metadata for this trace. Supports dot notation for nested values (e.g., 'user.id').traceId?:stringTrace ID to use for this execution (1-32 hexadecimal characters). If provided, this trace will be part of the specified trace.parentSpanId?:stringParent span ID to use for this execution (1-16 hexadecimal characters). If provided, the root span will be created as a child of this span.tags?:string\[]Tags to apply to this trace. String labels for categorizing and filtering traces.
+**tracingContext.currentSpan** (`Span`): Current span for creating child spans and adding metadata. Use this to create custom child spans or update span attributes during execution.
 
-**outputOptions?:** (`OutputOptions`): includeState?:booleanWhether to include the workflow run state in the result.
+**tracingOptions** (`TracingOptions`): Options for Tracing configuration.
+
+**tracingOptions.metadata** (`Record<string, any>`): Metadata to add to the root trace span. Useful for adding custom attributes like user IDs, session IDs, or feature flags.
+
+**tracingOptions.requestContextKeys** (`string[]`): Additional RequestContext keys to extract as metadata for this trace. Supports dot notation for nested values (e.g., 'user.id').
+
+**tracingOptions.traceId** (`string`): Trace ID to use for this execution (1-32 hexadecimal characters). If provided, this trace will be part of the specified trace.
+
+**tracingOptions.parentSpanId** (`string`): Parent span ID to use for this execution (1-16 hexadecimal characters). If provided, the root span will be created as a child of this span.
+
+**tracingOptions.tags** (`string[]`): Tags to apply to this trace. String labels for categorizing and filtering traces.
+
+**outputOptions** (`OutputOptions`): Options for output configuration.
+
+**outputOptions.includeState** (`boolean`): Whether to include the workflow run state in the result.
 
 ## Returns
 
-**result:** (`Promise<WorkflowResult<TState, TOutput, TSteps>>`): A promise that resolves to the workflow execution result containing step outputs and status
+**result** (`Promise<WorkflowResult<TState, TOutput, TSteps>>`): A promise that resolves to the workflow execution result containing step outputs and status
 
-**traceId?:** (`string`): The trace ID associated with this execution when Tracing is enabled. Use this to correlate logs and debug execution flow.
+**traceId** (`string`): The trace ID associated with this execution when Tracing is enabled. Use this to correlate logs and debug execution flow.
 
 ## Extended usage example
 

package/dist/docs/references/reference-workflows-run-methods-startAsync.md

@@ -20,19 +20,25 @@ const result = await workflow.getWorkflowRunExecutionResult(runId)
 
 ## Parameters
 
-**inputData?:** (`z.infer<TInput>`): Input data that matches the workflow's input schema
+**inputData** (`z.infer<TInput>`): Input data that matches the workflow's input schema
 
-**requestContext?:** (`RequestContext`): Request Context data to use during workflow execution
+**requestContext** (`RequestContext`): Request Context data to use during workflow execution
 
-**initialState?:** (`z.infer<TState>`): Initial state to use for the workflow execution
+**initialState** (`z.infer<TState>`): Initial state to use for the workflow execution
 
-**tracingOptions?:** (`TracingOptions`): metadata?:Record\<string, any>Metadata to add to the root trace span. Useful for adding custom attributes like user IDs, session IDs, or feature flags.traceId?:stringTrace ID to use for this execution (1-32 hexadecimal characters). If provided, this trace will be part of the specified trace.
+**tracingOptions** (`TracingOptions`): Options for Tracing configuration.
 
-**outputOptions?:** (`OutputOptions`): includeState?:booleanWhether to include the workflow run state in the result.
+**tracingOptions.metadata** (`Record<string, any>`): Metadata to add to the root trace span. Useful for adding custom attributes like user IDs, session IDs, or feature flags.
+
+**tracingOptions.traceId** (`string`): Trace ID to use for this execution (1-32 hexadecimal characters). If provided, this trace will be part of the specified trace.
+
+**outputOptions** (`OutputOptions`): Options for output configuration.
+
+**outputOptions.includeState** (`boolean`): Whether to include the workflow run state in the result.
 
 ## Returns
 
-**runId:** (`string`): The unique identifier for this workflow run. Use this to check status or retrieve results later.
+**runId** (`string`): The unique identifier for this workflow run. Use this to check status or retrieve results later.
 
 ## When to use startAsync()
 

package/dist/docs/references/reference-workflows-run-methods-timeTravel.md

@@ -15,33 +15,49 @@ const result = await run.timeTravel({
 
 ## Parameters
 
-**step:** (`Step<string, any, TInputSchema, any, any, any, TEngineType> | [...Step<string, any, any, any, any, any, TEngineType>[], Step<string, any, TInputSchema, any, any, any, TEngineType>] | string | string[]`): The target step to start execution from. It can be a Step instance, array of Steps (for nested workflows), step ID string, or array of step ID strings. Use dot notation or arrays for nested workflow steps (e.g., 'nestedWorkflow\.step3' or \['nestedWorkflow', 'step3'])
+**step** (`Step<string, any, TInputSchema, any, any, any, TEngineType> | [...Step<string, any, any, any, any, any, TEngineType>[], Step<string, any, TInputSchema, any, any, any, TEngineType>] | string | string[]`): The target step to start execution from. It can be a Step instance, array of Steps (for nested workflows), step ID string, or array of step ID strings. Use dot notation or arrays for nested workflow steps (e.g., 'nestedWorkflow\.step3' or \['nestedWorkflow', 'step3'])
 
-**inputData?:** (`z.infer<TInputSchema>`): Input data for the target step. Must match the step's input schema. If not provided, uses data from the workflow snapshot
+**inputData** (`z.infer<TInputSchema>`): Input data for the target step. Must match the step's input schema. If not provided, uses data from the workflow snapshot
 
-**resumeData?:** (`any`): Resume data to provide if the workflow was previously suspended
+**resumeData** (`any`): Resume data to provide if the workflow was previously suspended
 
-**initialState?:** (`z.infer<TState>`): Initial state to set for the workflow run. Used to set workflow-level state before execution
+**initialState** (`z.infer<TState>`): Initial state to set for the workflow run. Used to set workflow-level state before execution
 
-**context?:** (`TimeTravelContext<any, any, any, any>`): Execution context containing step results for steps before the target step. Each key is a step ID with a StepResult object containing status, payload, output, startedAt, endedAt, suspendPayload, and resumePayload
+**context** (`TimeTravelContext<any, any, any, any>`): Execution context containing step results for steps before the target step. Each key is a step ID with a StepResult object containing status, payload, output, startedAt, endedAt, suspendPayload, and resumePayload
 
-**nestedStepsContext?:** (`Record<string, TimeTravelContext<any, any, any, any>>`): Context for nested workflow steps. Keyed by nested workflow ID, each containing step results for that nested workflow
+**nestedStepsContext** (`Record<string, TimeTravelContext<any, any, any, any>>`): Context for nested workflow steps. Keyed by nested workflow ID, each containing step results for that nested workflow
 
-**requestContext?:** (`RequestContext`): Request Context data to use during time travel execution
+**requestContext** (`RequestContext`): Request Context data to use during time travel execution
 
-**outputWriter?:** (`(chunk: TOutput) => Promise<void>`): Optional asynchronous function to handle output chunks as they are produced
+**outputWriter** (`(chunk: TOutput) => Promise<void>`): Optional asynchronous function to handle output chunks as they are produced
 
-**tracingContext?:** (`TracingContext`): currentSpan?:SpanCurrent span for creating child spans and adding metadata. Use this to create custom child spans or update span attributes during execution.
+**tracingContext** (`TracingContext`): Tracing context for creating child spans and adding metadata. Automatically injected when using Mastra's tracing system.
 
-**tracingOptions?:** (`TracingOptions`): metadata?:Record\<string, any>Metadata to add to the root trace span. Useful for adding custom attributes like user IDs, session IDs, or feature flags.requestContextKeys?:string\[]Additional RequestContext keys to extract as metadata for this trace. Supports dot notation for nested values (e.g., 'user.id').traceId?:stringTrace ID to use for this execution (1-32 hexadecimal characters). If provided, this trace will be part of the specified trace.parentSpanId?:stringParent span ID to use for this execution (1-16 hexadecimal characters). If provided, the root span will be created as a child of this span.tags?:string\[]Tags to apply to this trace. String labels for categorizing and filtering traces.
+**tracingContext.currentSpan** (`Span`): Current span for creating child spans and adding metadata. Use this to create custom child spans or update span attributes during execution.
 
-**outputOptions?:** (`OutputOptions`): includeState?:booleanWhether to include the workflow run state in the result.includeResumeLabels?:booleanWhether to include resume labels in the result.
+**tracingOptions** (`TracingOptions`): Options for Tracing configuration.
+
+**tracingOptions.metadata** (`Record<string, any>`): Metadata to add to the root trace span. Useful for adding custom attributes like user IDs, session IDs, or feature flags.
+
+**tracingOptions.requestContextKeys** (`string[]`): Additional RequestContext keys to extract as metadata for this trace. Supports dot notation for nested values (e.g., 'user.id').
+
+**tracingOptions.traceId** (`string`): Trace ID to use for this execution (1-32 hexadecimal characters). If provided, this trace will be part of the specified trace.
+
+**tracingOptions.parentSpanId** (`string`): Parent span ID to use for this execution (1-16 hexadecimal characters). If provided, the root span will be created as a child of this span.
+
+**tracingOptions.tags** (`string[]`): Tags to apply to this trace. String labels for categorizing and filtering traces.
+
+**outputOptions** (`OutputOptions`): Options for output configuration.
+
+**outputOptions.includeState** (`boolean`): Whether to include the workflow run state in the result.
+
+**outputOptions.includeResumeLabels** (`boolean`): Whether to include resume labels in the result.
 
 ## Returns
 
-**result:** (`Promise<WorkflowResult<TState, TInput, TOutput, TSteps>>`): A promise that resolves to the workflow execution result containing step outputs and status
+**result** (`Promise<WorkflowResult<TState, TInput, TOutput, TSteps>>`): A promise that resolves to the workflow execution result containing step outputs and status
 
-**traceId?:** (`string`): The trace ID associated with this execution when Tracing is enabled. Use this to correlate logs and debug execution flow.
+**traceId** (`string`): The trace ID associated with this execution when Tracing is enabled. Use this to correlate logs and debug execution flow.
 
 ## Extended usage examples
 

package/dist/docs/references/reference-workflows-run.md

@@ -20,33 +20,33 @@ if (result.status === 'suspended') {
 
 ## Run Methods
 
-**start:** (`(options?: StartOptions) => Promise<WorkflowResult>`): Starts workflow execution with input data
+**start** (`(options?: StartOptions) => Promise<WorkflowResult>`): Starts workflow execution with input data
 
-**resume:** (`(options?: ResumeOptions) => Promise<WorkflowResult>`): Resumes a suspended workflow from a specific step
+**resume** (`(options?: ResumeOptions) => Promise<WorkflowResult>`): Resumes a suspended workflow from a specific step
 
-**stream:** (`(options?: StreamOptions) => MastraWorkflowStream`): Monitors workflow execution as a stream of events with enhanced streaming features
+**stream** (`(options?: StreamOptions) => MastraWorkflowStream`): Monitors workflow execution as a stream of events with enhanced streaming features
 
-**resumeStream:** (`(options?: ResumeStreamOptions) => MastraWorkflowStream`): Resumes a suspended workflow with streaming support
+**resumeStream** (`(options?: ResumeStreamOptions) => MastraWorkflowStream`): Resumes a suspended workflow with streaming support
 
-**cancel:** (`() => Promise<{ message: string }>`): Cancels the workflow execution, stopping any running steps and preventing subsequent steps from executing
+**cancel** (`() => Promise<{ message: string }>`): Cancels the workflow execution, stopping any running steps and preventing subsequent steps from executing
 
-**restart:** (`(options?: RestartOptions) => Promise<WorkflowResult>`): Restarts the workflow execution from last active step
+**restart** (`(options?: RestartOptions) => Promise<WorkflowResult>`): Restarts the workflow execution from last active step
 
-**timeTravel:** (`(options?: TimeTravelOptions) => Promise<WorkflowResult>`): Re-executes a workflow starting from any specific step, using either stored snapshot data or custom context you provide.
+**timeTravel** (`(options?: TimeTravelOptions) => Promise<WorkflowResult>`): Re-executes a workflow starting from any specific step, using either stored snapshot data or custom context you provide.
 
-**timeTravelStream:** (`(options?: TimeTravelOptions) => MastraWorkflowStream`): Time travels a workflow execution with streaming support
+**timeTravelStream** (`(options?: TimeTravelOptions) => MastraWorkflowStream`): Time travels a workflow execution with streaming support
 
 ## Run Status
 
 A workflow run's `status` indicates its current execution state. The possible values are:
 
-**success:** (`string`): All steps finished executing successfully, with a valid result output
+**success** (`string`): All steps finished executing successfully, with a valid result output
 
-**failed:** (`string`): Workflow execution encountered an error during execution, with error details available
+**failed** (`string`): Workflow execution encountered an error during execution, with error details available
 
-**suspended:** (`string`): Workflow execution is paused waiting for resume, with suspended step information
+**suspended** (`string`): Workflow execution is paused waiting for resume, with suspended step information
 
-**canceled:** (`string`): Workflow execution was canceled via the cancel() method, stopping any running steps and preventing subsequent steps from executing
+**canceled** (`string`): Workflow execution was canceled via the cancel() method, stopping any running steps and preventing subsequent steps from executing
 
 ## Related
 

package/dist/docs/references/reference-workflows-step.md

@@ -60,57 +60,55 @@ const agentStep = createStep(testAgent, {
 
 ### Agent step options
 
-**structuredOutput:** (`{ schema: z.ZodType<any> }`): When provided, the agent returns structured data matching this schema instead of plain text. The step's outputSchema is set to the provided schema.
+**structuredOutput** (`{ schema: z.ZodType<any> }`): When provided, the agent returns structured data matching this schema instead of plain text. The step's outputSchema is set to the provided schema.
 
-**onFinish:** (`(result: AgentResult) => void`): Callback invoked when the agent completes generation.
+**onFinish** (`(result: AgentResult) => void`): Callback invoked when the agent completes generation.
 
 ## Constructor Parameters
 
-**id:** (`string`): Unique identifier for the step
+**id** (`string`): Unique identifier for the step
 
-**description:** (`string`): Optional description of what the step does
+**description** (`string`): Optional description of what the step does
 
-**inputSchema:** (`z.ZodType<any>`): Zod schema defining the input structure
+**inputSchema** (`z.ZodType<any>`): Zod schema defining the input structure
 
-**outputSchema:** (`z.ZodType<any>`): Zod schema defining the output structure
+**outputSchema** (`z.ZodType<any>`): Zod schema defining the output structure
 
-**resumeSchema:** (`z.ZodType<any>`): Optional Zod schema for resuming the step
+**resumeSchema** (`z.ZodType<any>`): Optional Zod schema for resuming the step
 
-**suspendSchema:** (`z.ZodType<any>`): Optional Zod schema for suspending the step
+**suspendSchema** (`z.ZodType<any>`): Optional Zod schema for suspending the step
 
-**stateSchema:** (`z.ZodObject<any>`): Optional Zod schema for the step state. Automatically injected when using Mastra's state system. The stateSchema must be a subset of the workflow's stateSchema. If not specified, type is 'any'.
+**stateSchema** (`z.ZodObject<any>`): Optional Zod schema for the step state. Automatically injected when using Mastra's state system. The stateSchema must be a subset of the workflow's stateSchema. If not specified, type is 'any'.
 
-**requestContextSchema:** (`z.ZodType<any>`): Zod schema for validating request context values. When provided, the context is validated before the step's execute() runs, failing the step if validation fails.
+**requestContextSchema** (`z.ZodType<any>`): Zod schema for validating request context values. When provided, the context is validated before the step's execute() runs, failing the step if validation fails.
 
-**execute:** (`(params: ExecuteParams) => Promise<any>`): Async function containing step logic
+**execute** (`(params: ExecuteParams) => Promise<any>`): Async function containing step logic
 
-**metadata:** (`Record<string, any>`): Optional key-value pairs for storing additional step information. Values must be serializable (no functions, circular references, etc.).
+**execute.inputData** (`z.infer<TStepInput>`): The input data matching the inputSchema
 
-### ExecuteParams
+**execute.resumeData** (`z.infer<TResumeSchema>`): The resume data matching the resumeSchema, when resuming the step from a suspended state. Only exists if the step is being resumed.
 
-**inputData:** (`z.infer<TStepInput>`): The input data matching the inputSchema
+**execute.suspendData** (`z.infer<TSuspendSchema>`): The suspend data that was originally passed to suspend() when the step was suspended. Only exists if the step is being resumed and was previously suspended with data.
 
-**resumeData:** (`z.infer<TResumeSchema>`): The resume data matching the resumeSchema, when resuming the step from a suspended state. Only exists if the step is being resumed.
+**execute.mastra** (`Mastra`): Access to Mastra services (agents, tools, etc.)
 
-**suspendData:** (`z.infer<TSuspendSchema>`): The suspend data that was originally passed to suspend() when the step was suspended. Only exists if the step is being resumed and was previously suspended with data.
+**execute.getStepResult** (`(step: Step | string) => any`): Function to access results from other steps
 
-**mastra:** (`Mastra`): Access to Mastra services (agents, tools, etc.)
+**execute.getInitData** (`() => any`): Function to access the initial input data of the workflow in any step
 
-**getStepResult:** (`(step: Step | string) => any`): Function to access results from other steps
+**execute.suspend** (`(suspendPayload: any, suspendOptions?: { resumeLabel?: string }) => Promise<void>`): Function to pause workflow execution
 
-**getInitData:** (`() => any`): Function to access the initial input data of the workflow in any step
+**execute.state** (`z.infer<TState>`): The current workflow state. Contains shared values that persist across all steps and suspend/resume cycles. The structure is defined by the step's stateSchema.
 
-**suspend:** (`(suspendPayload: any, suspendOptions?: { resumeLabel?: string }) => Promise<void>`): Function to pause workflow execution
+**execute.setState** (`(state: z.infer<TState>) => void`): Function to set the state of the workflow. Inject via reducer-like pattern, such as 'setState({ ...state, ...newState })'
 
-**state:** (`z.infer<TState>`): The current workflow state. Contains shared values that persist across all steps and suspend/resume cycles. The structure is defined by the step's stateSchema.
+**execute.runId** (`string`): Current run id
 
-**setState:** (`(state: z.infer<TState>) => void`): Function to set the state of the workflow. Inject via reducer-like pattern, such as 'setState({ ...state, ...newState })'
+**execute.requestContext** (`RequestContext`): Request Context for dependency injection and contextual information.
 
-**runId:** (`string`): Current run id
+**execute.retryCount** (`number`): The retry count for this specific step, it automatically increases each time the step is retried
 
-**requestContext?:** (`RequestContext`): Request Context for dependency injection and contextual information.
-
-**retryCount?:** (`number`): The retry count for this specific step, it automatically increases each time the step is retried
+**metadata** (`Record<string, any>`): Optional key-value pairs for storing additional step information. Values must be serializable (no functions, circular references, etc.).
 
 ## Related
 

package/dist/docs/references/reference-workflows-workflow-methods-branch.md

@@ -13,11 +13,11 @@ workflow.branch([
 
 ## Parameters
 
-**steps:** (`[() => boolean, Step]`): An array of tuples, each containing a condition function and a step to execute if the condition is true
+**steps** (`[() => boolean, Step]`): An array of tuples, each containing a condition function and a step to execute if the condition is true
 
 ## Returns
 
-**workflow:** (`NewWorkflow`): The workflow instance for method chaining
+**workflow** (`NewWorkflow`): The workflow instance for method chaining
 
 ## Related
 

package/dist/docs/references/reference-workflows-workflow-methods-commit.md

@@ -10,7 +10,7 @@ workflow.then(step1).commit()
 
 ## Returns
 
-**workflow:** (`Workflow`): The workflow instance for method chaining
+**workflow** (`Workflow`): The workflow instance for method chaining
 
 ## Related
 

package/dist/docs/references/reference-workflows-workflow-methods-create-run.md

@@ -10,15 +10,15 @@ await workflow.createRun()
 
 ## Parameters
 
-**runId?:** (`string`): Optional custom identifier for the workflow run
+**runId** (`string`): Optional custom identifier for the workflow run
 
-**resourceId?:** (`string`): Optional identifier to associate the workflow run with a specific resource (e.g., user ID, tenant ID). This value is persisted with the workflow run and can be used for filtering and querying runs.
+**resourceId** (`string`): Optional identifier to associate the workflow run with a specific resource (e.g., user ID, tenant ID). This value is persisted with the workflow run and can be used for filtering and querying runs.
 
-**disableScorers?:** (`boolean`): Optional flag to disable scorers for this workflow run
+**disableScorers** (`boolean`): Optional flag to disable scorers for this workflow run
 
 ## Returns
 
-**run:** (`Run`): A new workflow run instance that can be used to execute the workflow
+**run** (`Run`): A new workflow run instance that can be used to execute the workflow
 
 ## Extended usage example
 

package/dist/docs/references/reference-workflows-workflow-methods-dountil.md

@@ -10,13 +10,13 @@ workflow.dountil(step1, async ({ inputData }) => true)
 
 ## Parameters
 
-**step:** (`Step`): The step instance to execute in the loop
+**step** (`Step`): The step instance to execute in the loop
 
-**condition:** (`(params : ExecuteParams & { iterationCount: number }) => Promise<boolean>`): A function that returns a boolean indicating whether to continue the loop. The function receives the execution parameters and the iteration count.
+**condition** (`(params : ExecuteParams & { iterationCount: number }) => Promise<boolean>`): A function that returns a boolean indicating whether to continue the loop. The function receives the execution parameters and the iteration count.
 
 ## Returns
 
-**workflow:** (`Workflow`): The workflow instance for method chaining
+**workflow** (`Workflow`): The workflow instance for method chaining
 
 ## Related
 

package/dist/docs/references/reference-workflows-workflow-methods-dowhile.md

@@ -10,13 +10,13 @@ workflow.dowhile(step1, async ({ inputData }) => true)
 
 ## Parameters
 
-**step:** (`Step`): The step instance to execute in the loop
+**step** (`Step`): The step instance to execute in the loop
 
-**condition:** (`(params : ExecuteParams & { iterationCount: number }) => Promise<boolean>`): A function that returns a boolean indicating whether to continue the loop. The function receives the execution parameters and the iteration count.
+**condition** (`(params : ExecuteParams & { iterationCount: number }) => Promise<boolean>`): A function that returns a boolean indicating whether to continue the loop. The function receives the execution parameters and the iteration count.
 
 ## Returns
 
-**workflow:** (`Workflow`): The workflow instance for method chaining
+**workflow** (`Workflow`): The workflow instance for method chaining
 
 ## Related
 

package/dist/docs/references/reference-workflows-workflow-methods-foreach.md

@@ -10,13 +10,13 @@ workflow.foreach(step1, { concurrency: 2 })
 
 ## Parameters
 
-**step:** (`Step`): The step instance to execute in the loop. The previous step must return an array type.
+**step** (`Step`): The step instance to execute in the loop. The previous step must return an array type.
 
-**opts?:** (`object`): number
+**opts** (`object`): Optional configuration for the loop. The concurrency option controls how many iterations can run in parallel (default: 1)
 
 ## Returns
 
-**workflow:** (`Workflow`): The workflow instance for method chaining. The output type is an array of the step's output type.
+**workflow** (`Workflow`): The workflow instance for method chaining. The output type is an array of the step's output type.
 
 ## Behavior
 
@@ -101,17 +101,17 @@ for await (const chunk of stream) {
 
 Each progress event payload contains:
 
-**id:** (`string`): The step ID of the foreach step
+**id** (`string`): The step ID of the foreach step
 
-**completedCount:** (`number`): Number of iterations completed so far
+**completedCount** (`number`): Number of iterations completed so far
 
-**totalCount:** (`number`): Total number of iterations
+**totalCount** (`number`): Total number of iterations
 
-**currentIndex:** (`number`): Index of the iteration that just completed
+**currentIndex** (`number`): Index of the iteration that just completed
 
-**iterationStatus:** (`'success' | 'failed' | 'suspended'`): Status of the iteration that just completed
+**iterationStatus** (`'success' | 'failed' | 'suspended'`): Status of the iteration that just completed
 
-**iterationOutput?:** (`Record<string, any>`): Output of the iteration (present when iterationStatus is 'success')
+**iterationOutput** (`Record<string, any>`): Output of the iteration (present when iterationStatus is 'success')
 
 ## Related
 

package/dist/docs/references/reference-workflows-workflow-methods-map.md

@@ -10,11 +10,11 @@ workflow.map(async ({ inputData }) => `${inputData.value} - map`)
 
 ## Parameters
 
-**mappingFunction:** (`(params: { inputData: any }) => any`): Function that transforms input data and returns the mapped result
+**mappingFunction** (`(params: { inputData: any }) => any`): Function that transforms input data and returns the mapped result
 
 ## Returns
 
-**workflow:** (`Workflow`): The workflow instance for method chaining
+**workflow** (`Workflow`): The workflow instance for method chaining
 
 ## Using `inputData`
 

package/dist/docs/references/reference-workflows-workflow-methods-parallel.md

@@ -10,11 +10,11 @@ workflow.parallel([step1, step2])
 
 ## Parameters
 
-**steps:** (`Step[]`): The step instances to execute in parallel
+**steps** (`Step[]`): The step instances to execute in parallel
 
 ## Returns
 
-**workflow:** (`Workflow`): The workflow instance for method chaining
+**workflow** (`Workflow`): The workflow instance for method chaining
 
 ## Related
 

package/dist/docs/references/reference-workflows-workflow-methods-sleep.md

@@ -10,11 +10,11 @@ workflow.sleep(5000)
 
 ## Parameters
 
-**milliseconds:** (`number | ((context: { inputData: any }) => number | Promise<number>)`): The number of milliseconds to pause execution, or a callback that returns the delay
+**milliseconds** (`number | ((context: { inputData: any }) => number | Promise<number>)`): The number of milliseconds to pause execution, or a callback that returns the delay
 
 ## Returns
 
-**workflow:** (`Workflow`): The workflow instance for method chaining
+**workflow** (`Workflow`): The workflow instance for method chaining
 
 ## Extended usage example
 

package/dist/docs/references/reference-workflows-workflow-methods-sleepUntil.md

@@ -10,11 +10,11 @@ workflow.sleepUntil(new Date(Date.now() + 5000))
 
 ## Parameters
 
-**dateOrCallback:** (`Date | ((params: ExecuteFunctionParams) => Promise<Date>)`): Either a Date object or a callback function that returns a Date. The callback receives execution context and can compute the target time dynamically based on input data.
+**dateOrCallback** (`Date | ((params: ExecuteFunctionParams) => Promise<Date>)`): Either a Date object or a callback function that returns a Date. The callback receives execution context and can compute the target time dynamically based on input data.
 
 ## Returns
 
-**workflow:** (`Workflow`): The workflow instance for method chaining
+**workflow** (`Workflow`): The workflow instance for method chaining
 
 ## Extended usage example
 

package/dist/docs/references/reference-workflows-workflow-methods-then.md

@@ -10,11 +10,11 @@ workflow.then(step1).then(step2)
 
 ## Parameters
 
-**step:** (`Step`): The step instance that should execute after the previous step completes
+**step** (`Step`): The step instance that should execute after the previous step completes
 
 ## Returns
 
-**workflow:** (`NewWorkflow`): The workflow instance for method chaining
+**workflow** (`NewWorkflow`): The workflow instance for method chaining
 
 ## Related