Skip to main content
DELETE
ソースを削除

Authorizations

Authorization
string
header
required

すべてのリクエストは API キーで認証します:Authorization: Bearer {API_KEY}。アプリのエンドポイントにはアプリの API キーを、ナレッジのエンドポイントにはナレッジベースの API キーを使用します(Dify API クイックスタート)。

キーはサーバーサイドで保管し、クライアントコードには決して埋め込まないでください。キーが欠落または無効なリクエストは HTTP 401(unauthorized)で失敗します。

Headers

Idempotency-Key
string
required

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

Required string length: 8 - 255

Path Parameters

knowledge_base_id
string<uuid>
required

ナレッジベース ID です。ナレッジベースの API アクセス ダイアログに表示されるサービス API エンドポイントの最後のセグメント(…/knowledge-fs/spaces/<knowledge base ID>)です。アドレスバーでは /datasets/new/ の後のセグメントです。

source_id
string<uuid>
required

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

Query Parameters

documents
enum<string>
default:cascade

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

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

Available options:
cascade,
keep

Body

application/json

正規化後のリクエストは、UTF-8 で 32,768 バイト以内に収める必要があります。リクエストサイズの制限 を参照してください。

expectedRevision
integer
required

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

Required range: x >= 1

Response

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

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

document_title
string | null

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

job
object

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

status_url
string

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