Skip to main content
post/datasets/{dataset_id}/pipeline/run
Request example
Response
post/datasets/{dataset_id}/pipeline/run

Authorization

Authorizationstringheaderrequired#

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

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

Path parameters

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

Body

application/json
datasource_info_listobject[]required#
処理対象のデータソースオブジェクトのリストです。項目の構造は datasource_type によって異なります。
datasource_typeenum<string>required#
データソースのタイプ。datasource_info_list の各項目に必要なフィールドを決定します。
Options:local_fileonline_documentwebsite_crawlonline_drive
inputsobjectrequired#
パイプライン入力変数のキーと値のペア。ワークフローで定義されたパイプライン変数に対応します。入力変数がない場合は {} を渡してください。
is_publishedbooleanrequired#
現在のドラフトではなくパイプラインの公開バージョンを実行するかどうかを指定します。未公開の変更をテストするにはドラフトを実行します。
response_modeenum<string>required#
パイプライン実行のレスポンスモードです。streaming は Server-Sent Events ストリームを返し、blocking は完了まで待機して完全な結果を返します。
Options:streamingblocking
start_node_idstringrequired#
実行を開始するノードの ID です。データソースプラグインリストを取得 から取得します。

Responses

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