更新同步策略

设置数据源的定时同步，替换原有设置，并返回新设置。

保存不会启动同步。第一次定时同步在更新后满一个间隔时到期，之后每次在上一次进入队列后满一个间隔时到期。要立即同步，调用同步数据源。

每次向该数据源导入完成后，都要用数据源新的 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 Key 认证：Authorization: Bearer {API_KEY}。应用接口使用应用 API Key，知识库接口使用知识库 API Key（快速开始）。

API Key 应保存在服务端，切勿嵌入客户端代码。缺失或无效的 Key 会返回 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 格式。定时同步开始时也会更新。

获取同步策略同步数据源