ワークフローAPI

ワークフローAPIは、Mastraの自動化されたワークフローを操作および実行するためのメソッドを提供します。

Mastraクライアントの初期化


import { MastraClient } from "@mastra/client-js";
 
const client = new MastraClient();

すべてのワークフローの取得

利用可能なすべてのワークフローのリストを取得します：


const workflows = await client.getWorkflows();

特定のワークフローの操作

特定のワークフローのインスタンスを取得します：


const workflow = client.getWorkflow("workflow-id");

ワークフローメソッド

ワークフローの詳細を取得

ワークフローの詳細情報を取得します：


const details = await workflow.details();

ワークフロー実行を非同期で開始

triggerData を使ってワークフロー実行を開始し、実行結果を待ちます：


const run = workflow.createRun();
 
const result = await workflow.startAsync({
  runId: run.runId,
  inputData: {
    param1: "value1",
    param2: "value2",
  },
});

ワークフロー実行を非同期で再開

一時停止中のワークフローステップを再開し、実行結果を待ちます：


const run = workflow.createRun();
 
const result = await workflow.resumeAsync({
  runId: run.runId,
  step: "step-id",
  resumeData: { key: "value" },
});

ワークフローの監視

ワークフローの遷移を監視します


try {
  // Get workflow instance
  const workflow = client.getWorkflow("workflow-id");
 
  // Create a workflow run
  const run = workflow.createRun();
 
  // Watch workflow run
  workflow.watch({ runId: run.runId }, (record) => {
    // Every new record is the latest transition state of the workflow run
 
    console.log({
      currentStep: record.payload.currentStep,
      workflowState: record.payload.workflowState,
      eventTimestamp: record.eventTimestamp,
      runId: record.runId,
    });
  });
 
  // Start workflow run
  workflow.start({
    runId: run.runId,
    inputData: {
      city: "New York",
    },
  });
} catch (e) {
  console.error(e);
}

ワークフローの再開

ワークフロー実行を再開し、ワークフローステップの遷移を監視します


try {
  // Get workflow instance
  const workflow = client.getWorkflow("workflow-id");
 
  //To resume a workflow run, when a step is suspended
  const run = workflow.createRun({ runId: prevRunId });
 
  //Watch run
  workflow.watch({ runId: run.runId }, (record) => {
    // Every new record is the latest transition state of the workflow run
 
    console.log({
      currentStep: record.payload.currentStep,
      workflowState: record.payload.workflowState,
      eventTimestamp: record.eventTimestamp,
      runId: record.runId,
    });
  });
 
  //resume run
  workflow.resume({
    runId: run.runId,
    step: "step-id",
    resumeData: { key: "value" },
  });
} catch (e) {
  console.error(e);
}

ワークフロー実行結果

ワークフロー実行の結果は以下の内容を含みます：

フィールド	型	説明
`payload`	`{currentStep?: {id: string, status: string, output?: Record<string, any>, payload?: Record<string, any>}, workflowState: {status: string, steps: Record<string, {status: string, output?: Record<string, any>, payload?: Record<string, any>}>}}`	実行中のステップとワークフローの状態
`eventTimestamp`	`Date`	イベントのタイムスタンプ
`runId`	`string`	このワークフロー実行インスタンスの一意な識別子