Skip to main content
get/workflows/run/{workflow_run_id}
Request example
Response
get/workflows/run/{workflow_run_id}

Authorization

Authorizationstringheaderrequired#

すべてのリクエストは API キーで認証します:Authorization: Bearer {API_KEY}。アプリのエンドポイントにはアプリの API キーを、ナレッジのエンドポイントにはナレッジベースの API キーを使用します(Dify API クイックスタート)。

キーはサーバーサイドで保管し、クライアントコードには決して埋め込まないでください。キーが欠落または無効なリクエストは HTTP 401(unauthorized)で失敗します。

Path parameters

workflow_run_idstringrequired#
ワークフロー実行 ID です。ワークフローを実行 のレスポンスまたはストリーミングイベント、あるいは Chatflow アプリのメッセージメタデータから取得します。

Responses

application/json
ワークフロー実行の詳細の取得に成功しました。
created_atinteger#
ワークフロー実行が作成された Unix タイムスタンプです。
elapsed_timenumber#
合計経過時間(秒)です。
errorstring#
ワークフローが失敗した場合のエラーメッセージです。
finished_atinteger#
ワークフロー実行が完了した Unix タイムスタンプです。
idstring#
ワークフロー実行 ID です。
inputsstring#
ワークフロー実行の入力変数です。生の JSON 文字列として返されるため(例:{"query": "..."})、クライアント側でパースする必要があります。null の場合もあります。
outputsobject#
ワークフローからの出力データです。出力がまだない場合は空のオブジェクトです。
statusstring#
ワークフローの実行ステータスです。running は実行中、succeeded は正常完了、failed は実行エラー、stopped は手動停止、partial-succeeded は一部のノードが成功し他が失敗、paused は人間の入力待ちを示します。
total_stepsinteger#
実行されたワークフローの合計ステップ数です。
total_tokensinteger#
消費された合計トークン数です。
workflow_idstring#
Workflow ID.