ドキュメントメタデータを更新

ドキュメントの user_metadata にキーをマージし、更新後のドキュメントを返します。このパスの他の操作とは異なり、ドキュメントファイル ID ではなくドキュメント ID を受け取ります。

ドキュメントの row_version を expectedRowVersion として送信します。更新の直前にドキュメントを読み取り、409 が返った場合は読み直してから再送信してください。

1 min read

patch/knowledge-fs/spaces/{knowledge_base_id}/documents/{document_file_id}

Request example

curl --request PATCH \
  --url https://api.dify.ai/v1/knowledge-fs/spaces/{knowledge_base_id}/documents/{document_file_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "expectedRowVersion": 4,
  "patch": {
    "owner": "billing-team",
    "review_date": "2027-03-01T00:00:00Z"
  }
}'

import requests

url = "https://api.dify.ai/v1/knowledge-fs/spaces/{knowledge_base_id}/documents/{document_file_id}"
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json",
}
payload = {
    "expectedRowVersion": 4,
    "patch": {
        "owner": "billing-team",
        "review_date": "2027-03-01T00:00:00Z"
    }
}

response = requests.request("PATCH", url, headers=headers, json=payload)

print(response.text)

const response = await fetch('https://api.dify.ai/v1/knowledge-fs/spaces/{knowledge_base_id}/documents/{document_file_id}', {
  method: 'PATCH',
  headers: {
    'Authorization': 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    "expectedRowVersion": 4,
    "patch": {
      "owner": "billing-team",
      "review_date": "2027-03-01T00:00:00Z"
    }
  })
});

const data = await response.json();
console.log(data);

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => 'https://api.dify.ai/v1/knowledge-fs/spaces/{knowledge_base_id}/documents/{document_file_id}',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST => 'PATCH',
  CURLOPT_POSTFIELDS => '{
  "expectedRowVersion": 4,
  "patch": {
    "owner": "billing-team",
    "review_date": "2027-03-01T00:00:00Z"
  }
}',
  CURLOPT_HTTPHEADER => [
    'Authorization: Bearer <token>',
    'Content-Type: application/json',
  ],
]);

$response = curl_exec($curl);
curl_close($curl);

echo $response;

package main

import (
	"fmt"
	"io"
	"net/http"
	"strings"
)

func main() {
	url := "https://api.dify.ai/v1/knowledge-fs/spaces/{knowledge_base_id}/documents/{document_file_id}"
	payload := strings.NewReader("{\n  \"expectedRowVersion\": 4,\n  \"patch\": {\n    \"owner\": \"billing-team\",\n    \"review_date\": \"2027-03-01T00:00:00Z\"\n  }\n}")

	req, _ := http.NewRequest("PATCH", url, payload)
	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))
}

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://api.dify.ai/v1/knowledge-fs/spaces/{knowledge_base_id}/documents/{document_file_id}"))
    .header("Authorization", "Bearer <token>")
    .header("Content-Type", "application/json")
    .method("PATCH", HttpRequest.BodyPublishers.ofString("{\n  \"expectedRowVersion\": 4,\n  \"patch\": {\n    \"owner\": \"billing-team\",\n    \"review_date\": \"2027-03-01T00:00:00Z\"\n  }\n}"))
    .build();

HttpResponse<String> response = HttpClient.newHttpClient()
    .send(request, HttpResponse.BodyHandlers.ofString());

System.out.println(response.body());

require 'uri'
require 'net/http'

url = URI('https://api.dify.ai/v1/knowledge-fs/spaces/{knowledge_base_id}/documents/{document_file_id}')

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = url.scheme == 'https'

request = Net::HTTP::Patch.new(url)
request['Authorization'] = 'Bearer <token>'
request['Content-Type'] = 'application/json'
request.body = '{
  "expectedRowVersion": 4,
  "patch": {
    "owner": "billing-team",
    "review_date": "2027-03-01T00:00:00Z"
  }
}'

response = http.request(request)
puts response.read_body

Response

{
  "active": {
    "activated_at": "2026-10-20T08:16:05Z",
    "content_hash": "4f7c2d9a1b3e5f60718293a4b5c6d7e8f9a0b1c2d3e4f5a6b7c8d9e0f1a2b3c4",
    "created_at": "2026-10-20T08:15:42Z",
    "document_asset_id": "6ec0bd7f-11c0-43da-975e-2a8ad9ebae0b",
    "document_asset_version": 1,
    "document_id": "2f6b8d1a-7c3e-4a5b-9d0e-1f2a3b4c5d6e",
    "knowledge_space_id": "9b2e5b7a-3c1d-4e2f-8a9b-1c2d3e4f5a6b",
    "mime_type": "application/pdf",
    "revision": 2,
    "size_bytes": 482113,
    "state": "active"
  },
  "active_revision": 2,
  "created_at": "2026-09-03T10:02:11Z",
  "disabled_at": null,
  "disabled_by_subject_id": null,
  "enabled": true,
  "id": "2f6b8d1a-7c3e-4a5b-9d0e-1f2a3b4c5d6e",
  "knowledge_space_id": "9b2e5b7a-3c1d-4e2f-8a9b-1c2d3e4f5a6b",
  "latest_task": null,
  "provider_item_id": null,
  "row_version": 5,
  "source_id": null,
  "status": "ready",
  "title": "handbook.pdf",
  "updated_at": "2026-10-21T02:40:13Z",
  "user_metadata": {
    "owner": "billing-team",
    "product_line": "billing",
    "review_date": "2027-03-01T00:00:00Z"
  }
}

{
  "code": "knowledge_fs_invalid_request",
  "message": "Agent Knowledge Base request is invalid.",
  "status": 400,
  "violations": [
    {
      "field": [
        "patch"
      ],
      "type": "missing"
    }
  ]
}

{
  "code": "knowledge_fs_invalid_request",
  "message": "Agent Knowledge Base request is invalid.",
  "status": 400
}

{
  "code": "knowledge_fs_invalid_request",
  "failure": {
    "category": "validation",
    "code": "KNOWLEDGE_FS_INVALID_REQUEST",
    "message": "The Agent Knowledge Base request is invalid.",
    "retryPolicy": "never",
    "traceId": "7f3c1a90-2e64-4b7d-8a51-6c0d9e2f4b83"
  },
  "message": "The Agent Knowledge Base request is invalid.",
  "status": 400
}

{
  "code": "knowledge_fs_invalid_credential",
  "message": "Invalid Agent Knowledge Base service credential.",
  "status": 401
}

{
  "code": "unauthorized",
  "message": "Access token is invalid",
  "status": 401
}

{
  "code": "forbidden",
  "message": "Sorry, you have reached the knowledge base request rate limit of your subscription.",
  "status": 403
}

{
  "code": "knowledge_fs_access_denied",
  "message": "Agent Knowledge Base operation is not allowed.",
  "status": 403
}

{
  "code": "knowledge_fs_access_denied",
  "failure": {
    "action": "contact_admin",
    "category": "authorization",
    "code": "KNOWLEDGE_FS_ACCESS_DENIED",
    "message": "You do not have permission to perform this Agent Knowledge Base operation.",
    "retryPolicy": "never",
    "traceId": "7f3c1a90-2e64-4b7d-8a51-6c0d9e2f4b83"
  },
  "message": "You do not have permission to perform this Agent Knowledge Base operation.",
  "status": 403
}

{
  "code": "knowledge_fs_resource_not_found",
  "failure": {
    "category": "not_found",
    "code": "KNOWLEDGE_FS_NOT_FOUND",
    "message": "The requested Agent Knowledge Base resource was not found.",
    "retryPolicy": "never",
    "traceId": "7f3c1a90-2e64-4b7d-8a51-6c0d9e2f4b83"
  },
  "message": "The requested Agent Knowledge Base resource was not found.",
  "status": 404
}

{
  "code": "not_found",
  "message": "The requested URL was not found on the server. If you entered the URL manually please check your spelling and try again.",
  "status": 404
}

{
  "code": "knowledge_fs_conflict",
  "failure": {
    "action": "retry",
    "category": "conflict",
    "code": "LOGICAL_DOCUMENT_CAS_CONFLICT",
    "message": "The Agent Knowledge Base operation conflicts with the current resource state.",
    "parameters": {
      "currentRowVersion": 5,
      "expectedRowVersion": 4
    },
    "retryPolicy": "manual",
    "traceId": "7f3c1a90-2e64-4b7d-8a51-6c0d9e2f4b83"
  },
  "message": "The Agent Knowledge Base operation conflicts with the current resource state.",
  "status": 409
}

{
  "code": "knowledge_fs_request_too_large",
  "message": "Agent Knowledge Base request is too large.",
  "status": 413
}

{
  "code": "knowledge_fs_upstream_unavailable",
  "failure": {
    "action": "contact_admin",
    "category": "internal",
    "code": "KNOWLEDGE_FS_INTERNAL_ERROR",
    "message": "Agent Knowledge Base could not complete the operation. Try again, or contact an administrator with the error reference.",
    "retryPolicy": "manual",
    "traceId": "5e2a9c17-3b4d-4f60-8a1b-2c3d4e5f6a7b"
  },
  "message": "Agent Knowledge Base could not complete the operation. Try again, or contact an administrator with the error reference.",
  "status": 502
}

{
  "code": "knowledge_fs_upstream_unavailable",
  "message": "Agent Knowledge Base is unavailable.",
  "status": 502
}

{
  "code": "knowledge_fs_operation_unavailable",
  "message": "Agent Knowledge Base operation is not available.",
  "status": 503
}

{
  "code": "knowledge_fs_operation_unavailable",
  "failure": {
    "action": "retry",
    "category": "dependency",
    "code": "KNOWLEDGE_FS_UNAVAILABLE",
    "message": "A service required by Agent Knowledge Base is temporarily unavailable.",
    "retryPolicy": "manual",
    "traceId": "5e2a9c17-3b4d-4f60-8a1b-2c3d4e5f6a7b"
  },
  "message": "A service required by Agent Knowledge Base is temporarily unavailable.",
  "status": 503
}

patch/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 です。ドキュメント一覧を取得またはドキュメントを取得の id、あるいはファイルからドキュメントを取得の document_id を指定します。同じパスのドキュメントファイルを取得とドキュメントファイルを削除はドキュメントファイル ID を受け取りますが、この操作は受け取りません。ドキュメントファイル ID を指定すると 404 が返ります。

Body

application/json

expectedRowVersionintegerrequired#

ドキュメントの現在の row_version です。ドキュメントを取得またはドキュメント一覧を取得から取得するか、この操作が最後に返した row_version を使用します。新しいリビジョンがアクティブになったときや、Dify でドキュメントを有効化または無効化したときにも変わるため、更新の直前に読み取ってください。古い値を送ると 409 が返り、何も変更されません。

Range: >= 0

patchobjectrequired#

user_metadata にマージするキー：

値を指定したキーは、その値に設定されます。
null を指定したキーは削除されます。
指定しなかったキーはそのまま残ります。

各キーには、メタデータフィールド名を小文字のスネークケースで指定します。フィールドは事前に存在している必要があるため、先に Dify で作成してください。値はフィールドの型に合わせます。string には文字列、number には有限の数値、time には 2026-12-01T00:00:00Z のような UTC タイムスタンプを指定します。

次の予約済みキーを指定すると 400 が返ります：activeRevision、contentHash、documentAssetId、documentAssetVersion、mimeType、provenance、providerItemId、sourceId、system、systemMetadata、tenantId、__knowledgeFs、および system.、provenance.、__knowledgeFs. で始まるキー。

Responses

application/json

更新後のドキュメントです。この row_version を次回の更新で送信します。このレスポンスでは、latest_task は常に null です。

activeobject#

アクティブなリビジョン、つまりナレッジベースが提供しているコンテンツです。その revision をチャンク一覧を取得に、document_asset_id をドキュメントファイルを取得に渡します。アクティブなリビジョンがない間は null です。

Show child attributes

activated_atstring#

リビジョンがアクティブになった日時（ISO 8601）です。一度もアクティブになっていないリビジョンでは null です。

content_hashstring#

コンテンツの SHA-256 ハッシュ（16 進数エンコード）です。

created_atstring#

リビジョンの作成日時（ISO 8601）です。

document_asset_idstring#

このリビジョンの元になったドキュメントファイルの ID です。ドキュメントファイルを取得で使用します。

document_asset_versioninteger#

このリビジョンが作成された時点での、ドキュメントファイルの version です。

document_idstring#

ドキュメント ID です。ドキュメントを取得の id にあたります。

knowledge_space_idstring#

ナレッジベースの内部 ID です。パスのナレッジベース ID とは異なります。

mime_typestring#

ドキュメントファイルの MIME タイプです。

revisioninteger#

リビジョン番号で、1 から始まります。チャンク一覧を取得のパスパラメータ revision に指定する値です。

size_bytesinteger#

ドキュメントファイルのサイズ（バイト単位）です。

statestring#

インデックス処理中のリビジョンは candidate、ナレッジベースが提供しているリビジョンは active です。新しいリビジョンがアクティブになった後は superseded、インデックス処理に失敗した場合は failed になります。

active_revisioninteger#

アクティブなリビジョンの番号です。アクティブなリビジョンがない間は null です。

created_atstring#

ドキュメントの作成日時（ISO 8601）です。

disabled_atstring#

Dify でドキュメントが無効化された日時（ISO 8601）です。

disabled_by_subject_idstring#

ドキュメントを無効化した操作者の内部 ID です。この API の呼び出しには不要です。

enabledboolean#

Dify でドキュメントが無効化されると false になります。ドキュメントを再インデックスは、無効化されたドキュメントをスキップします。

idstring#

ドキュメント ID です。ドキュメントの内容を更新しても変わりません。

knowledge_space_idstring#

ナレッジベースの内部 ID です。パスのナレッジベース ID とは異なります。

latest_taskobject#

ドキュメントのリビジョンを作成した最新のインデックスタスクで、task_kind: document を持ちます。その id を指定してドキュメントのインデックスタスクを取得で追跡します。タスクがない場合は null です。ドキュメントメタデータを更新のレスポンスでは常に null です。

Show child attributes

can_cancelboolean#

タスクを現時点でキャンセルできるかどうかです。task_kind: document の場合は、id を指定してインデックスタスクをキャンセルでキャンセルします。一括タスクには、can_cancel が true であっても、この API でキャンセルする操作はありません。

can_retryboolean#

タスクを現時点で再試行できるかどうかです。task_kind: document の場合は、id を指定してインデックスタスクを再試行で再試行します。

completed_atstring#

タスクの終了日時（ISO 8601）です。実行中は null です。

created_atstring#

タスクの作成日時（ISO 8601）です。

document_idstring#

インデックスタスクのドキュメント ID です。一括タスクでは、対象ドキュメントが 1 件の場合にのみ設定されます。

document_revisioninteger#

インデックスタスクが構築するリビジョンです。

document_titlestring#

ドキュメントのタイトルです。対象ドキュメントが 1 件の一括タスクでのみ設定されます。

error_codestring#

state が failed の場合のエラーコードです。

error_messagestring#

error_code に対応するメッセージです。failure.message と異なる場合があります。

failureobject#

state が failed の場合のエラー詳細です。それ以外の場合は null です。

Show child attributes

actionstring#

推奨される次の対応です。ある場合は configure_model、configure_parser、configure_source、contact_admin、reupload、retry のいずれかです。該当しない場合は null で、HTTP エラーのボディでは省略されます。

categorystring#

失敗の種類で、authorization、canceled、configuration、conflict、dependency、internal、not_found、rate_limit、timeout、validation のいずれかです。

codestring#

大文字のスネークケースで表される固定のエラーコードです（例：KNOWLEDGE_FS_CONFLICT、SOURCE_CREDENTIAL_TEST_FAILED）。

messagestring#

エラーコードまたは失敗の種類に対応する公開用メッセージです。プロバイダーのエラー詳細は公開されません。

parametersobject#

失敗の内容を補足する最大 8 個の値です。キーは attempt、currentRowVersion、documentCount、expectedRowVersion、fileSizeBytes、limit、maxFileSizeBytes、maxItems、modelType、providerKind、retryAfterSeconds、status のいずれかです。値がない場合は null で、HTTP エラーのボディでは省略されます。

retryPolicystring#

再試行で解決できるかどうかです。automatic（サービスが自動で再試行）、manual（呼び出し側で再試行）、after_configuration（先に Dify でナレッジベースの設定を修正）、never（リクエストを変更）のいずれかです。

stagestring#

失敗が発生した段階です（例：query_generation、credential-test）。該当しない場合は null で、HTTP エラーのボディでは省略されます。

traceIdstring#

管理者に問い合わせる際に伝える参照情報です。失敗の詳細を含む成功レスポンスでは null になることがあり、HTTP エラーのボディでは省略されることがあります。

failuresobject[]#

一括タスクの場合、失敗したドキュメントごとに 1 つのエントリが入ります。ほかの種類では null です。

Show child attributes

document_idstring#

ドキュメント ID です。

document_titlestring#

ドキュメントのタイトルです。

error_codestring#

失敗のエラーコードです。

error_messagestring#

error_code に対応するメッセージです。

failureobject#

Show child attributes

actionstring#

categorystring#

失敗の種類で、authorization、canceled、configuration、conflict、dependency、internal、not_found、rate_limit、timeout、validation のいずれかです。

codestring#

大文字のスネークケースで表される固定のエラーコードです（例：KNOWLEDGE_FS_CONFLICT、SOURCE_CREDENTIAL_TEST_FAILED）。

messagestring#

エラーコードまたは失敗の種類に対応する公開用メッセージです。プロバイダーのエラー詳細は公開されません。

parametersobject#

retryPolicystring#

stagestring#

失敗が発生した段階です（例：query_generation、credential-test）。該当しない場合は null で、HTTP エラーのボディでは省略されます。

traceIdstring#

job_idstring#

ドキュメントに対応するタスクの ID です（存在する場合）。

idstring#

タスク ID です。task_kind: document ではインデックスタスク ID、document_bulk では一括タスク ID、source ではソースの実行 ID です。ドキュメントを削除による document_delete タスクでは、削除ジョブ ID です。この ID で削除ジョブを取得をポーリングしてください。

knowledge_space_idstring#

ナレッジベースの内部 ID です。パスのナレッジベース ID とは異なります。

operationstring#

タスクの処理内容です：

document_processing：インデックスタスクです。
document_reindex、document_upload、document_delete：一括タスクです。一括アップロードと一括削除は Dify 上で実行されたものです。ドキュメントを削除で削除した場合は、document_delete タスクとしても表示されます。この API によるその他の削除では、削除ジョブだけが作成されます。
source_sync、source_crawl_preview、source_crawl_import、source_online_document_import、source_online_drive_import：ソースの実行です。

progress_completedinteger#

完了したアイテム数です。インデックスタスクではそのドキュメント、一括タスクでは各ドキュメント、ソースの実行では各アイテムを数えます。

progress_failedinteger#

失敗したアイテム数です。数え方は progress_completed と同じです。

progress_percentinteger#

0 から 100 までの進捗です。インデックスタスクでは、タスクの段階に応じて進みます。

progress_totalinteger#

タスク内のアイテム数です。数え方は progress_completed と同じです。インデックスタスクでは 1 です。

semantic_enrichmentobject#

インデックスタスクの公開後に行うナレッジグラフの構築です。ほかの種類では null です。インデックス処理が公開前にナレッジグラフの構築まで済ませるため、この処理は実行されません。タスクの実行中、state は not_scheduled で、終了後は disabled になります。nodes_completed は 0 のままです。

Show child attributes

error_codestring#

state が failed の場合のエラーコードです。

error_messagestring#

error_code に対応するメッセージです。failure.message と異なる場合があります。

failureobject#

state が failed の場合のエラー詳細です。それ以外の場合は null です。

Show child attributes

actionstring#

categorystring#

失敗の種類で、authorization、canceled、configuration、conflict、dependency、internal、not_found、rate_limit、timeout、validation のいずれかです。

codestring#

大文字のスネークケースで表される固定のエラーコードです（例：KNOWLEDGE_FS_CONFLICT、SOURCE_CREDENTIAL_TEST_FAILED）。

messagestring#

エラーコードまたは失敗の種類に対応する公開用メッセージです。プロバイダーのエラー詳細は公開されません。

parametersobject#

retryPolicystring#

stagestring#

失敗が発生した段階です（例：query_generation、credential-test）。該当しない場合は null で、HTTP エラーのボディでは省略されます。

traceIdstring#

nodes_completedinteger#

構築済みのナレッジグラフのノード数です。state が ready になるまでは 0 で、その後は nodes_total と同じ値になります。

nodes_totalinteger#

構築するナレッジグラフのノード数です。判明するまでは null です。

provider_callsinteger#

これまでのモデル呼び出し回数です。

provider_calls_maximuminteger#

ナレッジグラフの構築で実行できるモデル呼び出しの最大回数です。

statestring#

not_scheduled、pending、running、ready、failed、disabled のいずれかです。

updated_atstring#

エンリッチメントが最後に変更された日時（ISO 8601）です。

source_idstring#

ソースの実行が属するソースです。

source_titlestring#

ソースの実行が属するソースの名前です。task_ids を指定せずに一覧を取得した場合にのみ設定されます。

statestring#

queued、running、completed、failed、canceled のいずれかで、各タスク固有の状態から変換されます。ページの選択を待っているクロールプレビューは completed です。

正確な状態は、インデックスタスクならインデックスタスクを取得、ソースの実行ならソースの実行を取得で確認してください。

task_kindstring#

document（インデックスタスク）、document_bulk（一括タスク）、source（ソースの実行）のいずれかです。

updated_atstring#

タスクが最後に変更された日時（ISO 8601）です。

provider_item_idstring#

ソースからインポートしたドキュメントの場合、ソース側でのアイテムの識別子です。ソースのアイテムをインポートに送信した providerItemId、またはウェブサイトのページの page_id です。

row_versioninteger#

変更カウンターです。ドキュメントメタデータを更新では expectedRowVersion として、ドキュメントを削除では expectedRevision として送信します。メタデータの更新時、新しいリビジョンがアクティブになった時やアクティブなリビジョンのファイルが削除された時に増加します。documents=keep を指定してドキュメントのソースを削除した時と、Dify でドキュメントが有効化または無効化された時にも増加します。

source_idstring#

ドキュメントの取得元のソースです。アップロードされたファイルでは null です。

statusstring#

pending（まだアクティブなリビジョンがない）、ready（リビジョンがアクティブ）、failed（最初のリビジョンのインデックス処理に失敗し、アクティブなリビジョンがない）、deleting のいずれかです。ready のドキュメントは、後続のリビジョンが失敗しても ready のままです。

titlestring#

ドキュメントのタイトルです。

updated_atstring#

ドキュメントが最後に変更された日時（ISO 8601）です。

user_metadataobject#

カスタムメタデータで、キーはメタデータフィールド名です。ドキュメントメタデータを更新または Dify で変更できます。

ドキュメントを取得ドキュメントを削除