ドキュメントファイルを一括削除
1 回の呼び出しで最大 100 件のドキュメントファイルの削除をリクエストし、ファイルごとの結果を返します。ドキュメントファイルを削除 と同様に、アクティブなリビジョンのファイルは削除しないでください。
この DELETE には JSON ボディを付けて送信します。クライアントが DELETE リクエストのボディを省略する場合は、ボディを明示的に送信するよう設定してください。
ファイルは documentId、次に expectedRevision の順に並べ替えられ、1 件ずつ個別に処理されます。存在しないファイル、expectedRevision が古いファイル、すでに削除中のファイル、この API キーでは削除できないファイルは results に rejected として返り、他のファイルの処理は続行されます。インフラ障害が起きると実行が止まり、残りのファイルは pending のままになります。
インフラ障害の後や、呼び出し全体が失敗した後に続行するには、同じ Idempotency-Key で同じリクエストを再送信してください。受け付け済みのジョブを含む元のバッチが返され、pending のファイルだけが再試行されます。
この呼び出しでは一括タスクは作成されません。
削除の流れについては、ドキュメントとソースの削除 を参照してください。
curl --request DELETE \
--url https://api.dify.ai/v1/knowledge-fs/spaces/{knowledge_base_id}/documents/bulk \
--header 'Authorization: Bearer <token>' \
--header 'Idempotency-Key: <string>' \
--header 'Content-Type: application/json' \
--data '{
"documents": [
{
"documentId": "6ec0bd7f-11c0-43da-975e-2a8ad9ebae0b",
"expectedRevision": 1
},
{
"documentId": "2c1e7a44-5b6d-4e8f-9a0b-1c2d3e4f5a6b",
"expectedRevision": 1
},
{
"documentId": "9d8c7b6a-5f4e-4d3c-8b2a-1f0e9d8c7b6a",
"expectedRevision": 1
}
]
}'import requests
url = "https://api.dify.ai/v1/knowledge-fs/spaces/{knowledge_base_id}/documents/bulk"
headers = {
"Authorization": "Bearer <token>",
"Idempotency-Key": "<string>",
"Content-Type": "application/json",
}
payload = {
"documents": [
{
"documentId": "6ec0bd7f-11c0-43da-975e-2a8ad9ebae0b",
"expectedRevision": 1
},
{
"documentId": "2c1e7a44-5b6d-4e8f-9a0b-1c2d3e4f5a6b",
"expectedRevision": 1
},
{
"documentId": "9d8c7b6a-5f4e-4d3c-8b2a-1f0e9d8c7b6a",
"expectedRevision": 1
}
]
}
response = requests.request("DELETE", url, headers=headers, json=payload)
print(response.text)const response = await fetch('https://api.dify.ai/v1/knowledge-fs/spaces/{knowledge_base_id}/documents/bulk', {
method: 'DELETE',
headers: {
'Authorization': 'Bearer <token>',
'Idempotency-Key': '<string>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
"documents": [
{
"documentId": "6ec0bd7f-11c0-43da-975e-2a8ad9ebae0b",
"expectedRevision": 1
},
{
"documentId": "2c1e7a44-5b6d-4e8f-9a0b-1c2d3e4f5a6b",
"expectedRevision": 1
},
{
"documentId": "9d8c7b6a-5f4e-4d3c-8b2a-1f0e9d8c7b6a",
"expectedRevision": 1
}
]
})
});
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}/documents/bulk',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => 'DELETE',
CURLOPT_POSTFIELDS => '{
"documents": [
{
"documentId": "6ec0bd7f-11c0-43da-975e-2a8ad9ebae0b",
"expectedRevision": 1
},
{
"documentId": "2c1e7a44-5b6d-4e8f-9a0b-1c2d3e4f5a6b",
"expectedRevision": 1
},
{
"documentId": "9d8c7b6a-5f4e-4d3c-8b2a-1f0e9d8c7b6a",
"expectedRevision": 1
}
]
}',
CURLOPT_HTTPHEADER => [
'Authorization: Bearer <token>',
'Idempotency-Key: <string>',
'Content-Type: application/json',
],
]);
$response = curl_exec($curl);
curl_close($curl);
echo $response;package main
import (
"fmt"
"io"
"net/http"
"strings"
)
func main() {
url := "https://api.dify.ai/v1/knowledge-fs/spaces/{knowledge_base_id}/documents/bulk"
payload := strings.NewReader("{\n \"documents\": [\n {\n \"documentId\": \"6ec0bd7f-11c0-43da-975e-2a8ad9ebae0b\",\n \"expectedRevision\": 1\n },\n {\n \"documentId\": \"2c1e7a44-5b6d-4e8f-9a0b-1c2d3e4f5a6b\",\n \"expectedRevision\": 1\n },\n {\n \"documentId\": \"9d8c7b6a-5f4e-4d3c-8b2a-1f0e9d8c7b6a\",\n \"expectedRevision\": 1\n }\n ]\n}")
req, _ := http.NewRequest("DELETE", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Idempotency-Key", "<string>")
req.Header.Add("Content-Type", "application/json")
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}/documents/bulk"))
.header("Authorization", "Bearer <token>")
.header("Idempotency-Key", "<string>")
.header("Content-Type", "application/json")
.method("DELETE", HttpRequest.BodyPublishers.ofString("{\n \"documents\": [\n {\n \"documentId\": \"6ec0bd7f-11c0-43da-975e-2a8ad9ebae0b\",\n \"expectedRevision\": 1\n },\n {\n \"documentId\": \"2c1e7a44-5b6d-4e8f-9a0b-1c2d3e4f5a6b\",\n \"expectedRevision\": 1\n },\n {\n \"documentId\": \"9d8c7b6a-5f4e-4d3c-8b2a-1f0e9d8c7b6a\",\n \"expectedRevision\": 1\n }\n ]\n}"))
.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}/documents/bulk')
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = url.scheme == 'https'
request = Net::HTTP::Delete.new(url)
request['Authorization'] = 'Bearer <token>'
request['Idempotency-Key'] = '<string>'
request['Content-Type'] = 'application/json'
request.body = '{
"documents": [
{
"documentId": "6ec0bd7f-11c0-43da-975e-2a8ad9ebae0b",
"expectedRevision": 1
},
{
"documentId": "2c1e7a44-5b6d-4e8f-9a0b-1c2d3e4f5a6b",
"expectedRevision": 1
},
{
"documentId": "9d8c7b6a-5f4e-4d3c-8b2a-1f0e9d8c7b6a",
"expectedRevision": 1
}
]
}'
response = http.request(request)
puts response.read_body{
"batch_id": "3e5a7c9b-1d2f-4a6b-8c0d-2e4f6a8b0c1d",
"items": [
{
"document_id": "2c1e7a44-5b6d-4e8f-9a0b-1c2d3e4f5a6b",
"document_title": null,
"job": {
"checkpoint": "requested",
"completed_at": null,
"created_at": "2026-09-06T02:15:30Z",
"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": "dispatch_pending",
"target_id": "2c1e7a44-5b6d-4e8f-9a0b-1c2d3e4f5a6b",
"target_type": "document",
"updated_at": "2026-09-06T02:15:30Z"
},
"status_url": "https://api.example.com/v1/knowledge-fs/spaces/8d2c6a1e-5b3f-4c7d-9e01-2a3b4c5d6e7f/deletion-jobs/b7e1c2d3-4f5a-4b6c-8d9e-0f1a2b3c4d5e"
},
{
"document_id": "6ec0bd7f-11c0-43da-975e-2a8ad9ebae0b",
"document_title": null,
"job": {
"checkpoint": "requested",
"completed_at": null,
"created_at": "2026-09-06T02:15:30Z",
"error": null,
"id": "0c9d8e7f-6a5b-4c3d-9e2f-1a0b9c8d7e6f",
"knowledge_space_id": "9b2e5b7a-3c1d-4e2f-8a9b-1c2d3e4f5a6b",
"mode": "cascade",
"progress": null,
"retry_at": null,
"run_state": "dispatch_pending",
"target_id": "6ec0bd7f-11c0-43da-975e-2a8ad9ebae0b",
"target_type": "document",
"updated_at": "2026-09-06T02:15:30Z"
},
"status_url": "https://api.example.com/v1/knowledge-fs/spaces/8d2c6a1e-5b3f-4c7d-9e01-2a3b4c5d6e7f/deletion-jobs/0c9d8e7f-6a5b-4c3d-9e2f-1a0b9c8d7e6f"
}
],
"results": [
{
"document_id": "2c1e7a44-5b6d-4e8f-9a0b-1c2d3e4f5a6b",
"error": null,
"job": {
"checkpoint": "requested",
"completed_at": null,
"created_at": "2026-09-06T02:15:30Z",
"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": "dispatch_pending",
"target_id": "2c1e7a44-5b6d-4e8f-9a0b-1c2d3e4f5a6b",
"target_type": "document",
"updated_at": "2026-09-06T02:15:30Z"
},
"status": "accepted",
"status_url": "https://api.example.com/v1/knowledge-fs/spaces/8d2c6a1e-5b3f-4c7d-9e01-2a3b4c5d6e7f/deletion-jobs/b7e1c2d3-4f5a-4b6c-8d9e-0f1a2b3c4d5e"
},
{
"document_id": "6ec0bd7f-11c0-43da-975e-2a8ad9ebae0b",
"error": null,
"job": {
"checkpoint": "requested",
"completed_at": null,
"created_at": "2026-09-06T02:15:30Z",
"error": null,
"id": "0c9d8e7f-6a5b-4c3d-9e2f-1a0b9c8d7e6f",
"knowledge_space_id": "9b2e5b7a-3c1d-4e2f-8a9b-1c2d3e4f5a6b",
"mode": "cascade",
"progress": null,
"retry_at": null,
"run_state": "dispatch_pending",
"target_id": "6ec0bd7f-11c0-43da-975e-2a8ad9ebae0b",
"target_type": "document",
"updated_at": "2026-09-06T02:15:30Z"
},
"status": "accepted",
"status_url": "https://api.example.com/v1/knowledge-fs/spaces/8d2c6a1e-5b3f-4c7d-9e01-2a3b4c5d6e7f/deletion-jobs/0c9d8e7f-6a5b-4c3d-9e2f-1a0b9c8d7e6f"
},
{
"document_id": "9d8c7b6a-5f4e-4d3c-8b2a-1f0e9d8c7b6a",
"error": {
"code": "DURABLE_DELETION_NOT_FOUND",
"message": "Deletion request was rejected",
"retryable": false
},
"job": null,
"status": "rejected",
"status_url": null
}
],
"status_url": "https://api.example.com/v1/knowledge-fs/spaces/8d2c6a1e-5b3f-4c7d-9e01-2a3b4c5d6e7f/deletion-batches/3e5a7c9b-1d2f-4a6b-8c0d-2e4f6a8b0c1d",
"total": 3
}{
"code": "knowledge_fs_invalid_request",
"message": "Agent Knowledge Base request is invalid.",
"status": 400,
"violations": [
{
"field": [
"documents"
],
"type": "too_long"
}
]
}{
"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_access_denied",
"failure": {
"action": "contact_admin",
"category": "authorization",
"code": "KNOWLEDGE_FS_ACCESS_DENIED",
"message": "You do not have permission to perform this Agent Knowledge Base operation.",
"retryPolicy": "never",
"traceId": "7f3c1a90-2e64-4b7d-8a51-6c0d9e2f4b83"
},
"message": "You do not have permission to perform this Agent Knowledge Base operation.",
"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_conflict",
"failure": {
"category": "conflict",
"code": "DURABLE_DELETION_IDEMPOTENCY_CONFLICT",
"message": "The Agent Knowledge Base operation conflicts with the current resource state.",
"retryPolicy": "never",
"traceId": "5e2a9c17-3b4d-4f60-8a1b-2c3d4e5f6a7b"
},
"message": "The Agent Knowledge Base operation conflicts with the current resource state.",
"status": 409
}{
"code": "knowledge_fs_request_too_large",
"message": "Agent Knowledge Base request is too large.",
"status": 413
}{
"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
}Authorization
すべてのリクエストは API キーで認証します:Authorization: Bearer {API_KEY}。アプリのエンドポイントにはアプリの API キーを、ナレッジのエンドポイントにはナレッジベースの API キーを使用します(Dify API クイックスタート)。
キーはサーバーサイドで保管し、クライアントコードには決して埋め込まないでください。キーが欠落または無効なリクエストは HTTP 401(unauthorized)で失敗します。
Path parameters
…/knowledge-fs/spaces/<knowledge base ID>)です。アドレスバーでは /datasets/new/ の後のセグメントです。Headers
pending のファイルが再試行されます。別のリクエストや別の API キーで同じキーを再利用すると 409 が返ります。前後に空白を含まない、印字可能な ASCII 文字を使用してください。Length: 8–255
Body
application/jsondocumentId は 1 回だけ指定します。上限より大きいバッチには 400 が返ります。デプロイ環境によっては、より低い上限が設定されている場合があります。Items: 1–100
Show child attributesHide child attributes
version です。ドキュメントファイル一覧を取得 または ドキュメントファイルを取得 から取得します。ドキュメントファイルの version は常に 1 です。ドキュメントリビジョン一覧を取得 のリビジョン番号ではありません。Range: >= 1
Responses
バッチが記録されました。results に各ファイルの結果が、items に受け付けられたファイルが入ります。削除はバックグラウンドで実行されます。ファイルの削除が受け付けられた時点から、ドキュメントファイルを取得 は 404 を返します。すべてのファイルを最後まで追跡するには、削除バッチを取得(バッチの status_url)をポーリングしてください。
返されたジョブ ID をポーリングしてください。pending のまま残ったファイルを再試行するには、同じ Idempotency-Key で同じリクエストを再送信してください。
Show child attributesHide child attributes
null です。Show child attributesHide child attributes
requested(受け付け直後)から始まり、quiescing、deleting_objects、deleting_derived_data、deleting_primary_data、completed の順に進みます。failed のジョブでは null です。null です。run_state が retry_wait の間も設定されるため、ジョブが失敗したかどうかは error ではなく run_state で判断してください。cascade は削除し、keep は残します。ドキュメントファイルやドキュメントの削除では、この値は無視してください。null です。null です。スケジューラ上の状態です:
dispatch_pending(受け付け直後)、queued、running:処理中です。retry_wait:retry_atに自動再試行が予定されています。completed:すべて削除されました。failed:クリーンアップが停止し、対象は非表示のままです。再試行はできません。
document ではドキュメントファイル ID、logical_document ではドキュメント ID、source ではソース ID です。document、ドキュメント全体は logical_document、ソースは source です。Show child attributesHide child attributes
null です。status が accepted の場合の削除ジョブです。それ以外の場合は null です。Show child attributesHide child attributes
requested(受け付け直後)から始まり、quiescing、deleting_objects、deleting_derived_data、deleting_primary_data、completed の順に進みます。failed のジョブでは null です。null です。run_state が retry_wait の間も設定されるため、ジョブが失敗したかどうかは error ではなく run_state で判断してください。cascade は削除し、keep は残します。ドキュメントファイルやドキュメントの削除では、この値は無視してください。null です。null です。スケジューラ上の状態です:
dispatch_pending(受け付け直後)、queued、running:処理中です。retry_wait:retry_atに自動再試行が予定されています。completed:すべて削除されました。failed:クリーンアップが停止し、対象は非表示のままです。再試行はできません。
document ではドキュメントファイル ID、logical_document ではドキュメント ID、source ではソース ID です。document、ドキュメント全体は logical_document、ソースは source です。accepted:削除が受け付けられました。jobとstatus_urlが設定されます。rejected:ファイルは削除されていません。理由はerrorに示されます。pending:ファイルはまだ受け付けられていません。再試行するには、同じIdempotency-Keyで元のリクエストを再送信してください。
SERVICE_API_URL が設定されている場合は絶対 URL、それ以外の場合は /v1/ で始まるパスです。ドキュメントファイルを一括削除 は、この値を Location レスポンスヘッダーでも返します。