ソースの同期とインポート

ソースの実行を再試行

failed または canceled のソースの実行を、同じ実行 ID のまま最初からやり直し、キューに入った状態で返します。進捗はリセットされるため、インポートはすべてのアイテムを再取得し、同期は最初からやり直します。すでにページが選択されているクロールプレビューは、クロールし直さずにそのページを再度インポートします。

キャンセルされたクロールプレビューや、失敗したウェブサイトのページをインポートの実行は、再試行でやり直さないでください。新しい Idempotency-Key で、新しいプレビューまたはインポートを開始します。

リクエストボディはありません。

実行の追跡、再試行、キャンセルの方法については、ソースの実行の追跡を参照してください。

POST

knowledge-fs

spaces

{knowledge_base_id}

source-workflows

{run_id}

retry

ソースの実行を再試行

curl --request POST \
  --url https://{api_base_url}/knowledge-fs/spaces/{knowledge_base_id}/source-workflows/{run_id}/retry \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://{api_base_url}/knowledge-fs/spaces/{knowledge_base_id}/source-workflows/{run_id}/retry"

headers = {"Authorization": "Bearer <token>"}

response = requests.post(url, headers=headers)

print(response.text)

const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

fetch('https://{api_base_url}/knowledge-fs/spaces/{knowledge_base_id}/source-workflows/{run_id}/retry', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{api_base_url}/knowledge-fs/spaces/{knowledge_base_id}/source-workflows/{run_id}/retry",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://{api_base_url}/knowledge-fs/spaces/{knowledge_base_id}/source-workflows/{run_id}/retry"

	req, _ := http.NewRequest("POST", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://{api_base_url}/knowledge-fs/spaces/{knowledge_base_id}/source-workflows/{run_id}/retry")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{api_base_url}/knowledge-fs/spaces/{knowledge_base_id}/source-workflows/{run_id}/retry")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "canceled_at": null,
  "checkpoint": "provider-read",
  "completed_at": null,
  "created_at": "2026-10-20T10:00:00Z",
  "cursor": null,
  "execution_attempts": 1,
  "failure": null,
  "id": "e1f2a3b4-c5d6-4e7f-8a9b-0c1d2e3f4a5b",
  "kind": "sync",
  "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": 45,
  "source_id": "6f1c2b0e-3d0b-4a5e-9f4c-1c0e6a7b8d90",
  "state": "queued",
  "updated_at": "2026-10-20T11:00:00Z"
}

Authorizations

Authorization

string

header

required

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

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

Path Parameters

knowledge_base_id

string<uuid>

required

ナレッジベース ID です。ナレッジベースの API アクセスダイアログに表示されるサービス API エンドポイントの最後のセグメント（…/knowledge-fs/spaces/<knowledge base ID>）です。アドレスバーでは /datasets/new/ の後のセグメントです。

run_id

string<uuid>

required

実行 ID です。実行を開始したレスポンス、またはソースの実行一覧を取得の id から取得します。

Response

最初からやり直すために、再びキューに入った実行です。

canceled_at

string | null

実行がキャンセルされた日時です。state が canceled でない場合は null です。

checkpoint

string

実行が到達した最後のステップで、queued、provider-read、preview-staged、selection-frozen、materialized、cleanup-staging、source-committed のいずれかです。ソースの実行を再試行は、チェックポイントにかかわらず実行を最初からやり直します。

completed_at

string | null

実行が completed、zero_results、failed、canceled のいずれかで終了した日時（ISO 8601）です。実行中は null です。

created_at

string

作成日時（ISO 8601）です。

cursor

string | null

実行の再開位置となるプロバイダーのカーソルです。実行がページ送りをしていない場合は null です。

execution_attempts

integer

ワーカーが実行を取得した回数です。ソースの実行を再試行の後の取得も含み、再試行してもリセットされません。

failure

object | null

state が failed の場合のエラー詳細です。stage は失敗時点の実行の checkpoint、traceId は実行 ID です。それ以外の場合は null です。

Show child attributes

string

実行 ID です。ソースの実行を取得、ソースの実行をキャンセル、ソースの実行を再試行に渡します。

kind

string

実行の処理内容です：

sync：ソースを同期、ソースを更新、スケジュール、または Dify によって開始されます。
crawl-preview：ウェブサイトのクロールをプレビューによって開始されます。選択したページをインポートがこの実行からインポートしている間も、種類は変わりません。
crawl-import：ウェブサイトのページをインポートによって開始されます。
online-document-import、online-drive-import：ソースのアイテムをインポートによって開始されます。

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

knowledge_space_id

string

ナレッジベースの内部 ID です。パスのナレッジベース ID とは異なります。

last_error_code

string | null

state が failed の場合は failure.code の値です。それ以外の場合は null です。

max_execution_attempts

integer

execution_attempts の上限です。上限に達すると、ソースの実行を再試行は 409 を返します。

progress_completed

integer

完了したアイテム数です。同期で確認された未変更のアイテムも含みます。

progress_failed

integer

ソースの実行では常に 0 です。1 つのアイテムが失敗すると、実行全体が失敗するためです。

progress_skipped

integer

ソースの実行では常に 0 です。

progress_total

integer | null

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

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

source_id

string | null

実行が属するソースです。

state

string

実行の進行状況です。

進行中の状態：

queued：ワーカー待ち
crawling：クロールプレビューによるページの取得中
preview_ready：クロールプレビューが選択したページをインポートまたはソースの実行をキャンセルを待機中
importing：アイテムのインポートとインデックス処理中
syncing：ソースのドキュメントを更新中

最終状態：

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

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

updated_at

string

最終更新日時（ISO 8601）です。

ソースの実行を再試行

curl --request POST \
  --url https://{api_base_url}/knowledge-fs/spaces/{knowledge_base_id}/source-workflows/{run_id}/retry \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://{api_base_url}/knowledge-fs/spaces/{knowledge_base_id}/source-workflows/{run_id}/retry"

headers = {"Authorization": "Bearer <token>"}

response = requests.post(url, headers=headers)

print(response.text)

const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

fetch('https://{api_base_url}/knowledge-fs/spaces/{knowledge_base_id}/source-workflows/{run_id}/retry', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{api_base_url}/knowledge-fs/spaces/{knowledge_base_id}/source-workflows/{run_id}/retry",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://{api_base_url}/knowledge-fs/spaces/{knowledge_base_id}/source-workflows/{run_id}/retry"

	req, _ := http.NewRequest("POST", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://{api_base_url}/knowledge-fs/spaces/{knowledge_base_id}/source-workflows/{run_id}/retry")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{api_base_url}/knowledge-fs/spaces/{knowledge_base_id}/source-workflows/{run_id}/retry")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "canceled_at": null,
  "checkpoint": "provider-read",
  "completed_at": null,
  "created_at": "2026-10-20T10:00:00Z",
  "cursor": null,
  "execution_attempts": 1,
  "failure": null,
  "id": "e1f2a3b4-c5d6-4e7f-8a9b-0c1d2e3f4a5b",
  "kind": "sync",
  "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": 45,
  "source_id": "6f1c2b0e-3d0b-4a5e-9f4c-1c0e6a7b8d90",
  "state": "queued",
  "updated_at": "2026-10-20T11:00:00Z"
}

ガイド

アプリ API

ナレッジ API

ソースの実行を再試行

Authorizations

Path Parameters

Response