ワークフロー
コアプラットフォームworkflow_definitions_readワークフロー施設のワークフロー自動化を読み取ります: ワークフロー、1つのワークフローのグラフ全体、グラフで使えるノードの種類、厳選されたテンプレート。グラフを作成または編集する前に node_types を確認し、すべての種類とパラメーターが施設で有効であるようにしてください。
アクション:
- list: ワークフローを一覧表示します。各ワークフローの稼働状態、公開バージョン、実行回数、最終実行、ノード(id、name、type)を表示します。ブランドと組織のワークフローは表示されません。
- get: ワークフローを取得します。下書きのグラフ全体(ノード、接続、メモ、設定)とメタ情報: active、publishedVersionId、公開後は現在稼働中のグラフである publishedWorkflow。この施設のワークフローのみです。workflowId が必要です。
- node_types: ノードの種類。type、label、category、outputs(分岐)、入力するパラメーターである inputSchema を含むパレットの項目。ノードに必要なモジュールが施設にない場合、available は false になり、理由が示されます。MCP ツールは mcp.
. ノードとして表示されます。 - templates: テンプレート。一般的な自動化の出発点で、risk と riskNote(不用意に公開した場合に起こる問題)、ノードの種類、必要なモジュール、この施設での利用可否、プレビューのグラフを含みます。workflow_definitions_write の instantiate_template でグラフに変換します。
パラメーター
| 名前 | 種類 | 説明 |
|---|---|---|
action* | "list" | "get" | "node_types" | "templates" | 実行する操作です。各操作はツールの説明に記載されています。 |
limit | integer | 1ページあたりの件数(既定 25、最大 100)(list、node_types、templates) |
cursor | string | 前のページの nextCursor(list、node_types、templates) |
facilityId | string | 施設 ID。接続中の施設が対象の場合は省略できます。 |
workflowId | string | workflow_definitions_read の list から取得したワークフロー ID(get) |
query | string | type、label、説明、検索語で探す言葉(node_types) |
category | string | このカテゴリのみ: trigger、action、logic、ai のいずれか(node_types) |
types | array | 説明を表示する正確な種類(例: 編集中のワークフローに含まれるもの)。パレットに表示されなくなった廃止済みの種類も含みます。query と category は無視されます。(node_types) |
workflow_definitions_writeワークフロー施設のワークフロー自動化を作成、編集、公開、停止、削除します。作成の流れ: workflow_definitions_read で node_types を確認し、グラフを作成し(または instantiate_template から始め)、下書きとして作成し、workflow_runs_write の test(シミュレーション)で試してから公開します。下書きの編集は、公開するまで稼働中のものを変更しません。
アクション:
- create: ワークフローを作成します。1つ以上のノードを含むグラフ全体から、新しい無効な下書きを保存します。name の既定値は "Untitled workflow" です。検証の問題はノードの詳細とともに errors で返されます。nodes が必要です。
- update: 下書きを保存します。下書き全体を置き換えます。変更点だけでなく、すべてのノードと接続を送信してください。稼働中のものは公開するまで実行され続けます。検証の問題はノードの詳細とともに errors で返されます。workflowId、nodes が必要です。
- patch_meta: 名前を変更します。名前または説明のみを変更し、グラフと稼働中のものはそのままです。両方が既に一致している場合、changed は false です。workflowId が必要です。
- duplicate: 複製します。新しいノード ID を付けて、ワークフローを "
(copy)" という名前の新しい下書きにコピーします。公開も有効化もされません。元のワークフローは変更されません。workflowId が必要です。 - delete: 削除します。ワークフローを完全に削除します: 下書き、公開バージョン、実行履歴、トリガーのルーティング。set_active false は停止しますが保持し、discard_draft は下書きの編集をリセットするだけです。workflowId が必要です。確認を求めます。
- discard_draft: 下書きの編集を破棄します。下書きを最後に公開したバージョンに戻し、それ以降の編集を破棄します。稼働中のバージョンには影響しません。公開済みのバージョンが必要です。workflowId が必要です。確認を求めます。
- publish: 公開します。下書きを検証して稼働バージョンとして保存し、ワークフローをオンにするため、トリガーが発火し、アクションが実際に実行されます。進行中の実行は古いバージョンで完了します。待機中の Delay ステップの時刻が変わる場合、結果にコード WAIT_RETARGET_CONFIRMATION_REQUIRED と impacts が含まれます。confirmWaitRetargets とその impacts を付けて再度呼び出してください。workflowId が必要です。確認を求めます。
- set_active: オンまたはオフにします。active true は公開済みのワークフローを再びオンにします。active false は停止します: トリガーの発火が止まり、保留中の Delay ステップはキャンセルされ、完了しません。何も削除されません。既にその状態でない限り、事前に確認します。workflowId、active が必要です。確認を求める場合があります。
- instantiate_template: テンプレートからグラフを作成します。テンプレートを create にそのまま使えるグラフ { name, description, nodes, connections } に変換し、新しいノード ID を付けます。テンプレートでは受信者、ドア、時刻を意図的に空欄にしているため、先に入力してください。何も保存しません。templateId が必要です。
- generate: グラフを生成します。施設の AI で自然な言葉のプロンプトからグラフを作成し、有効なノードの種類だけを使った { name, description, nodes, connections } を返します。修正するには workflow を渡します。修正後のグラフ全体が返されます。何も保存しませんが、施設の AI クレジットを消費します。prompt が必要です。確認を求めます。
パラメーター
| 名前 | 種類 | 説明 |
|---|---|---|
action* | "create" | "update" | "patch_meta" | "duplicate" | "delete" | "discard_draft" | "publish" | "set_active" | "instantiate_template" | "generate" | 実行する操作です。各操作はツールの説明に記載されています。 |
name | string | ワークフロー名(create、update、patch_meta) |
description | string | ワークフローの内容(create、update、patch_meta) |
nodes | array | すべてのノード: { id, name, type, position, parameters }。種類とパラメーターは workflow_definitions_read の node_types から取得します。(create、update) |
connections | object | 接続元のノード名をキーとする接続。ノードが1つの場合は空でもかまいません(create、update) |
notes | array | キャンバスのメモ(create、update) |
settings | object | ワークフローの設定(create、update) |
facilityId | string | 施設 ID。接続中の施設が対象の場合は省略できます。 |
workflowId | string | workflow_definitions_read の list から取得したワークフロー ID(update、patch_meta、duplicate、delete、discard_draft、publish、set_active) |
confirmWaitRetargets | boolean | 前回の結果の impacts に記載された、待機中の Delay ステップの時刻を変更します(publish) |
confirmedWaitRetargets | array | WAIT_RETARGET_CONFIRMATION_REQUIRED の結果に含まれる impacts。変更せずに送り返します(publish) |
active | boolean | true でオン、false で停止(set_active) |
templateId | string | workflow_definitions_read の templates から取得したテンプレート ID(instantiate_template) |
prompt | string | ワークフローに行わせたいこと(generate) |
workflow | object | 一から作成する代わりに修正する、workflow_definitions_read の get で取得したワークフロー全体(generate) |
confirm | boolean | 最初の呼び出しで返されたプレビューをユーザーが確認した後にのみ設定します |
workflow_runs_readワークフローワークフローの実行履歴を新しい順に表示し、1つの実行をステップごとに表示します。自動化が実行されたかの確認、workflow_runs_write で開始した実行の追跡、どのノードがなぜ失敗したかの調査に使用します。
アクション:
- list: 実行を一覧表示します。各実行のステータス、モード(live または test)、副作用、トリガー、開始した人、時刻、ステップ数、待機中のノード、エラーを表示します。workflowId が必要です。
- get: 実行を取得します。実行のステータスと、各ノードの入力、出力、メモ、エラーを含むすべてのステップを順に表示します。実行は非同期です。Delay を含む実行は、続きの予定時刻まで待機します。workflowId、executionId が必要です。
パラメーター
| 名前 | 種類 | 説明 |
|---|---|---|
action* | "list" | "get" | 実行する操作です。各操作はツールの説明に記載されています。 |
workflowId | string | workflow_definitions_read の list から取得したワークフロー ID |
limit | integer | 1 ページあたりのアイテム数(既定は 25、最大 100)(list) |
cursor | string | 前のページの nextCursor(list) |
facilityId | string | 施設 ID。接続中の施設が対象の場合は省略できます。 |
executionId | string | workflow_runs_read の list から取得した実行 ID(get) |
workflow_runs_writeワークフローワークフローの実行を開始、テスト実行、キャンセル、再実行します。副作用をシミュレーションして下書きを実行する test を優先してください。run は公開済みのワークフローを実際に実行します。実行は非同期です。workflow_runs_read の get で追跡してください。
アクション:
- run: 今すぐ実行します。公開済みのワークフローを手動トリガー(custom.manualTrigger)から実行し、実際の副作用が発生します。スケジュール、Webhook、イベントのトリガーは自動的に発火します。実行の executionId と最初のステータスを返します。workflowId が必要です。確認を求めます。
- test: 下書きをテストします。保存済みの下書きを公開せずに実行し、テスト実行として記録します。既定では副作用はシミュレーションされます: 何も送信や切り替えは行われず、各ノードが実行したはずの内容を報告します。sideEffects live の場合は事前に確認します。workflowId が必要です。確認を求める場合があります。
- cancel: 待機中の実行をキャンセルします。Delay で待機中の実行をキャンセルします。保留中の待機は終了し、その後のステップは実行されません。完了した実行とステップの途中の実行はキャンセルできません。workflowId、executionId が必要です。確認を求めます。
- retry: 実行を再実行します。完了した実行を記録済みのトリガー入力から再実行し、retryOf で元の実行に紐付けます。published(既定)は使用したバージョンを実際に再実行し、事前に確認します。draft-test は現在の下書きをシミュレーションで実行し、失敗を修正している間に適した選択肢です。workflowId、executionId が必要です。確認を求める場合があります。
パラメーター
| 名前 | 種類 | 説明 |
|---|---|---|
action* | "run" | "test" | "cancel" | "retry" | 実行する操作です。各操作はツールの説明に記載されています。 |
workflowId | string | workflow_definitions_read の list から取得したワークフロー ID |
nodeId | string | 開始するトリガーノードの ID。手動トリガーの場合は省略します(run、test) |
payload | object | トリガーの後のノードへの入力。例: { "visitorName": "Ada" }(run、test) |
facilityId | string | 施設 ID。接続中の施設が対象の場合は省略できます。 |
sideEffects | "simulate" | "live" | ノードのアクションを実際に実行するかどうか(test) |
executionId | string | workflow_runs_read の list から取得した実行 ID(cancel、retry) |
mode | "published" | "draft-test" | 再実行の対象(retry) |
confirm | boolean | 最初の呼び出しで返されたプレビューをユーザーが確認した後にのみ設定します |