Skip to main content
post/knowledge-fs/spaces/{knowledge_base_id}/sources/{source_id}/workflow-imports
Request example
Response
post/knowledge-fs/spaces/{knowledge_base_id}/sources/{source_id}/workflow-imports

Authorization

Authorizationstringheaderrequired#

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

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

Path parameters

knowledge_base_idstringrequired#
ナレッジベース ID です。ナレッジベースの API アクセス ダイアログに表示されるサービス API エンドポイントの最後のセグメント(…/knowledge-fs/spaces/<knowledge base ID>)です。アドレスバーでは /datasets/new/ の後のセグメントです。
source_idstringrequired#
ソース ID です。ソース一覧を取得 から取得します。

Headers

Idempotency-Keystringrequired#
同じ API キーと冪等キーで同一のリクエストを再送信すると、元の実行が現在の状態で返されます。開始するインポートごとに新しいキーを使用してください。このソースと kind で同じキーを異なる items とともに再利用すると、409 が返ります。前後に空白を含まない、印字可能な ASCII 文字を使用してください。

Length: 8–255

Body

application/json

Responses

application/json
kind は送信した値のまま、state: queued で、progress_total にアイテム数が設定された実行です。
canceled_atstring#
実行がキャンセルされた日時です。state が canceled でない場合は null です。
checkpointstring#
実行が到達した最後のステップで、queued、provider-read、preview-staged、selection-frozen、materialized、cleanup-staging、source-committed のいずれかです。ソースの実行を再試行 は、チェックポイントにかかわらず実行を最初からやり直します。
completed_atstring#
実行が completed、zero_results、failed、canceled のいずれかで終了した日時(ISO 8601)です。実行中は null です。
created_atstring#
作成日時(ISO 8601)です。
cursorstring#
実行の再開位置となるプロバイダーのカーソルです。実行がページ送りをしていない場合は null です。
execution_attemptsinteger#
ワーカーが実行を取得した回数です。ソースの実行を再試行 の後の取得も含み、再試行してもリセットされません。
failureobject#
state が failed の場合のエラー詳細です。stage は失敗時点の実行の checkpoint、traceId は実行 ID です。それ以外の場合は null です。
kindstring#

実行の処理内容です:

Dify でソースを追加または編集した場合も、Dify がプレビューとインポートを開始します。

knowledge_space_idstring#
ナレッジベースの内部 ID です。パスのナレッジベース ID とは異なります。
last_error_codestring#
state が failed の場合は failure.code の値です。それ以外の場合は null です。
max_execution_attemptsinteger#
execution_attempts の上限です。上限に達すると、ソースの実行を再試行 は 409 を返します。
progress_completedinteger#
完了したアイテム数です。同期で確認された未変更のアイテムも含みます。
progress_failedinteger#
ソースの実行では常に 0 です。1 つのアイテムが失敗すると、実行全体が失敗するためです。
progress_skippedinteger#
ソースの実行では常に 0 です。
progress_totalinteger#

実行が処理する予定のアイテム数です。インポートではリクエストされたページまたはアイテム、クロールプレビューではこれまでに一時保存されたページ、同期では一覧の取得後のソースのアイテムを数えます。判明するまでは null です。

ウェブサイトのページをインポート の実行が URL をクロールしている間は、progress_completed と progress_total のどちらも、それまでにクロールしたページ数を数えます。すべての URL のクロールが終わると、URL の数を総数として 0 から数え直します。

source_idstring#
実行が属するソースです。
statestring#

実行の進行状況です。

進行中の状態:

最終状態:

  • completed:すべてのアイテムのインポートまたは更新、インデックス処理、アクティブ化が完了
  • zero_results:クロールプレビューで見つかったページが 0 件
  • failed:failure を参照
  • canceled

failed または canceled の後は、ソースの実行を再試行 で再実行でき、ソースを同期 で新しい同期を開始できます。

updated_atstring#
最終更新日時(ISO 8601)です。