メインコンテンツへスキップ
POST

承認

Authorization
string
header
必須

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

キーはサーバーサイドで保管し、クライアントコードには決して埋め込まないでください。キーがない、または無効な場合は HTTP 401（unauthorized）が返ります。

パスパラメータ

dataset_id
string<uuid>
必須

ナレッジベース ID。ナレッジベースリストを取得 で取得します。スコープを限定したキーでは、Dify の URL から ID をコピー してください。

ボディ

application/json
inputs
object
必須

パイプライン入力変数のキーと値のペア。ワークフローで定義されたパイプライン変数に対応します。入力変数がない場合は {} を渡してください。

datasource_type
enum<string>
必須

データソースのタイプ。datasource_info_list の各項目に必要なフィールドを決定します。

利用可能なオプション:
local_file,
online_document,
website_crawl,
online_drive
datasource_info_list
(ローカルファイル · object | オンラインドキュメント · object | ウェブサイトクロール · object | オンラインドライブ · object)[]
必須

処理対象のデータソースオブジェクトのリストです。項目の構造は datasource_type によって異なります。

start_node_id
string
必須

実行を開始するノードの ID です。データソースプラグインリストを取得 から取得します。

is_published
boolean
必須

現在のドラフトではなくパイプラインの公開バージョンを実行するかどうかを指定します。未公開の変更をテストするにはドラフトを実行します。

response_mode
enum<string>
必須

パイプライン実行のレスポンスモードです。streaming は Server-Sent Events ストリームを返し、blocking は完了まで待機して完全な結果を返します。

利用可能なオプション:
streaming,
blocking

レスポンス

パイプライン実行結果。フォーマットは response_mode に依存します：ストリーミングは text/event-stream を返し、ブロッキングは完全な JSON 結果を返します。

Server-Sent Events ストリームです。response_mode が streaming の場合に返されます。ワイヤーフォーマットについては ストリーミングレスポンスの処理 を参照してください。

主なイベント：

  • workflow_started：実行開始
  • node_started / node_finished：ノードごとの進捗（node_id、node_type、status、inputs、outputs を含む）
  • workflow_finished：最終結果（status、outputs、total_tokens、elapsed_time を含む）
  • ping：キープアライブ