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

document_id
string<uuid>
required

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

Body

application/json
expectedRevision
integer
required

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

Required range: x >= 0

Response

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

document_title
string | null

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

job
object
status_url
string

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