ソースを更新

ソースの名前、ステータス、URI、メタデータ、またはプロバイダーパラメータを更新します。設定が変更された場合は、同期を開始することもできます。

name、status、uri、metadata、providerParameters のうち少なくとも 1 つを送信してください。expectedVersion と syncAfterUpdate だけのリクエストは拒否されます。

同期の開始と追跡の方法については、ソースの同期とスケジュール設定を参照してください。

1 min read

patch/knowledge-fs/spaces/{knowledge_base_id}/sources/{source_id}

Request example

curl --request PATCH \
  --url https://api.dify.ai/v1/knowledge-fs/spaces/{knowledge_base_id}/sources/{source_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "expectedVersion": 7,
  "name": "Docs site (v2)",
  "status": "active",
  "syncAfterUpdate": true,
  "uri": "https://docs.example.com/v2"
}'

import requests

url = "https://api.dify.ai/v1/knowledge-fs/spaces/{knowledge_base_id}/sources/{source_id}"
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json",
}
payload = {
    "expectedVersion": 7,
    "name": "Docs site (v2)",
    "status": "active",
    "syncAfterUpdate": True,
    "uri": "https://docs.example.com/v2"
}

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}/sources/{source_id}', {
  method: 'PATCH',
  headers: {
    'Authorization': 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    "expectedVersion": 7,
    "name": "Docs site (v2)",
    "status": "active",
    "syncAfterUpdate": true,
    "uri": "https://docs.example.com/v2"
  })
});

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}/sources/{source_id}',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST => 'PATCH',
  CURLOPT_POSTFIELDS => '{
  "expectedVersion": 7,
  "name": "Docs site (v2)",
  "status": "active",
  "syncAfterUpdate": true,
  "uri": "https://docs.example.com/v2"
}',
  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}/sources/{source_id}"
	payload := strings.NewReader("{\n  \"expectedVersion\": 7,\n  \"name\": \"Docs site (v2)\",\n  \"status\": \"active\",\n  \"syncAfterUpdate\": true,\n  \"uri\": \"https://docs.example.com/v2\"\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}/sources/{source_id}"))
    .header("Authorization", "Bearer <token>")
    .header("Content-Type", "application/json")
    .method("PATCH", HttpRequest.BodyPublishers.ofString("{\n  \"expectedVersion\": 7,\n  \"name\": \"Docs site (v2)\",\n  \"status\": \"active\",\n  \"syncAfterUpdate\": true,\n  \"uri\": \"https://docs.example.com/v2\"\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}/sources/{source_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 = '{
  "expectedVersion": 7,
  "name": "Docs site (v2)",
  "status": "active",
  "syncAfterUpdate": true,
  "uri": "https://docs.example.com/v2"
}'

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

Response

{
  "connection_id": "c3d4e5f6-7a8b-4c9d-8e0f-1a2b3c4d5e6f",
  "created_at": "2026-09-01T08:00:00Z",
  "credential_configured": null,
  "id": "6f1c2b0e-3d0b-4a5e-9f4c-1c0e6a7b8d90",
  "knowledge_space_id": "0a9d3c2e-5b6f-4e1a-8c7d-2f3e4a5b6c7d",
  "last_synced_at": null,
  "metadata": {
    "client_request_id": "source-20260907-0001",
    "parameters": {
      "url": "https://docs.example.com/v2"
    },
    "providerKind": "website",
    "tenantId": "2f1e0d9c-8b7a-4695-8473-2a1b0c9d8e7f"
  },
  "name": "Docs site (v2)",
  "permission_scope": [],
  "status": "active",
  "sync_policy": null,
  "sync_workflow": {
    "canceled_at": null,
    "checkpoint": "queued",
    "completed_at": null,
    "created_at": "2026-09-06T02:00:00Z",
    "cursor": null,
    "execution_attempts": 0,
    "failure": null,
    "id": "d4c3b2a1-6f5e-4d7c-8b9a-0f1e2d3c4b5a",
    "kind": "sync",
    "knowledge_space_id": "0a9d3c2e-5b6f-4e1a-8c7d-2f3e4a5b6c7d",
    "last_error_code": null,
    "max_execution_attempts": 5,
    "progress_completed": 0,
    "progress_failed": 0,
    "progress_skipped": 0,
    "progress_total": null,
    "source_id": "6f1c2b0e-3d0b-4a5e-9f4c-1c0e6a7b8d90",
    "state": "queued",
    "updated_at": "2026-09-06T02:00:00Z"
  },
  "type": "web",
  "updated_at": "2026-09-06T02:00:00Z",
  "uri": "https://docs.example.com/v2",
  "version": 8
}

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

{
  "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"
  },
  "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"
  },
  "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"
  },
  "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": "SOURCE_VERSION_CONFLICT",
    "message": "The Agent Knowledge Base operation conflicts with the current resource state.",
    "retryPolicy": "manual",
    "traceId": "5e2a9c17-3b4d-4f60-8a1b-2c3d4e5f6a7b"
  },
  "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",
  "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}/sources/{source_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/ の後のセグメントです。

source_idstringrequired#

ソース ID です。ソース一覧を取得から取得します。

Body

application/json

Any of

metadataobjectrequired#

Responses

application/json

更新されたソースです。

connection_idstring#

ソースが認証情報の取得に使用する接続です。別のソースを同じ接続に紐付ける場合は、connectionId として渡します。紐付けられていない場合は null です。

created_atstring#

作成日時（ISO 8601）です。

credential_configuredboolean#

ソースが独自の認証情報の参照を保持している場合は true です。接続に紐付けられたソースのように参照を保持していない場合は null です。

idstring#

ソース ID です。

knowledge_space_idstring#

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

last_synced_atstring#

直近に完了した同期（completed または zero_results）またはインポートの完了日時です。ソース一覧を取得でのみ設定されます。それ以外の操作、およびソースが一度も同期されていない場合は null です。

metadataobject#

プロバイダーの設定と、サーバーが管理する同期データまたはページ選択データです。プロバイダーの識別子や parameters が含まれる場合があります。接続側で管理される設定は、ここに含まれるとは限りません。認証情報に類するキーは除去されます。別のソースを作成する際に、このオブジェクト全体をコピーしないでください。

namestring#

表示名です。

permission_scopestring[]#

このソースを読み取るために必要なコンテンツのアクセス範囲です。空のリストの場合、ナレッジベース内でのコンテンツの制限は追加されません。ナレッジベースの認可は引き続き適用されます。

statusstring#

active、syncing、error、disabled のいずれかです。ほとんどの操作は保存されている値を返します。ソース一覧を取得は、直近の同期の実行から値を導き出します：

failed または canceled の実行：error
completed または zero_results の実行：active
進行中の実行：syncing

disabled が上書きされることはありません。

sync_policyobject#

ソースの同期スケジュールです。ソース一覧を取得でのみ設定されます。それ以外の操作、およびスケジュールがない場合は null です。単独で取得するには同期ポリシーを取得、変更するには同期ポリシーを更新を使用します。

Show child attributes

created_atstring#

作成日時（ISO 8601）です。

custom_interval_secondsinteger#

mode: custom の場合の間隔（秒）です。ほかのモードでは null です。

enabledboolean#

スケジュール同期を実行するかどうかです。mode: manual では常に false です。

expected_source_versioninteger#

スケジュールが紐付いているソースの version です。

idstring#

同期ポリシー ID です。更新しても変わりません。

knowledge_space_idstring#

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

modestring#

manual（スケジュールなし）、interval（24 時間ごと）、custom（custom_interval_seconds ごと）のいずれかです。

next_run_atstring#

次回のスケジュール同期の予定日時（ISO 8601）です。予定がない場合は null です。

revisioninteger#

スケジュールのリビジョンです。同期ポリシーを更新で expectedRevision として送信します。更新のたび、およびスケジュール同期が開始されるたびに増加します。

source_idstring#

スケジュールが属するソースです。

updated_atstring#

最終更新日時（ISO 8601）です。スケジュール同期が開始されたときにも更新されます。

sync_workflowobject#

ソースで進行中の同期またはインポートの実行（crawl-import、online-document-import、online-drive-import）です。進行中の実行がない場合は、直近の同期の実行です。ソース一覧を取得は、実行が進行中か、ソースより新しい場合に設定します。ソースを更新は、その呼び出しで同期が開始された場合に設定します。それ以外の場合は null です。クロールプレビューと、そこからのインポートはここに表示されません。

個々の実行を追跡するには、その id を指定してソースの実行を取得を呼び出します。

Show child attributes

canceled_atstring#

実行がキャンセルされた日時です。state が canceled でない場合は null です。

checkpointstring#

実行が到達した最後のステップで、queued、provider-read、preview-staged、selection-frozen、materialized、cleanup-staging、source-committed のいずれかです。ソースの実行を再試行は、チェックポイントにかかわらず実行を最初からやり直します。

completed_atstring#

実行が completed、zero_results、failed、canceled のいずれかで終了した日時（ISO 8601）です。実行中は null です。

created_atstring#

作成日時（ISO 8601）です。

cursorstring#

実行の再開位置となるプロバイダーのカーソルです。実行がページ送りをしていない場合は null です。

execution_attemptsinteger#

ワーカーが実行を取得した回数です。ソースの実行を再試行の後の取得も含み、再試行してもリセットされません。

failureobject#

state が failed の場合のエラー詳細です。stage は失敗時点の実行の checkpoint、traceId は実行 ID です。それ以外の場合は 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 エラーのボディでは省略されることがあります。

idstring#

実行 ID です。ソースの実行を取得、ソースの実行をキャンセル、ソースの実行を再試行に渡します。

kindstring#

実行の処理内容です：

sync：ソースを同期、ソースを更新、スケジュール、または Dify によって開始されます。
crawl-preview：ウェブサイトのクロールをプレビューによって開始されます。選択したページをインポートがこの実行からインポートしている間も、種類は変わりません。
crawl-import：ウェブサイトのページをインポートによって開始されます。
online-document-import、online-drive-import：ソースのアイテムをインポートによって開始されます。

Dify でソースを追加または編集した場合も、Dify がプレビューとインポートを開始します。

knowledge_space_idstring#

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

last_error_codestring#

state が failed の場合は failure.code の値です。それ以外の場合は null です。

max_execution_attemptsinteger#

execution_attempts の上限です。上限に達すると、ソースの実行を再試行は 409 を返します。

progress_completedinteger#

完了したアイテム数です。同期で確認された未変更のアイテムも含みます。

progress_failedinteger#

ソースの実行では常に 0 です。1 つのアイテムが失敗すると、実行全体が失敗するためです。

progress_skippedinteger#

ソースの実行では常に 0 です。

progress_totalinteger#

実行が処理する予定のアイテム数です。インポートではリクエストされたページまたはアイテム、クロールプレビューではこれまでに一時保存されたページ、同期では一覧の取得後のソースのアイテムを数えます。判明するまでは null です。

ウェブサイトのページをインポートの実行が URL をクロールしている間は、progress_completed と progress_total のどちらも、それまでにクロールしたページ数を数えます。すべての URL のクロールが終わると、URL の数を総数として 0 から数え直します。

source_idstring#

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

statestring#

実行の進行状況です。

進行中の状態：

queued：ワーカー待ち
crawling：クロールプレビューによるページの取得中
preview_ready：クロールプレビューが選択したページをインポートまたはソースの実行をキャンセルを待機中
importing：アイテムのインポートとインデックス処理中
syncing：ソースのドキュメントを更新中

最終状態：

completed：すべてのアイテムのインポートまたは更新、インデックス処理、アクティブ化が完了
zero_results：クロールプレビューで見つかったページが 0 件
failed：failure を参照
canceled

failed または canceled の後は、ソースの実行を再試行で再実行でき、ソースを同期で新しい同期を開始できます。

updated_atstring#

最終更新日時（ISO 8601）です。

typestring#

web（ウェブサイトのクロール）、connector（オンラインドキュメントまたはオンラインドライブ）、upload、object-storage のいずれかです。

connector ソースでは、metadata.providerKind は online-document または online-drive です。web ソースでは website です。

upload と object-storage のソースには、Dify が内容を追加します。

updated_atstring#

最終更新日時（ISO 8601）です。

uristring#

web ソースでは、クロールのルート URL です。Dify で作成されたコネクタソースでは connector://<connection_id> です。

versioninteger#

ソースのバージョンで、書き込みのたびに増加します。ソースを更新では expectedVersion、ソースを削除では expectedRevision、同期ポリシーを更新では expectedSourceVersion として送信します。

ソースを取得ソースを削除