ドキュメントを削除

ドキュメントの削除をリクエストし、削除ジョブを返します。削除の対象は、ドキュメント本体、そのすべてのリビジョン、このドキュメントだけが使用しているドキュメントファイルです。ジョブが完了すると、このドキュメントはドキュメント数の上限にカウントされなくなります。

この DELETE には JSON ボディを付けて送信します。クライアントが DELETE リクエストのボディを省略する場合は、ボディを明示的に送信するよう設定してください。

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

1 min read

delete/knowledge-fs/spaces/{knowledge_base_id}/logical-documents/{document_id}

Request example

curl --request DELETE \
  --url https://api.dify.ai/v1/knowledge-fs/spaces/{knowledge_base_id}/logical-documents/{document_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Idempotency-Key: <string>' \
  --header 'Content-Type: application/json' \
  --data '{
  "expectedRevision": 4
}'

import requests

url = "https://api.dify.ai/v1/knowledge-fs/spaces/{knowledge_base_id}/logical-documents/{document_id}"
headers = {
    "Authorization": "Bearer <token>",
    "Idempotency-Key": "<string>",
    "Content-Type": "application/json",
}
payload = {
    "expectedRevision": 4
}

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}/logical-documents/{document_id}', {
  method: 'DELETE',
  headers: {
    'Authorization': 'Bearer <token>',
    'Idempotency-Key': '<string>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    "expectedRevision": 4
  })
});

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}/logical-documents/{document_id}',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST => 'DELETE',
  CURLOPT_POSTFIELDS => '{
  "expectedRevision": 4
}',
  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}/logical-documents/{document_id}"
	payload := strings.NewReader("{\n  \"expectedRevision\": 4\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}/logical-documents/{document_id}"))
    .header("Authorization", "Bearer <token>")
    .header("Idempotency-Key", "<string>")
    .header("Content-Type", "application/json")
    .method("DELETE", HttpRequest.BodyPublishers.ofString("{\n  \"expectedRevision\": 4\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}/logical-documents/{document_id}')

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 = '{
  "expectedRevision": 4
}'

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

Response

{
  "document_title": "handbook.pdf",
  "job": {
    "checkpoint": "requested",
    "completed_at": null,
    "created_at": "2026-10-20T09:05:00Z",
    "error": null,
    "id": "c4d5e6f7-8a9b-4c0d-9e1f-2a3b4c5d6e7f",
    "knowledge_space_id": "9b2e5b7a-3c1d-4e2f-8a9b-1c2d3e4f5a6b",
    "mode": "cascade",
    "progress": null,
    "retry_at": null,
    "run_state": "dispatch_pending",
    "target_id": "2f6b8d1a-7c3e-4a5b-9d0e-1f2a3b4c5d6e",
    "target_type": "logical_document",
    "updated_at": "2026-10-20T09:05:00Z"
  },
  "status_url": "https://api.example.com/v1/knowledge-fs/spaces/8d2c6a1e-5b3f-4c7d-9e01-2a3b4c5d6e7f/deletion-jobs/c4d5e6f7-8a9b-4c0d-9e1f-2a3b4c5d6e7f"
}

{
  "code": "knowledge_fs_invalid_request",
  "message": "Agent Knowledge Base request is invalid.",
  "status": 400,
  "violations": [
    {
      "field": [
        "expectedRevision"
      ],
      "type": "greater_than_equal"
    }
  ]
}

{
  "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,
  "violations": [
    {
      "field": [
        "documentId"
      ],
      "type": "invalid_format"
    }
  ]
}

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

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

delete/knowledge-fs/spaces/{knowledge_base_id}/logical-documents/{document_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/ の後のセグメントです。

document_idstringrequired#

ドキュメント ID です。ドキュメント一覧を取得から取得します。ドキュメントファイル ID からドキュメント ID を調べるには、ファイルからドキュメントを取得を使用します。

Headers

Idempotency-Keystringrequired#

同じ API キーと冪等キーで同一のリクエストを再送信すると、元のジョブが 202 で返されます。別のリクエストや別の API キーで同じキーを再利用すると 409 が返ります。前後に空白を含まない、印字可能な ASCII 文字を使用してください。

Length: 8–255

Body

application/json

expectedRevisionintegerrequired#

ドキュメントの現在の row_version です。ドキュメントを取得またはドキュメント一覧を取得から取得します。0 の場合もあります。active.revision などのリビジョン番号でも、ドキュメントファイルの version でもありません。古い値を送ると 409 が返り、何も削除されません。

Range: >= 0

Responses

application/json

削除リクエストが受け付けられ、バックグラウンドで実行されます。受け付けられた時点から、ドキュメントを取得はこのドキュメントに対して 404 を返します。ドキュメント一覧を取得の結果にも含まれなくなります。完了を確認するには、run_state が completed または failed になるまで削除ジョブを取得（status_url）をポーリングしてください。

document_titlestring#

ドキュメントを削除のリクエストでは、ドキュメントのタイトルが入ります。同じ Idempotency-Key でリクエストを再送信した場合は null になります。ドキュメントファイルの削除では常に null です。

jobobject#

Show child attributes

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）です。

status_urlstring#

このジョブの削除ジョブを取得の URL です。デプロイ環境で SERVICE_API_URL が設定されている場合は絶対 URL、それ以外の場合は /v1/ で始まるパスです。同じ値が Location レスポンスヘッダーでも返されます。

ドキュメントメタデータを更新ファイルからドキュメントを取得