メインコンテンツへスキップ
POST
/
datasets
/
{dataset_id}
/
pipeline
/
run
curl --request POST \
  --url https://{api_base_url}/datasets/{dataset_id}/pipeline/run \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "inputs": {},
  "datasource_type": "local_file",
  "datasource_info_list": [
    {
      "reference": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "name": "quarterly-report.pdf"
    }
  ],
  "start_node_id": "1719288585006",
  "is_published": true,
  "response_mode": "blocking"
}
'
"<string>"

承認

​
Authorization
string
header
必須

API Key 認証です。すべての API リクエストにおいて、Authorization HTTP ヘッダーに Bearer プレフィックスを付けた API Key を含めてください。例：Authorization: Bearer {API_KEY}。API Key はサーバーサイドに保存し、クライアントサイドで共有・保存しないことを強く推奨します。API Key の漏洩は深刻な結果につながる可能性があります。

パスパラメータ

​
dataset_id
string<uuid>
必須

ナレッジベース ID です。

ボディ

application/json
​
inputs
object
必須

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

​
datasource_type
enum<string>
必須

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

利用可能なオプション:
local_file,
online_document,
website_crawl,
online_drive
​
datasource_info_list
(Local File · object | Online Document · object | Website Crawl · object | Online Drive · object)[]
必須

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

​
start_node_id
string
必須

パイプライン実行を開始するノードの ID です。

​
is_published
boolean
必須

パイプラインの公開版またはドラフト版のどちらを実行するかを指定します。true は最新の公開版を実行し、false は現在のドラフトを実行します（未公開の変更をテストする場合に便利です）。

​
response_mode
enum<string>
必須

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

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

レスポンス

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

Server-Sent Events ストリームです。各行は data: {JSON}\n\n 形式です。主要なイベント：workflow_started（実行開始）、node_started / node_finished（ノードごとの進捗、node_id、node_type、status、inputs、outputs を含む）、workflow_finished（最終結果、status、outputs、total_tokens、elapsed_time を含む）、ping（キープアライブ）。