Skip to main content
PATCH
/
datasets
/
{dataset_id}
/
documents
/
status
/
{action}
ドキュメントステータスを一括更新
curl --request PATCH \
  --url https://{api_base_url}/datasets/{dataset_id}/documents/status/{action} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "document_ids": [
    "<string>"
  ]
}
'
{
  "result": "success"
}

Authorizations

Authorization
string
header
required

API Key 認証です。すべての API リクエストにおいて、Authorization HTTP ヘッダーに Bearer プレフィックスを付けた API Key を含めてください。例:Authorization: Bearer {API_KEY}API Key はサーバーサイドに保存し、クライアントサイドで共有・保存しないことを強く推奨します。API Key の漏洩は深刻な結果につながる可能性があります。

Path Parameters

dataset_id
string<uuid>
required

ナレッジベース ID です。

action
enum<string>
required

enable で有効化、disable で無効化、archive でアーカイブ、un_archive でアーカイブから復元します。

Available options:
enable,
disable,
archive,
un_archive

Body

application/json
document_ids
string[]
required

更新するドキュメント ID のリストです。

Response

ドキュメントが正常に更新されました。

result
string

操作結果です。

Last modified on June 1, 2026