Skip to main content
delete/knowledge-fs/spaces/{knowledge_base_id}/documents/{document_file_id}
Request example
Response
delete/knowledge-fs/spaces/{knowledge_base_id}/documents/{document_file_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_file_idstringrequired#
ドキュメントファイル ID です。ドキュメントファイル一覧を取得 から取得します。

Headers

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

Length: 8–255

Body

application/json
expectedRevisionintegerrequired#
ドキュメントファイルの現在の version です。ドキュメントファイル一覧を取得 または ドキュメントファイルを取得 から取得します。ドキュメントファイルの version は常に 1 です。ドキュメントリビジョン一覧を取得 のリビジョン番号ではありません。古い値を送ると 409 が返り、何も削除されません。

Range: >= 1

Responses

application/json
削除リクエストが受け付けられ、バックグラウンドで実行されます。受け付けられた時点から、ドキュメントファイルを取得 は 404 を返します。完了を確認するには、run_state が completed または failed になるまで 削除ジョブを取得(status_url)をポーリングしてください。
document_titlestring#
ドキュメントを削除 のリクエストでは、ドキュメントのタイトルが入ります。同じ Idempotency-Key でリクエストを再送信した場合は null になります。ドキュメントファイルの削除では常に null です。
jobobject#
status_urlstring#
このジョブの 削除ジョブを取得 の URL です。デプロイ環境で SERVICE_API_URL が設定されている場合は絶対 URL、それ以外の場合は /v1/ で始まるパスです。同じ値が Location レスポンスヘッダーでも返されます。