Skip to main content
patch/datasets/{dataset_id}/documents/status/{action}
Request example
Response
patch/datasets/{dataset_id}/documents/status/{action}

Authorization

Authorizationstringheaderrequired#

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

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

Path parameters

dataset_idstringrequired#
ナレッジベース ID。ナレッジベースリストを取得 で取得します。スコープを限定したキーでは、Dify の URL から ID をコピー してください。
actionenum<string>required#
enable はドキュメントを検索対象として有効化し、disable は無効化し、archive はアーカイブに移動し、un_archive はアーカイブから復元します。
Options:enabledisablearchiveun_archive

Body

application/json
document_idsstring[]required#
更新するドキュメント ID です。ナレッジベースのドキュメントリストを取得 から取得します。

Responses

application/json
ドキュメントが正常に更新されました。
resultstring#
操作結果です。