同期ポリシーを更新

ソースの同期スケジュールを設定し、設定したスケジュールを返します。以前のスケジュールは置き換えられます。

保存しても同期は開始されません。最初のスケジュール同期は、更新から設定した間隔が経過した時点で実行予定になります。以降の同期は、前回の同期がキューに入ってから同じ間隔が経過した時点で実行予定になります。すぐに同期するには、ソースを同期を呼び出してください。

このソースへのインポートが完了するたびに、ソースの新しい version でスケジュールを保存し直してください。インポートすると version が変わり、古い値に紐づいたままのスケジュールは、次の予定時刻に自動でオフになります。

スケジュールを変えずにスケジュール同期を一時停止するには、ソースを更新でソースの status を disabled に設定します。停止中に実行予定になった同期は、ソースを active に戻した時点で実行されます。

読み取ってから保存する流れについては、ソースの同期とスケジュール設定を参照してください。

1 min read

put/knowledge-fs/spaces/{knowledge_base_id}/sources/{source_id}/sync-policy

Request example

curl --request PUT \
  --url https://api.dify.ai/v1/knowledge-fs/spaces/{knowledge_base_id}/sources/{source_id}/sync-policy \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "customIntervalSeconds": 21600,
  "enabled": true,
  "expectedRevision": 5,
  "expectedSourceVersion": 8,
  "mode": "custom"
}'

import requests

url = "https://api.dify.ai/v1/knowledge-fs/spaces/{knowledge_base_id}/sources/{source_id}/sync-policy"
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json",
}
payload = {
    "customIntervalSeconds": 21600,
    "enabled": True,
    "expectedRevision": 5,
    "expectedSourceVersion": 8,
    "mode": "custom"
}

response = requests.request("PUT", 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}/sync-policy', {
  method: 'PUT',
  headers: {
    'Authorization': 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    "customIntervalSeconds": 21600,
    "enabled": true,
    "expectedRevision": 5,
    "expectedSourceVersion": 8,
    "mode": "custom"
  })
});

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}/sync-policy',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST => 'PUT',
  CURLOPT_POSTFIELDS => '{
  "customIntervalSeconds": 21600,
  "enabled": true,
  "expectedRevision": 5,
  "expectedSourceVersion": 8,
  "mode": "custom"
}',
  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}/sync-policy"
	payload := strings.NewReader("{\n  \"customIntervalSeconds\": 21600,\n  \"enabled\": true,\n  \"expectedRevision\": 5,\n  \"expectedSourceVersion\": 8,\n  \"mode\": \"custom\"\n}")

	req, _ := http.NewRequest("PUT", 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}/sync-policy"))
    .header("Authorization", "Bearer <token>")
    .header("Content-Type", "application/json")
    .method("PUT", HttpRequest.BodyPublishers.ofString("{\n  \"customIntervalSeconds\": 21600,\n  \"enabled\": true,\n  \"expectedRevision\": 5,\n  \"expectedSourceVersion\": 8,\n  \"mode\": \"custom\"\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}/sync-policy')

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

request = Net::HTTP::Put.new(url)
request['Authorization'] = 'Bearer <token>'
request['Content-Type'] = 'application/json'
request.body = '{
  "customIntervalSeconds": 21600,
  "enabled": true,
  "expectedRevision": 5,
  "expectedSourceVersion": 8,
  "mode": "custom"
}'

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

Response

{
  "created_at": "2026-09-01T08:05:00Z",
  "custom_interval_seconds": 21600,
  "enabled": true,
  "expected_source_version": 8,
  "id": "8e7d6c5b-4a39-4f28-9e17-0d1c2b3a4f5e",
  "knowledge_space_id": "0a9d3c2e-5b6f-4e1a-8c7d-2f3e4a5b6c7d",
  "mode": "custom",
  "next_run_at": "2026-10-21T08:30:00Z",
  "revision": 6,
  "source_id": "6f1c2b0e-3d0b-4a5e-9f4c-1c0e6a7b8d90",
  "updated_at": "2026-10-21T02:30:00Z"
}

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

{
  "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_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": "KNOWLEDGE_FS_CONFLICT",
    "message": "The Agent Knowledge Base operation conflicts with the current resource state.",
    "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_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
}

put/knowledge-fs/spaces/{knowledge_base_id}/sources/{source_id}/sync-policy

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

customIntervalSecondsinteger#

スケジュール同期の間隔（秒）です。1 時間から 30 日までの範囲で指定します。mode: custom では必須で、ほかのモードでは拒否されます。

Range: 3600–2592000

enabledbooleanrequired#

スケジュール同期を実行するかどうかです。mode: manual では false にする必要があります。

expectedRevisionintegerrequired#

同期ポリシーを取得で取得した、スケジュールの現在の revision です。ソースにまだスケジュールがない場合は 0 を送信します。リビジョンはスケジュール同期が開始されるたびにも増えるため、更新の直前に読み取ってください。古い値を送ると 409 が返り、何も変更されません。

Range: >= 0

expectedSourceVersionintegerrequired#

ソースを取得またはソース一覧を取得で取得した、ソースの現在の version です。この値はソースを更新を呼び出すたび、またインポートが完了するたびに変わるため、更新の直前に読み取ってください。古い値を送ると 409 が返り、何も変更されません。

Range: >= 1

modeenum<string>required#

manual はスケジュール同期をオフにし、interval は 24 時間ごと、custom は customIntervalSeconds ごとに同期します。

Options:manualintervalcustom

Responses

application/json

保存されたスケジュールです。mode: manual または enabled: false の場合、next_run_at は null です。

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）です。スケジュール同期が開始されたときにも更新されます。

同期ポリシーを取得ソースを同期