创建数据源

添加一个通过现有连接读取内容的数据源，连接可通过获取数据源连接列表查找。此操作不会抓取或导入任何内容。

重复一次已成功的创建请求，会再创建一个数据源。添加唯一的 metadata.client_request_id，并保留到拿到数据源 ID 为止。

要为数据源填充内容，web 数据源调用预览网站抓取或导入网站页面，connector 数据源调用导入数据源条目。具体步骤详见添加数据源。

1 min read

post/knowledge-fs/spaces/{knowledge_base_id}/sources

Request example

curl --request POST \
  --url https://api.dify.ai/v1/knowledge-fs/spaces/{knowledge_base_id}/sources \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "connectionId": "c3d4e5f6-7a8b-4c9d-8e0f-1a2b3c4d5e6f",
  "metadata": {
    "client_request_id": "source-20260907-0001",
    "providerKind": "website"
  },
  "name": "Docs site",
  "permissionScope": [],
  "status": "disabled",
  "type": "web",
  "uri": "https://docs.example.com"
}'

import requests

url = "https://api.dify.ai/v1/knowledge-fs/spaces/{knowledge_base_id}/sources"
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json",
}
payload = {
    "connectionId": "c3d4e5f6-7a8b-4c9d-8e0f-1a2b3c4d5e6f",
    "metadata": {
        "client_request_id": "source-20260907-0001",
        "providerKind": "website"
    },
    "name": "Docs site",
    "permissionScope": [],
    "status": "disabled",
    "type": "web",
    "uri": "https://docs.example.com"
}

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

print(response.text)

const response = await fetch('https://api.dify.ai/v1/knowledge-fs/spaces/{knowledge_base_id}/sources', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    "connectionId": "c3d4e5f6-7a8b-4c9d-8e0f-1a2b3c4d5e6f",
    "metadata": {
      "client_request_id": "source-20260907-0001",
      "providerKind": "website"
    },
    "name": "Docs site",
    "permissionScope": [],
    "status": "disabled",
    "type": "web",
    "uri": "https://docs.example.com"
  })
});

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',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST => 'POST',
  CURLOPT_POSTFIELDS => '{
  "connectionId": "c3d4e5f6-7a8b-4c9d-8e0f-1a2b3c4d5e6f",
  "metadata": {
    "client_request_id": "source-20260907-0001",
    "providerKind": "website"
  },
  "name": "Docs site",
  "permissionScope": [],
  "status": "disabled",
  "type": "web",
  "uri": "https://docs.example.com"
}',
  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"
	payload := strings.NewReader("{\n  \"connectionId\": \"c3d4e5f6-7a8b-4c9d-8e0f-1a2b3c4d5e6f\",\n  \"metadata\": {\n    \"client_request_id\": \"source-20260907-0001\",\n    \"providerKind\": \"website\"\n  },\n  \"name\": \"Docs site\",\n  \"permissionScope\": [],\n  \"status\": \"disabled\",\n  \"type\": \"web\",\n  \"uri\": \"https://docs.example.com\"\n}")

	req, _ := http.NewRequest("POST", 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"))
    .header("Authorization", "Bearer <token>")
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.ofString("{\n  \"connectionId\": \"c3d4e5f6-7a8b-4c9d-8e0f-1a2b3c4d5e6f\",\n  \"metadata\": {\n    \"client_request_id\": \"source-20260907-0001\",\n    \"providerKind\": \"website\"\n  },\n  \"name\": \"Docs site\",\n  \"permissionScope\": [],\n  \"status\": \"disabled\",\n  \"type\": \"web\",\n  \"uri\": \"https://docs.example.com\"\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')

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

request = Net::HTTP::Post.new(url)
request['Authorization'] = 'Bearer <token>'
request['Content-Type'] = 'application/json'
request.body = '{
  "connectionId": "c3d4e5f6-7a8b-4c9d-8e0f-1a2b3c4d5e6f",
  "metadata": {
    "client_request_id": "source-20260907-0001",
    "providerKind": "website"
  },
  "name": "Docs site",
  "permissionScope": [],
  "status": "disabled",
  "type": "web",
  "uri": "https://docs.example.com"
}'

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

Response

{
  "connection_id": "c3d4e5f6-7a8b-4c9d-8e0f-1a2b3c4d5e6f",
  "created_at": "2026-09-06T01:30: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",
    "providerKind": "website",
    "tenantId": "2f1e0d9c-8b7a-4695-8473-2a1b0c9d8e7f"
  },
  "name": "Docs site",
  "permission_scope": [],
  "status": "disabled",
  "sync_policy": null,
  "sync_workflow": null,
  "type": "web",
  "updated_at": "2026-09-06T01:30:00Z",
  "uri": "https://docs.example.com",
  "version": 1
}

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

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

post/knowledge-fs/spaces/{knowledge_base_id}/sources

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/ 之后的那一段。

Body

application/json

connectionIdstring#

为数据源提供读取凭据的连接。必须属于此知识库，且处于 active 状态。取自获取数据源连接列表返回的 id。

metadataobject#

提供商设置，以及你自己的非敏感元数据。添加唯一的 client_request_id，可在创建响应丢失时识别出此数据源。该值会随数据源一起返回，但 API 不校验其唯一性，也不会对请求去重。

将 providerKind 设为连接的 configuration.providerKind，并选择与之匹配的数据源 type。来自连接的设置可能不会出现在数据源响应中。

如果基于现有数据源的响应构造 metadata，需去掉以 __knowledgeFs 开头的字段、credentials 以及 parameters 对象。credentialId 若存在，指向 Dify 保存的凭据。

namestringrequired#

显示名称。

Length: 1–200

permissionScopestring[]#

留空或省略。仅接受空列表。

Items: max 0

statusenum<string>#

disabled 会暂停定时同步。

Default: "active"

Options:activedisablednull

typeenum<string>required#

网站抓取传 web，在线文档或在线云盘提供商传 connector（并设置 metadata.providerKind）。upload 和 object-storage 用于由 Dify 填充内容的数据源。

Options:connectorobject-storageuploadweb

uristringrequired#

web 数据源填抓取的根 URL。connector 数据源填 connector://<connectionId>，与 Dify 写入的格式一致。

Length: 1–4096

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：任一项失败都会导致整个运行失败。

progress_skippedinteger#

数据源运行始终为 0。

progress_totalinteger#

运行预计处理的项数：导入请求的页面或条目数、抓取预览目前已暂存的页面数，或同步列出数据源条目后的条目数。确定之前为 null。

导入网站页面的运行抓取 URL 期间，progress_completed 和 progress_total 都统计目前已抓取的页面数。所有 URL 抓取完成后，进度从 0 重新开始计，总数变为 URL 的数量。

source_idstring#

运行所属的数据源。

statestring#

运行的进度。

进行中的状态：

queued：等待工作进程处理
crawling：抓取预览正在获取页面
preview_ready：抓取预览正在等待导入所选页面或取消数据源运行
importing：正在导入并索引条目
syncing：正在刷新数据源的文档

终态：

completed：所有条目均已导入或刷新、完成索引并生效
zero_results：抓取预览未找到任何页面
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 传入。

获取数据源连接列表获取数据源列表