Skip to Content
リファレンスクライアントSDKワークフロー(レガシー) API

ワークフロー(レガシー)API

ワークフロー(レガシー)APIは、Mastraの自動化されたレガシーワークフローと対話し、実行するためのメソッドを提供します。

Mastraクライアントの初期化

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

レガシーワークフローの取得

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

const workflows = await client.getLegacyWorkflows();

特定のレガシーワークフローの操作

特定のレガシーワークフローのインスタンスを取得します:

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

レガシーワークフローメソッド

レガシーワークフローの詳細を取得

レガシーワークフローの詳細情報を取得します:

const details = await workflow.details();

レガシーワークフローの実行を非同期で開始

triggerData を指定してレガシーワークフローの実行を開始し、実行結果を待ちます:

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

レガシーワークフローの実行を非同期で再開

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

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

レガシーワークフローの監視

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

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

レガシーワークフローの再開

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

try { //To resume a workflow run, when a step is suspended const { run } = createRun({ runId: prevRunId }); //Watch run workflow.watch({ runId }, (record) => { // Every new record is the latest transition state of the workflow run console.log({ activePaths: record.activePaths, results: record.results, timestamp: record.timestamp, runId: record.runId, }); }); //resume run workflow.resume({ runId, stepId: "step-id", contextData: { key: "value" }, }); } catch (e) { console.error(e); }

レガシーワークフロー実行結果

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

フィールド説明
activePathsRecord<string, { status: string; suspendPayload?: any; stepPath: string[] }>ワークフロー内で現在アクティブなパスとその実行ステータス
resultsLegacyWorkflowRunResult<any, any, any>['results']ワークフロー実行からの結果
timestampnumberこの遷移が発生した Unix タイムスタンプ
runIdstringこのワークフロー実行インスタンスの一意な識別子