削除ジョブを取得

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

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

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

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

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

1 min read

get/knowledge-fs/spaces/{knowledge_base_id}/deletion-jobs/{deletion_job_id}

Request example

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

import requests

url = "https://api.dify.ai/v1/knowledge-fs/spaces/{knowledge_base_id}/deletion-jobs/{deletion_job_id}"
headers = {
    "Authorization": "Bearer <token>",
}

response = requests.request("GET", url, headers=headers)

print(response.text)

const response = await fetch('https://api.dify.ai/v1/knowledge-fs/spaces/{knowledge_base_id}/deletion-jobs/{deletion_job_id}', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer <token>'
  }
});

const data = await response.json();
console.log(data);

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => 'https://api.dify.ai/v1/knowledge-fs/spaces/{knowledge_base_id}/deletion-jobs/{deletion_job_id}',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST => 'GET',
  CURLOPT_HTTPHEADER => [
    'Authorization: Bearer <token>',
  ],
]);

$response = curl_exec($curl);
curl_close($curl);

echo $response;

package main

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

func main() {
	url := "https://api.dify.ai/v1/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))
}

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://api.dify.ai/v1/knowledge-fs/spaces/{knowledge_base_id}/deletion-jobs/{deletion_job_id}"))
    .header("Authorization", "Bearer <token>")
    .method("GET", HttpRequest.BodyPublishers.noBody())
    .build();

HttpResponse<String> response = HttpClient.newHttpClient()
    .send(request, HttpResponse.BodyHandlers.ofString());

System.out.println(response.body());

require 'uri'
require 'net/http'

url = URI('https://api.dify.ai/v1/knowledge-fs/spaces/{knowledge_base_id}/deletion-jobs/{deletion_job_id}')

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = url.scheme == 'https'

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

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

Response

{
  "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"
}

{
  "checkpoint": "deleting_objects",
  "completed_at": null,
  "created_at": "2026-10-20T09:00:00Z",
  "error": {
    "code": "DURABLE_DELETION_ITEM_RETRY_WAIT",
    "message": "Durable deletion is waiting to retry external cleanup",
    "retryable": false
  },
  "id": "b7e1c2d3-4f5a-4b6c-8d9e-0f1a2b3c4d5e",
  "knowledge_space_id": "9b2e5b7a-3c1d-4e2f-8a9b-1c2d3e4f5a6b",
  "mode": "keep",
  "progress": null,
  "retry_at": "2026-10-20T09:01:00Z",
  "run_state": "retry_wait",
  "target_id": "6f1c2b0e-3d0b-4a5e-9f4c-1c0e6a7b8d90",
  "target_type": "source",
  "updated_at": "2026-10-20T09:00:30Z"
}

{
  "checkpoint": "deleting_derived_data",
  "completed_at": null,
  "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": "running",
  "target_id": "6ec0bd7f-11c0-43da-975e-2a8ad9ebae0b",
  "target_type": "document",
  "updated_at": "2026-10-20T09:00:04Z"
}

{
  "code": "knowledge_fs_invalid_request",
  "message": "Agent Knowledge Base request is invalid.",
  "status": 400
}

{
  "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
}

{
  "code": "knowledge_fs_invalid_credential",
  "message": "Invalid Agent Knowledge Base service credential.",
  "status": 401
}

{
  "code": "unauthorized",
  "message": "Access token is invalid",
  "status": 401
}

{
  "code": "forbidden",
  "message": "Sorry, you have reached the knowledge base request rate limit of your subscription.",
  "status": 403
}

{
  "code": "knowledge_fs_access_denied",
  "message": "Agent Knowledge Base operation is not allowed.",
  "status": 403
}

{
  "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
}

{
  "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
}

{
  "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
}

{
  "code": "knowledge_fs_upstream_unavailable",
  "message": "Agent Knowledge Base is unavailable.",
  "status": 502
}

{
  "code": "knowledge_fs_operation_unavailable",
  "message": "Agent Knowledge Base operation is not available.",
  "status": 503
}

{
  "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
}

get/knowledge-fs/spaces/{knowledge_base_id}/deletion-jobs/{deletion_job_id}

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

deletion_job_idstringrequired#

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

Responses

application/json

削除ジョブです。

checkpointstring#

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

completed_atstring#

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

created_atstring#

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

errorobject#

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

Show child attributes

codestring#

直近のエラーのコードです。

messagestring#

直近のエラーの公開用メッセージです。内部のエラー詳細は含まれません。

retryableboolean#

run_state が failed の場合は true です。この API では、失敗した削除を再試行できません。

idstring#

削除ジョブ ID です。

knowledge_space_idstring#

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

modestring#

ソースの削除時に、そのソースのドキュメントをどう扱うかを示します。cascade は削除し、keep は残します。ドキュメントファイルやドキュメントの削除では、この値は無視してください。

progressobject#

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

Show child attributes

completed_itemsinteger#

これまでに削除されたアイテム数です。

current_item_kindstring#

削除中のアイテムの種類です。

total_itemsinteger#

削除対象のアイテム数です。

retry_atstring#

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

run_statestring#

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

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

target_idstring#

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

target_typestring#

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

updated_atstring#

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

バックグラウンドタスク一覧を取得削除バッチを取得