削除ジョブ

削除ジョブを取得

ドキュメントファイルを削除またはソースを削除で要求された削除、あるいはドキュメントファイルを一括削除内の 1 ファイルの削除について、進捗を返します。run_state が completed または failed になるまでポーリングしてください。

ジョブを読み取れるのは、削除を要求した API キーだけです。ジョブは削除の完了後も読み取れます。

削除が受け付けられた時点から、削除対象のオブジェクトに対してドキュメントファイルを取得またはソースを取得は 404 を返します。documents=keep を指定してソースを削除した場合、そのドキュメントはジョブの実行中は非表示になり、完了すると source_id が null に設定された状態で再び表示されます。ジョブが失敗した場合、ドキュメントは非表示のままです。

失敗した削除は、この API では再試行できません。

削除の流れについては、ドキュメントとソースの削除を参照してください。

GET

knowledge-fs

spaces

{knowledge_base_id}

deletion-jobs

{deletion_job_id}

削除ジョブを取得

curl --request GET \
  --url https://{api_base_url}/knowledge-fs/spaces/{knowledge_base_id}/deletion-jobs/{deletion_job_id} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://{api_base_url}/knowledge-fs/spaces/{knowledge_base_id}/deletion-jobs/{deletion_job_id}"

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

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

print(response.text)

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

fetch('https://{api_base_url}/knowledge-fs/spaces/{knowledge_base_id}/deletion-jobs/{deletion_job_id}', 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}/deletion-jobs/{deletion_job_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  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}/deletion-jobs/{deletion_job_id}"

	req, _ := http.NewRequest("GET", 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.get("https://{api_base_url}/knowledge-fs/spaces/{knowledge_base_id}/deletion-jobs/{deletion_job_id}")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{api_base_url}/knowledge-fs/spaces/{knowledge_base_id}/deletion-jobs/{deletion_job_id}")

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

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

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

{
  "checkpoint": "completed",
  "completed_at": "2026-10-20T09:00:09Z",
  "created_at": "2026-10-20T09:00:00Z",
  "error": null,
  "id": "b7e1c2d3-4f5a-4b6c-8d9e-0f1a2b3c4d5e",
  "knowledge_space_id": "9b2e5b7a-3c1d-4e2f-8a9b-1c2d3e4f5a6b",
  "mode": "cascade",
  "progress": null,
  "retry_at": null,
  "run_state": "completed",
  "target_id": "6ec0bd7f-11c0-43da-975e-2a8ad9ebae0b",
  "target_type": "document",
  "updated_at": "2026-10-20T09:00:09Z"
}

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/ の後のセグメントです。

deletion_job_id

string<uuid>

required

削除ジョブ ID です。ドキュメントファイルを削除またはソースを削除の job.id、あるいはドキュメントファイルを一括削除または削除バッチを取得で受け付けられたファイルの job.id です。これらの status_url は、この操作を指します。

Response

削除ジョブです。

checkpoint

string

削除の進み具合です。requested（受け付け直後）から始まり、quiescing、deleting_objects、deleting_derived_data、deleting_primary_data、completed の順に進みます。

completed_at

string | null

ジョブの完了日時（ISO 8601）です。完了するまでの間と、failed のジョブでは null です。

created_at

string

ジョブが受け付けられた日時（ISO 8601）です。

error

object | null

直近のエラーです。エラーがない場合は null です。run_state が retry_wait の間も設定されるため、ジョブが失敗したかどうかは error ではなく run_state で判断してください。

Show child attributes

string

削除ジョブ ID です。

knowledge_space_id

string

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

mode

string | null

ソースの削除時に、そのソースのドキュメントをどう扱うかを示します。cascade は削除し、keep は残します。ドキュメントファイルの削除では、この値は削除の対象範囲について何も示しません。

progress

object | null

複数アイテムの削除におけるアイテム数です。この API では設定されず、常に null です。

Show child attributes

retry_at

string | null

次回の自動再試行の実行日時（ISO 8601）です。予定されていない場合は null です。

run_state

string

スケジューラ上の状態です：

dispatch_pending（受け付け直後）、queued、running：処理中です。
retry_wait：retry_at に自動再試行が予定されています。
completed：すべて削除されました。
failed：クリーンアップが停止し、対象は非表示のままです。再試行はできません。

target_id

string

対象の ID です。document ではドキュメントファイル ID、source ではソース ID です。

target_type

string

ジョブの削除対象です。ドキュメントファイルは document、ソースは source です。

updated_at

string

ジョブが最後に変更された日時（ISO 8601）です。

削除ジョブを取得

curl --request GET \
  --url https://{api_base_url}/knowledge-fs/spaces/{knowledge_base_id}/deletion-jobs/{deletion_job_id} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://{api_base_url}/knowledge-fs/spaces/{knowledge_base_id}/deletion-jobs/{deletion_job_id}"

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

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

print(response.text)

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

fetch('https://{api_base_url}/knowledge-fs/spaces/{knowledge_base_id}/deletion-jobs/{deletion_job_id}', 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}/deletion-jobs/{deletion_job_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  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}/deletion-jobs/{deletion_job_id}"

	req, _ := http.NewRequest("GET", 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.get("https://{api_base_url}/knowledge-fs/spaces/{knowledge_base_id}/deletion-jobs/{deletion_job_id}")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{api_base_url}/knowledge-fs/spaces/{knowledge_base_id}/deletion-jobs/{deletion_job_id}")

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

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

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

{
  "checkpoint": "completed",
  "completed_at": "2026-10-20T09:00:09Z",
  "created_at": "2026-10-20T09:00:00Z",
  "error": null,
  "id": "b7e1c2d3-4f5a-4b6c-8d9e-0f1a2b3c4d5e",
  "knowledge_space_id": "9b2e5b7a-3c1d-4e2f-8a9b-1c2d3e4f5a6b",
  "mode": "cascade",
  "progress": null,
  "retry_at": null,
  "run_state": "completed",
  "target_id": "6ec0bd7f-11c0-43da-975e-2a8ad9ebae0b",
  "target_type": "document",
  "updated_at": "2026-10-20T09:00:09Z"
}

ガイド

アプリ API

ナレッジ API

削除ジョブを取得

Authorizations

Path Parameters

Response