获取知识库列表

get/datasets

Request example

curl --request GET \
  --url https://api.dify.ai/v1/datasets \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.dify.ai/v1/datasets"
headers = {
    "Authorization": "Bearer <token>",
}

response = requests.request("GET", url, headers=headers)

print(response.text)

const response = await fetch('https://api.dify.ai/v1/datasets', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer <token>'
  }
});

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

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => 'https://api.dify.ai/v1/datasets',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST => 'GET',
  CURLOPT_HTTPHEADER => [
    'Authorization: Bearer <token>',
  ],
]);

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

echo $response;

package main

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

func main() {
	url := "https://api.dify.ai/v1/datasets"

	req, _ := http.NewRequest("GET", url, nil)
	req.Header.Add("Authorization", "Bearer <token>")

	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/datasets"))
    .header("Authorization", "Bearer <token>")
    .method("GET", HttpRequest.BodyPublishers.noBody())
    .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/datasets')

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

request = Net::HTTP::Get.new(url)
request['Authorization'] = 'Bearer <token>'

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

Response

{
  "data": [
    {
      "app_count": 0,
      "author_name": "admin",
      "built_in_field_enabled": true,
      "chunk_structure": null,
      "created_at": 1741267200,
      "created_by": "ad313dd6-ef04-4dd1-a5b0-c0f0b9e2e7e4",
      "data_source_type": null,
      "description": "产品 API 技术文档",
      "doc_form": "text_model",
      "doc_metadata": [],
      "document_count": 0,
      "embedding_available": true,
      "embedding_model": "text-embedding-3-small",
      "embedding_model_provider": "langgenius/openai/openai",
      "enable_api": true,
      "external_knowledge_info": null,
      "external_retrieval_model": null,
      "icon_info": null,
      "id": "c42e2a6e-40b3-4330-96f8-f1e4d768e8c9",
      "indexing_technique": "high_quality",
      "is_multimodal": false,
      "is_published": false,
      "maintainer": "admin",
      "name": "Product Documentation",
      "permission": "only_me",
      "pipeline_id": null,
      "provider": "vendor",
      "retrieval_model_dict": {
        "reranking_enable": false,
        "reranking_mode": null,
        "reranking_model": {
          "reranking_model_name": "",
          "reranking_provider_name": ""
        },
        "score_threshold": null,
        "score_threshold_enabled": false,
        "search_method": "semantic_search",
        "top_k": 3,
        "weights": null
      },
      "runtime_mode": null,
      "summary_index_setting": null,
      "tags": [],
      "total_available_documents": 0,
      "total_documents": 0,
      "updated_at": 1741267200,
      "updated_by": "ad313dd6-ef04-4dd1-a5b0-c0f0b9e2e7e4",
      "word_count": 0
    }
  ],
  "has_more": false,
  "limit": 20,
  "page": 1,
  "total": 1
}

{
  "code": "forbidden",
  "message": "The API key is not authorized to access this knowledge base.",
  "status": 403
}

get/datasets

Authorization

Authorizationstringheaderrequired#

每个请求都通过 API Key 认证：Authorization: Bearer {API_KEY}。应用接口使用应用 API Key，知识库接口使用知识库 API Key（快速开始）。

API Key 应保存在服务端，切勿嵌入客户端代码。缺失或无效的 Key 会返回 HTTP 401（unauthorized）。

Query parameters

pageinteger#

页码。

Default: 1

limitinteger#

每页条目数。服务器上限为 100。

Default: 20

keywordstring#

按名称筛选的搜索关键词。

include_allboolean#

是否包含所有知识库，无论权限如何。

Default: false

tag_idsstring[]#

用于筛选的标签 ID。标签 ID 从获取知识库标签列表获取。

Responses

application/json

知识库列表。

dataobject[]#

知识库对象数组。

Show child attributes

app_countinteger#

当前使用该知识库的应用数量。

author_namestring#

创建者的显示名称。

built_in_field_enabledboolean#

是否启用内置元数据字段（例如 document_name、uploader）。

chunk_structurestring#

分段结构配置。

created_atnumber#

创建时间戳（Unix 纪元，单位为秒）。

created_bystring#

创建该知识库的用户 ID。

data_source_typestring#

文档的数据源类型，尚未配置时为 null。

descriptionstring#

描述知识库用途或内容的可选文本。

doc_formstring#

文档分块模式。text_model 表示标准文本分块，hierarchical_model 表示父子结构，qa_model 表示问答对提取。

doc_metadataobject[]#

知识库的元数据字段定义。

Show child attributes

idstring#

元数据字段标识符。

namestring#

元数据字段名称。

typestring#

元数据字段值类型。

document_countinteger#

知识库中的文档总数。

embedding_availableboolean#

配置的嵌入模型当前是否可用。

embedding_modelstring#

用于索引的嵌入模型名称。

embedding_model_providerstring#

嵌入模型供应商标识符，格式为 organization/plugin_name/provider_name（例如 langgenius/openai/openai）。旧版知识库可能返回简写形式（例如 openai）。

enable_apiboolean#

该知识库是否启用 API 访问。

external_knowledge_infoobject#

外部知识库的连接详情。当 provider 为 external 时存在。

Show child attributes

external_knowledge_api_endpointstring#

外部知识库 API 的端点 URL。

external_knowledge_api_idstring#

外部知识库 API 连接的 ID。

external_knowledge_api_namestring#

外部知识库 API 的显示名称。

external_knowledge_idstring#

外部知识库的 ID。

external_retrieval_modelobject#

外部知识库的检索设置。内部知识库时为 null。

Show child attributes

score_thresholdnumber#

最低相关性得分阈值。

score_threshold_enabledboolean#

是否启用分数阈值过滤。

top_kinteger#

从外部知识库返回的最大结果数量。

icon_infoobject#

知识库的图标显示配置。

Show child attributes

iconstring#

图标标识符或表情符号。

icon_backgroundstring#

图标的背景颜色。

icon_typestring#

图标类型。

icon_urlstring#

自定义图标图片的 URL。

idstring#

知识库的唯一标识符。

indexing_techniquestring#

high_quality 使用嵌入模型进行精确搜索；economy 使用基于关键词的索引。

is_multimodalboolean#

是否启用多模态内容处理。

is_publishedboolean#

知识库是否已发布。

maintainerstring#

知识库维护者的显示名称。未设置时为 null。

namestring#

知识库的显示名称。在工作区内唯一。

partial_member_liststring[]#

当 permission 为 partial_members 时被授予访问权限的成员账户 ID。更新响应中始终返回；详情响应中仅当 permission 为 partial_members 时返回。

permissionstring#

控制谁可以访问此知识库。可选值：only_me、all_team_members、partial_members。

pipeline_idstring#

自定义处理流水线的 ID（如果已配置）。

providerstring#

供应商类型。内部管理为 vendor，外部知识库连接为 external。

retrieval_model_dictobject#

知识库的检索配置。

Show child attributes

reranking_enableboolean#

是否启用重排序。

reranking_modestring#

重排序模式。reranking_model 表示基于模型的重排序，weighted_score 表示基于分数的加权。重排序禁用时为 null。

reranking_modelobject#

重排序模型配置。

Show child attributes

reranking_model_namestring#

重排序模型名称。

reranking_provider_namestring#

重排序模型供应商标识符，格式为 organization/plugin_name/provider_name（例如 langgenius/cohere/cohere）。旧版知识库可能返回简写形式（例如 cohere）。

score_thresholdnumber#

结果的最低相关性分数。仅在 score_threshold_enabled 为 true 时生效。

score_threshold_enabledboolean#

是否启用分数阈值过滤。

search_methodstring#

用于检索的搜索方式。keyword_search 表示关键词匹配，semantic_search 表示基于嵌入的语义相似度，full_text_search 表示全文索引，hybrid_search 表示语义和关键词混合搜索。

top_kinteger#

返回的最大结果数。

weightsobject#

混合搜索的权重配置。

Show child attributes

keyword_settingobject#

关键词搜索权重设置。

Show child attributes

keyword_weightnumber#

分配给关键词搜索结果的权重。

vector_settingobject#

语义搜索权重设置。

Show child attributes

embedding_model_namestring#

用于向量搜索的嵌入模型名称。

embedding_provider_namestring#

用于向量搜索的嵌入模型供应商。

vector_weightnumber#

分配给语义（向量）搜索结果的权重。

weight_typestring#

平衡语义搜索和关键词搜索权重的策略。

runtime_modestring#

运行时处理模式。

summary_index_settingobject#

摘要索引配置。

Show child attributes

enableboolean#

是否已启用摘要索引。

model_namestring#

用于生成摘要的模型名称。

model_provider_namestring#

摘要生成模型的供应商。

summary_promptstring#

用于摘要生成的提示词模板。

tagsobject[]#

与该知识库关联的标签。

Show child attributes

idstring#

标签标识符。

namestring#

Tag name.

typestring#

标签类型。知识库标签始终为 knowledge。

total_available_documentsinteger#

已启用且可用的文档数量。

total_documentsinteger#

文档总数。

updated_atnumber#

最后更新时间戳（Unix 纪元，单位为秒）。

updated_bystring#

最后更新该知识库的用户 ID。

word_countinteger#

所有文档的总字数。

has_moreboolean#

下一页是否还有更多项目。

limitinteger#

每页条目数。

pageinteger#

当前页码。

totalinteger#

匹配条目的总数。

创建空知识库获取知识库详情