> ## Documentation Index > Fetch the complete documentation index at: https://docs.dify.ai/llms.txt > Use this file to discover all available pages before exploring further. # ウェブサイトのページをインポート > 既知の URL をウェブサイトソースにインポートし、実行を返します。`state` が `completed`、`failed`、`canceled` のいずれかになるまで、その `id` で [ソースの実行を取得](/ja/api-reference/source-syncs-and-imports/get-source-run) をポーリングしてください。 各 URL は個別にクロールされ、すべての URL のクロールが終わるとインポートが始まります。ページを返さない URL があると、ページがインポートされる前に実行が失敗し、ソースのドキュメントは変更されません。 実行が完了すると、`sourceUrls` がソースのページリストになります。インポートのたびにリスト全体が設定されるため、ソースに残したい URL はすべて送信してください。 ソースは `web` ソースである必要があります。1 つのソースで同時に実行できる同期、プレビュー、インポートは 1 つだけです。別の実行を開始する前に、アクティブな実行が終わるのを待ってください。インポートしないクロールプレビューはキャンセルしてください。 ウェブサイトのページをインポートする 2 つの方法については、[ウェブサイトのページのインポート](/ja/api-reference/guides/knowledge-base#import-website-pages) を参照してください。 ## OpenAPI ````yaml /ja/api-reference/openapi_service.json post /knowledge-fs/spaces/{knowledge_base_id}/sources/{source_id}/crawl-import openapi: 3.0.1 info: description: >- Dify アプリケーションとナレッジベースのための REST API です。アプリケーション系エンドポイントはアプリの API キーで、ナレッジ系エンドポイントはナレッジベースの API キーで認証します。 title: Dify サービス API version: 1.0.0 servers: - description: Dify サービス API のベース URL です。セルフホスト環境では、独自の API ベース URL に置き換えてください。 url: https://{api_base_url} variables: api_base_url: default: api.dify.ai/v1 description: API ベース URL のホストとパス（`https://` を除く）。 security: - ApiKeyAuth: [] tags: - description: チャットメッセージとインタラクションに関連する操作です。 name: チャットメッセージ - description: ファイルのアップロードとプレビューの操作です。 name: ファイル操作 - description: エンドユーザー情報に関連する操作です。 name: エンドユーザー - description: ユーザーフィードバックの操作です。 name: メッセージフィードバック - description: 会話管理に関連する操作です。 name: 会話管理 - description: テキスト読み上げと音声認識の操作です。 name: 音声・テキスト変換 - description: アプリケーション設定と情報を取得する操作です。 name: アプリケーション設定 - description: ダイレクト返信用のアノテーション管理に関連する操作です。 name: アノテーション管理 - description: 人間の入力を要する一時停止中のワークフローの再開操作です。 name: 人間の入力 - description: ワークフローの実行と管理のための操作です。 name: ワークフロー実行 - description: テキスト生成に関連する操作です。 name: 完了メッセージ - description: ナレッジベースの作成、設定、取得を含むナレッジベース管理の操作です。 name: ナレッジベース - description: ナレッジベース内のドキュメントの作成、更新、管理のための操作です。 name: ドキュメント - description: ドキュメントチャンクと子チャンクの管理のための操作です。 name: チャンク - description: ナレッジベースのメタデータフィールドとドキュメントメタデータ値の管理のための操作です。 name: メタデータ - description: ナレッジベースタグとタグバインディングの管理のための操作です。 name: タグ管理 - description: 利用可能なモデルを取得するための操作です。 name: モデル - description: データソースプラグインとパイプライン実行を含むナレッジパイプラインの管理と実行のための操作です。 name: ナレッジパイプライン - description: ナレッジベースに質問し、回答をストリーミングで受け取ります。 name: クエリ - description: クエリが何を検索したか、またその理由を確認します。 name: クエリ記録 - description: リサーチの質問をバックグラウンドで実行し、その結果を取得します。 name: リサーチタスク - description: ナレッジベースのドキュメントと、そのファイル、リビジョン、チャンクを読み取り、ドキュメントにメタデータのラベルを付けます。 name: ドキュメントとチャンク - description: インデックス処理の追跡、キャンセル、再試行と、ナレッジベースのバックグラウンドタスクの一覧表示を行います。 name: インデックスタスク - description: ドキュメントファイル、ファイルのバッチ、またはソースの削除を、完了するまで追跡します。 name: 削除ジョブ - description: ナレッジベースにデータを供給するソース、その同期スケジュール、接続を管理します。 name: ソース - description: ソースの即時同期、ウェブサイトのページまたはプロバイダーのアイテムのインポート、実行の追跡、キャンセル、再試行を行います。 name: ソースの同期とインポート - description: ナレッジベースのモデルと検索設定の読み取りと変更、および変更によって始まる移行の追跡を行います。 name: 設定 paths: /knowledge-fs/spaces/{knowledge_base_id}/sources/{source_id}/crawl-import: post: tags: - Source Syncs and Imports summary: ウェブサイトのページをインポート description: >- 既知の URL をウェブサイトソースにインポートし、実行を返します。`state` が `completed`、`failed`、`canceled` のいずれかになるまで、その `id` で [ソースの実行を取得](/ja/api-reference/source-syncs-and-imports/get-source-run) をポーリングしてください。 各 URL は個別にクロールされ、すべての URL のクロールが終わるとインポートが始まります。ページを返さない URL があると、ページがインポートされる前に実行が失敗し、ソースのドキュメントは変更されません。 実行が完了すると、`sourceUrls` がソースのページリストになります。インポートのたびにリスト全体が設定されるため、ソースに残したい URL はすべて送信してください。 ソースは `web` ソースである必要があります。1 つのソースで同時に実行できる同期、プレビュー、インポートは 1 つだけです。別の実行を開始する前に、アクティブな実行が終わるのを待ってください。インポートしないクロールプレビューはキャンセルしてください。 ウェブサイトのページをインポートする 2 つの方法については、[ウェブサイトのページのインポート](/ja/api-reference/guides/knowledge-base#import-website-pages) を参照してください。 operationId: importWebsitePages parameters: - description: >- ナレッジベース ID です。ナレッジベースの **API アクセス** ダイアログに表示されるサービス API エンドポイントの最後のセグメント（`…/knowledge-fs/spaces/`）です。アドレスバーでは `/datasets/new/` の後のセグメントです。 in: path name: knowledge_base_id required: true schema: format: uuid type: string - description: >- ソース ID です。[ソース一覧を取得](/ja/api-reference/sources/list-sources) から取得します。 in: path name: source_id required: true schema: format: uuid type: string - description: >- 同じ API キーで同じ冪等キーと同じリクエストを再送信すると、元の実行が現在の状態で返されます。開始するインポートごとに新しいキーを使用してください。このソースで同じキーを異なるボディとともに再利用すると、`409` が返ります。前後に空白を含まない、印字可能な ASCII 文字を使用してください。 in: header name: Idempotency-Key required: true schema: maxLength: 255 minLength: 8 type: string requestBody: content: application/json: examples: request: summary: リクエスト例 value: replaceExistingSelection: true sourceUrls: - https://docs.example.com/guides/billing - https://docs.example.com/pricing schema: properties: replaceExistingSelection: default: false description: >- `true` にすると、`sourceUrls` に含まれないページに対応するソースのドキュメントを、同じ実行で削除します。 type: boolean sourceUrls: description: インポートする URL です。同じ URL は 1 回だけ指定します。前後の空白は取り除かれます。 items: maxLength: 4096 minLength: 1 type: string maxItems: 200 minItems: 1 type: array required: - sourceUrls type: object description: >- 正規化後のリクエストは、UTF-8 で 1,048,576 バイト以内に収める必要があります。[リクエストサイズの制限](/ja/api-reference/guides/knowledge-base#request-size-limits) を参照してください。 required: true responses: '202': content: application/json: examples: success: summary: レスポンス例 value: 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: crawl-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' schema: $ref: '#/components/schemas/KnowledgeBaseSourceRun' description: >- `kind: crawl-import`、`state: queued` で、`progress_total` に URL の数が設定された実行です。 '400': content: application/json: examples: knowledge_fs_invalid_request_local: summary: knowledge_fs_invalid_request (request validation) value: code: knowledge_fs_invalid_request message: Agent Knowledge Base request is invalid. status: 400 violations: - field: - sourceUrls type: too_long knowledge_fs_invalid_request_path: summary: knowledge_fs_invalid_request (path ID) value: code: knowledge_fs_invalid_request message: Agent Knowledge Base request is invalid. status: 400 knowledge_fs_invalid_request_upstream: summary: knowledge_fs_invalid_request (rejected) value: code: knowledge_fs_invalid_request failure: category: validation code: KNOWLEDGE_FS_INVALID_REQUEST message: The Agent Knowledge Base request is invalid. retryPolicy: never traceId: 7f3c1a90-2e64-4b7d-8a51-6c0d9e2f4b83 message: The Agent Knowledge Base request is invalid. status: 400 description: >- - `knowledge_fs_invalid_request`：リクエストが検証に失敗しました。`violations` には、問題のあるフィールドがそれぞれ示されます。`sourceUrls` の欠落または空、200 件を超える URL、空または長すぎる URL、ボディの不明なキー、`Idempotency-Key` のルール違反がこれに該当します。 - `knowledge_fs_invalid_request`：ソースが `web` ソースではない、URL が有効な URL ではない、または `source_id` が UUID ではありません。 - `knowledge_fs_invalid_request`：`source_id` の形式が正しくありません。 '401': content: application/json: examples: knowledge_fs_invalid_credential: summary: knowledge_fs_invalid_credential value: code: knowledge_fs_invalid_credential message: Invalid Agent Knowledge Base service credential. status: 401 unauthorized: summary: unauthorized value: code: unauthorized message: Access token is invalid status: 401 description: >- - `unauthorized`：`Authorization` ヘッダーがないか、キーが不明であるか、ナレッジベースの API キーではありません。 - `knowledge_fs_invalid_credential`：キーは有効ですが、キーのワークスペースにこの ID のナレッジベースが存在しないか、キーがワークスペースに紐付いていません。 '403': content: application/json: examples: forbidden: summary: forbidden (rate limit) value: code: forbidden message: >- Sorry, you have reached the knowledge base request rate limit of your subscription. status: 403 knowledge_fs_access_denied_scope: summary: knowledge_fs_access_denied (key scope) value: code: knowledge_fs_access_denied message: Agent Knowledge Base operation is not allowed. status: 403 description: >- - `knowledge_fs_access_denied`：キーのアクセス範囲がほかのナレッジベースに限定されているか、このナレッジベースで **API アクセス** がオフになっています。または、ナレッジベースがアクティブではありません。 - `forbidden`：Dify Cloud で、ワークスペースがサブスクリプションで定められたナレッジベースのリクエストレート制限に達しました。読み取りを含め、すべての呼び出しがカウントされます。 '404': content: application/json: examples: knowledge_fs_resource_not_found: summary: knowledge_fs_resource_not_found value: code: knowledge_fs_resource_not_found failure: category: not_found code: KNOWLEDGE_FS_NOT_FOUND message: >- The requested Agent Knowledge Base resource was not found. retryPolicy: never traceId: 7f3c1a90-2e64-4b7d-8a51-6c0d9e2f4b83 message: The requested Agent Knowledge Base resource was not found. status: 404 not_found: summary: not_found (feature off) value: code: not_found message: >- The requested URL was not found on the server. If you entered the URL manually please check your spelling and try again. status: 404 description: >- - `knowledge_fs_resource_not_found`：この ID のソースがナレッジベースに存在しない、キーでそのソースを読み取れない、またはソースの削除がすでに受け付けられています。 - `not_found`：このデプロイ環境では Agent ナレッジベース機能が無効になっています。 '409': content: application/json: examples: knowledge_fs_conflict: summary: knowledge_fs_conflict value: code: knowledge_fs_conflict failure: action: retry category: conflict code: KNOWLEDGE_FS_CONFLICT message: >- The Agent Knowledge Base operation conflicts with the current resource state. retryPolicy: manual traceId: 7f3c1a90-2e64-4b7d-8a51-6c0d9e2f4b83 message: >- The Agent Knowledge Base operation conflicts with the current resource state. status: 409 description: >- - `knowledge_fs_conflict`：この API キーは、このソースで同じ `Idempotency-Key` を別のリクエストにすでに使用しています。 '413': content: application/json: examples: knowledge_fs_request_too_large: summary: knowledge_fs_request_too_large (request budget) value: code: knowledge_fs_request_too_large message: Agent Knowledge Base request is too large. status: 413 description: >- - `knowledge_fs_request_too_large`：Dify がデフォルト値を追加した後のリクエストが、UTF-8 で 1,048,576 バイトを超えています。[リクエストサイズの制限](/ja/api-reference/guides/knowledge-base#request-size-limits) を参照してください。 '502': content: application/json: examples: knowledge_fs_upstream_unavailable: summary: knowledge_fs_upstream_unavailable (service error) value: code: knowledge_fs_upstream_unavailable failure: action: contact_admin category: internal code: KNOWLEDGE_FS_INTERNAL_ERROR message: >- Agent Knowledge Base could not complete the operation. Try again, or contact an administrator with the error reference. retryPolicy: manual traceId: 5e2a9c17-3b4d-4f60-8a1b-2c3d4e5f6a7b message: >- Agent Knowledge Base could not complete the operation. Try again, or contact an administrator with the error reference. status: 502 knowledge_fs_upstream_unavailable_transport: summary: knowledge_fs_upstream_unavailable (no response) value: code: knowledge_fs_upstream_unavailable message: Agent Knowledge Base is unavailable. status: 502 description: >- - `knowledge_fs_upstream_unavailable`：時間内に応答が返らなかったか、応答を読み取れませんでした。 実行が開始されている可能性があります。同じ `Idempotency-Key` で同じリクエストを再送信してください。実行が開始されていた場合は、その実行が返されます。 '503': content: application/json: examples: knowledge_fs_operation_unavailable: summary: knowledge_fs_operation_unavailable value: code: knowledge_fs_operation_unavailable message: Agent Knowledge Base operation is not available. status: 503 knowledge_fs_operation_unavailable_upstream: summary: knowledge_fs_operation_unavailable (temporary) value: code: knowledge_fs_operation_unavailable failure: action: retry category: dependency code: KNOWLEDGE_FS_UNAVAILABLE message: >- A service required by Agent Knowledge Base is temporarily unavailable. retryPolicy: manual traceId: 5e2a9c17-3b4d-4f60-8a1b-2c3d4e5f6a7b message: >- A service required by Agent Knowledge Base is temporarily unavailable. status: 503 description: >- - `knowledge_fs_operation_unavailable`：このワークスペースで Agent ナレッジベース機能が設定されていないか、このデプロイ環境ではこの操作を利用できません。または、リクエストの認可中に、このナレッジベースに対するキーのアクセス権が変更されました。 - `knowledge_fs_operation_unavailable`：現在このリクエストを処理できません。`failure.retryPolicy` に従ってください。 components: schemas: KnowledgeBaseSourceRun: properties: canceled_at: description: 実行がキャンセルされた日時です。`state` が `canceled` でない場合は `null` です。 nullable: true type: string checkpoint: description: >- 実行が到達した最後のステップで、`queued`、`provider-read`、`preview-staged`、`selection-frozen`、`materialized`、`cleanup-staging`、`source-committed` のいずれかです。[ソースの実行を再試行](/ja/api-reference/source-syncs-and-imports/retry-source-run) は、チェックポイントにかかわらず実行を最初からやり直します。 type: string completed_at: description: >- 実行が `completed`、`zero_results`、`failed`、`canceled` のいずれかで終了した日時（ISO 8601）です。実行中は `null` です。 nullable: true type: string created_at: description: 作成日時（ISO 8601）です。 type: string cursor: description: 実行の再開位置となるプロバイダーのカーソルです。実行がページ送りをしていない場合は `null` です。 nullable: true type: string execution_attempts: description: >- ワーカーが実行を取得した回数です。[ソースの実行を再試行](/ja/api-reference/source-syncs-and-imports/retry-source-run) の後の取得も含み、再試行してもリセットされません。 type: integer failure: allOf: - $ref: '#/components/schemas/KnowledgeBaseErrorDetails' description: >- `state` が `failed` の場合のエラー詳細です。`stage` は失敗時点の実行の `checkpoint`、`traceId` は実行 ID です。それ以外の場合は `null` です。 nullable: true id: description: >- 実行 ID です。[ソースの実行を取得](/ja/api-reference/source-syncs-and-imports/get-source-run)、[ソースの実行をキャンセル](/ja/api-reference/source-syncs-and-imports/cancel-source-run)、[ソースの実行を再試行](/ja/api-reference/source-syncs-and-imports/retry-source-run) に渡します。 type: string kind: description: >- 実行の処理内容です： - `sync`：[ソースを同期](/ja/api-reference/source-syncs-and-imports/sync-source)、[ソースを更新](/ja/api-reference/sources/update-source)、スケジュール、または Dify によって開始されます。 - `crawl-preview`：[ウェブサイトのクロールをプレビュー](/ja/api-reference/source-syncs-and-imports/preview-website-crawl) によって開始されます。[選択したページをインポート](/ja/api-reference/source-syncs-and-imports/import-selected-pages) がこの実行からインポートしている間も、種類は変わりません。 - `crawl-import`：[ウェブサイトのページをインポート](/ja/api-reference/source-syncs-and-imports/import-website-pages) によって開始されます。 - `online-document-import`、`online-drive-import`：[ソースのアイテムをインポート](/ja/api-reference/source-syncs-and-imports/import-source-items) によって開始されます。 Dify でソースを追加または編集した場合も、Dify がプレビューとインポートを開始します。 type: string knowledge_space_id: description: ナレッジベースの内部 ID です。パスのナレッジベース ID とは異なります。 type: string last_error_code: description: '`state` が `failed` の場合は `failure.code` の値です。それ以外の場合は `null` です。' nullable: true type: string max_execution_attempts: description: >- `execution_attempts` の上限です。上限に達すると、[ソースの実行を再試行](/ja/api-reference/source-syncs-and-imports/retry-source-run) は `409` を返します。 type: integer progress_completed: description: 完了したアイテム数です。同期で確認された未変更のアイテムも含みます。 type: integer progress_failed: description: ソースの実行では常に `0` です。1 つのアイテムが失敗すると、実行全体が失敗するためです。 type: integer progress_skipped: description: ソースの実行では常に `0` です。 type: integer progress_total: description: >- 実行が処理する予定のアイテム数です。インポートではリクエストされたページまたはアイテム、クロールプレビューではこれまでに一時保存されたページ、同期では一覧の取得後のソースのアイテムを数えます。判明するまでは `null` です。 [ウェブサイトのページをインポート](/ja/api-reference/source-syncs-and-imports/import-website-pages) の実行が URL をクロールしている間は、`progress_completed` と `progress_total` のどちらも、それまでにクロールしたページ数を数えます。すべての URL のクロールが終わると、URL の数を総数として `0` から数え直します。 nullable: true type: integer source_id: description: 実行が属するソースです。 nullable: true type: string state: description: >- 実行の進行状況です。 進行中の状態： - `queued`：ワーカー待ち - `crawling`：クロールプレビューによるページの取得中 - `preview_ready`：クロールプレビューが [選択したページをインポート](/ja/api-reference/source-syncs-and-imports/import-selected-pages) または [ソースの実行をキャンセル](/ja/api-reference/source-syncs-and-imports/cancel-source-run) を待機中 - `importing`：アイテムのインポートとインデックス処理中 - `syncing`：ソースのドキュメントを更新中 最終状態： - `completed`：すべてのアイテムのインポートまたは更新、インデックス処理、アクティブ化が完了 - `zero_results`：クロールプレビューで見つかったページが 0 件 - `failed`：`failure` を参照 - `canceled` `failed` または `canceled` の後は、[ソースの実行を再試行](/ja/api-reference/source-syncs-and-imports/retry-source-run) で再実行でき、[ソースを同期](/ja/api-reference/source-syncs-and-imports/sync-source) で新しい同期を開始できます。 type: string updated_at: description: 最終更新日時（ISO 8601）です。 type: string type: object KnowledgeBaseErrorDetails: properties: action: description: >- 推奨される次の対応です。ある場合は `configure_model`、`configure_parser`、`configure_source`、`contact_admin`、`reupload`、`retry` のいずれかです。該当しない場合は `null` で、HTTP エラーのボディでは省略されます。 nullable: true type: string category: description: >- 失敗の種類で、`authorization`、`canceled`、`configuration`、`conflict`、`dependency`、`internal`、`not_found`、`rate_limit`、`timeout`、`validation` のいずれかです。 type: string code: description: >- 大文字のスネークケースで表される固定のエラーコードです（例：`KNOWLEDGE_FS_CONFLICT`、`SOURCE_CREDENTIAL_TEST_FAILED`）。 type: string message: description: エラーコードまたは失敗の種類に対応する公開用メッセージです。プロバイダーのエラー詳細は公開されません。 type: string parameters: additionalProperties: true description: >- 失敗の内容を補足する最大 8 個の値です。キーは `attempt`、`currentRowVersion`、`documentCount`、`expectedRowVersion`、`fileSizeBytes`、`limit`、`maxFileSizeBytes`、`maxItems`、`modelType`、`providerKind`、`retryAfterSeconds`、`status` のいずれかです。値がない場合は `null` で、HTTP エラーのボディでは省略されます。 nullable: true type: object retryPolicy: description: >- 再試行で解決できるかどうかです。`automatic`（サービスが自動で再試行）、`manual`（呼び出し側で再試行）、`after_configuration`（先に Dify でナレッジベースの設定を修正）、`never`（リクエストを変更）のいずれかです。 type: string stage: description: >- 失敗が発生した段階です（例：`query_generation`、`credential-test`）。該当しない場合は `null` で、HTTP エラーのボディでは省略されます。 nullable: true type: string traceId: description: >- 管理者に問い合わせる際に伝える参照情報です。失敗の詳細を含む成功レスポンスでは `null` になることがあり、HTTP エラーのボディでは省略されることがあります。 nullable: true type: string type: object securitySchemes: ApiKeyAuth: bearerFormat: API_KEY description: >- すべてのリクエストは API キーで認証します：`Authorization: Bearer {API_KEY}`。アプリのエンドポイントにはアプリの API キーを、ナレッジのエンドポイントにはナレッジベースの API キーを使用します（[Dify API クイックスタート](/ja/api-reference/guides/get-started)）。 キーはサーバーサイドで保管し、クライアントコードには決して埋め込まないでください。キーが欠落または無効なリクエストは HTTP `401`（`unauthorized`）で失敗します。 scheme: bearer type: http ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.