ソースを削除

delete/knowledge-fs/spaces/{knowledge_base_id}/sources/{source_id}

Request example

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

import requests

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

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

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

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

Response

{
  "document_title": null,
  "job": {
    "checkpoint": "requested",
    "completed_at": null,
    "created_at": "2026-09-06T02:00:00Z",
    "error": null,
    "id": "b2f1d3e4-5c6a-4b7d-8e9f-0a1b2c3d4e5f",
    "knowledge_space_id": "0a9d3c2e-5b6f-4e1a-8c7d-2f3e4a5b6c7d",
    "mode": "keep",
    "progress": null,
    "retry_at": null,
    "run_state": "dispatch_pending",
    "target_id": "6f1c2b0e-3d0b-4a5e-9f4c-1c0e6a7b8d90",
    "target_type": "source",
    "updated_at": "2026-09-06T02:00:00Z"
  },
  "status_url": "https://api.example.com/v1/knowledge-fs/spaces/8d2c6a1e-5b3f-4c7d-9e01-2a3b4c5d6e7f/deletion-jobs/b2f1d3e4-5c6a-4b7d-8e9f-0a1b2c3d4e5f"
}

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

{
  "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": "5e2a9c17-3b4d-4f60-8a1b-2c3d4e5f6a7b"
  },
  "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"
  },
  "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"
  },
  "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"
  },
  "message": "The Agent Knowledge Base operation conflicts with the current resource state.",
  "status": 409
}

{
  "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}/sources/{source_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/ の後のセグメントです。

source_idstringrequired#

ソース ID です。ソース一覧を取得から取得します。

Query parameters

documentsenum<string>#

cascade は、ソースが生成したドキュメントも削除します。keep はそれらのドキュメントを残します。残したドキュメントは削除ジョブの実行中は非表示になり、完了すると source_id が null になった状態で再び表示されます。以後は更新されません。

keep で削除する前に、ドキュメントファイル一覧を取得で、この source_id を持つファイルの ID を保存してください。削除が完了すると、それらのファイルの source_id は null になります。

Default: "cascade"

Options:cascadekeep

Headers

Idempotency-Keystringrequired#

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

Length: 8–255

Body

application/json

expectedRevisionintegerrequired#

ソースの現在の version です。ソース一覧を取得またはソースを取得から取得します。古い値を送ると 409 が返り、何も変更されません。

Range: >= 1

Responses

application/json

削除が受け付けられました。job は、バックグラウンドで行われる削除の内容を示します。

削除が受け付けられた時点から、ソースを取得は 404 を返します。削除の完了を確認するには、run_state が completed または failed になるまで削除ジョブを取得（status_url）をポーリングしてください。

document_titlestring#

ソースの削除では常に null です。

jobobject#

削除ジョブです。target_type は source で、mode には documents の値が入ります。

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#

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

ソースを更新ソースの認証情報をテスト