ソースのアイテムをインポート
オンラインドキュメントのページまたはオンラインドライブのファイルをコネクタソースにインポートし、実行を返します。state が completed、failed、canceled のいずれかになるまで、その id で ソースの実行を取得 をポーリングしてください。
指定したアイテムで、ソースのドキュメントが置き換えられます。インポートが完了すると、items に含まれないアイテムに対応するソースのドキュメントは削除されます。ソースに残したいアイテムはすべて送信してください。
ソースで最初のインポートが完了した後は、そのインポートに含まれていたアイテムしか指定できません。新しいアイテムを指定すると、実行は SOURCE_OPERATION_FAILED で失敗し、再試行しても解決しません。新しいアイテムは Dify でソースに追加してください。
ソースは connector ソースで、kind がその metadata.providerKind と一致している必要があります。1 つのソースで同時に実行できる同期、プレビュー、インポートは 1 つだけなので、先にアクティブな実行が終わるのを待ってください。
閲覧とインポートの流れについては、オンラインドキュメントとドライブファイルのインポート を参照してください。
curl --request POST \
--url https://{api_base_url}/knowledge-fs/spaces/{knowledge_base_id}/sources/{source_id}/workflow-imports \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Idempotency-Key: <idempotency-key>' \
--data '
{
"items": [
{
"lastEditedTime": "2026-09-01T12:00:00.000Z",
"name": "Onboarding",
"pageId": "3f9a1c2b-7d4e-4f5a-8b6c-9d0e1f2a3b4c",
"providerItemId": "[\"ws_01HZYQ8K3M\",\"3f9a1c2b-7d4e-4f5a-8b6c-9d0e1f2a3b4c\"]",
"type": "page",
"workspaceId": "ws_01HZYQ8K3M"
},
{
"lastEditedTime": "2026-08-20T09:30:00.000Z",
"name": "Runbooks",
"pageId": "5c1b2d3e-8f4a-4b6c-9d7e-0f1a2b3c4d5e",
"providerItemId": "[\"ws_01HZYQ8K3M\",\"5c1b2d3e-8f4a-4b6c-9d7e-0f1a2b3c4d5e\"]",
"type": "database",
"workspaceId": "ws_01HZYQ8K3M"
}
],
"kind": "online-document-import"
}
'{
"canceled_at": null,
"checkpoint": "queued",
"completed_at": null,
"created_at": "2026-10-20T10:00:00Z",
"cursor": null,
"execution_attempts": 0,
"failure": null,
"id": "e1f2a3b4-c5d6-4e7f-8a9b-0c1d2e3f4a5b",
"kind": "online-document-import",
"knowledge_space_id": "0a9d3c2e-5b6f-4e1a-8c7d-2f3e4a5b6c7d",
"last_error_code": null,
"max_execution_attempts": 5,
"progress_completed": 0,
"progress_failed": 0,
"progress_skipped": 0,
"progress_total": 2,
"source_id": "6f1c2b0e-3d0b-4a5e-9f4c-1c0e6a7b8d90",
"state": "queued",
"updated_at": "2026-10-20T10:00:00Z"
}Authorizations
すべてのリクエストは、Authorization: Bearer {API_KEY} ヘッダーに指定した API キーで認証します。アプリのエンドポイントにはアプリの API キーを、ナレッジのエンドポイントにはナレッジベースの API キーを使用します(Dify API クイックスタート)。
キーはサーバーサイドで保管し、クライアントコードには決して埋め込まないでください。キーがない、または無効な場合は HTTP 401(unauthorized)が返ります。
Headers
Body
正規化後のリクエストは、UTF-8 で 4,194,304 バイト以内に収める必要があります。リクエストサイズの制限 を参照してください。
- オンラインドキュメントのページ
- オンラインドライブのファイル
Response
kind は送信した値のまま、state: queued で、progress_total にアイテム数が設定された実行です。
実行が到達した最後のステップで、queued、provider-read、preview-staged、selection-frozen、materialized、cleanup-staging、source-committed のいずれかです。ソースの実行を再試行 は、チェックポイントにかかわらず実行を最初からやり直します。
ワーカーが実行を取得した回数です。ソースの実行を再試行 の後の取得も含み、再試行してもリセットされません。
実行 ID です。ソースの実行を取得、ソースの実行をキャンセル、ソースの実行を再試行 に渡します。
実行の処理内容です:
sync:ソースを同期、ソースを更新、スケジュール、または Dify によって開始されます。crawl-preview:ウェブサイトのクロールをプレビュー によって開始されます。選択したページをインポート がこの実行からインポートしている間も、種類は変わりません。crawl-import:ウェブサイトのページをインポート によって開始されます。online-document-import、online-drive-import:ソースのアイテムをインポート によって開始されます。
Dify でソースを追加または編集した場合も、Dify がプレビューとインポートを開始します。
execution_attempts の上限です。上限に達すると、ソースの実行を再試行 は 409 を返します。
実行が処理する予定のアイテム数です。インポートではリクエストされたページまたはアイテム、クロールプレビューではこれまでに一時保存されたページ、同期では一覧の取得後のソースのアイテムを数えます。判明するまでは null です。
ウェブサイトのページをインポート の実行が URL をクロールしている間は、progress_completed と progress_total のどちらも、それまでにクロールしたページ数を数えます。すべての URL のクロールが終わると、URL の数を総数として 0 から数え直します。
実行の進行状況です。
進行中の状態:
queued:ワーカー待ちcrawling:クロールプレビューによるページの取得中preview_ready:クロールプレビューが 選択したページをインポート または ソースの実行をキャンセル を待機中importing:アイテムのインポートとインデックス処理中syncing:ソースのドキュメントを更新中
最終状態:
completed:すべてのアイテムのインポートまたは更新、インデックス処理、アクティブ化が完了zero_results:クロールプレビューで見つかったページが 0 件failed:failureを参照canceled
failed または canceled の後は、ソースの実行を再試行 で再実行でき、ソースを同期 で新しい同期を開始できます。
Was this page helpful?
curl --request POST \
--url https://{api_base_url}/knowledge-fs/spaces/{knowledge_base_id}/sources/{source_id}/workflow-imports \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Idempotency-Key: <idempotency-key>' \
--data '
{
"items": [
{
"lastEditedTime": "2026-09-01T12:00:00.000Z",
"name": "Onboarding",
"pageId": "3f9a1c2b-7d4e-4f5a-8b6c-9d0e1f2a3b4c",
"providerItemId": "[\"ws_01HZYQ8K3M\",\"3f9a1c2b-7d4e-4f5a-8b6c-9d0e1f2a3b4c\"]",
"type": "page",
"workspaceId": "ws_01HZYQ8K3M"
},
{
"lastEditedTime": "2026-08-20T09:30:00.000Z",
"name": "Runbooks",
"pageId": "5c1b2d3e-8f4a-4b6c-9d7e-0f1a2b3c4d5e",
"providerItemId": "[\"ws_01HZYQ8K3M\",\"5c1b2d3e-8f4a-4b6c-9d7e-0f1a2b3c4d5e\"]",
"type": "database",
"workspaceId": "ws_01HZYQ8K3M"
}
],
"kind": "online-document-import"
}
'{
"canceled_at": null,
"checkpoint": "queued",
"completed_at": null,
"created_at": "2026-10-20T10:00:00Z",
"cursor": null,
"execution_attempts": 0,
"failure": null,
"id": "e1f2a3b4-c5d6-4e7f-8a9b-0c1d2e3f4a5b",
"kind": "online-document-import",
"knowledge_space_id": "0a9d3c2e-5b6f-4e1a-8c7d-2f3e4a5b6c7d",
"last_error_code": null,
"max_execution_attempts": 5,
"progress_completed": 0,
"progress_failed": 0,
"progress_skipped": 0,
"progress_total": 2,
"source_id": "6f1c2b0e-3d0b-4a5e-9f4c-1c0e6a7b8d90",
"state": "queued",
"updated_at": "2026-10-20T10:00:00Z"
}