Dify 提供了一套完整的知识库 API,可以通过编程方式管理知识库、文档和分段。这对于自动化数据同步或将知识库操作集成到 CI/CD 流程中非常有用。
创建知识库时,API 访问默认开启。要开始调用 API,你只需要 API 凭据:一个端点和一个密钥。
单个知识库 API 密钥可以访问同一账号下的所有可见知识库。请妥善保管凭据,避免意外的数据泄露。
获取 API 端点和密钥
在 Dify 中进入知识库页面。点击右上角的 服务 API 打开 API 配置面板。在这里你可以:
-
获取服务 API 端点,即所有知识库 API 请求的基础 URL。
-
点击 API 密钥 创建新密钥并管理已有密钥。
请将 API 密钥安全存储在服务端,切勿在客户端代码或公开仓库中暴露。
管理知识库的 API 访问权限
每个知识库默认都可通过服务 API 访问。
如果需要限制某个知识库的 API 访问,打开该知识库,点击左下角的 访问 API 并将其关闭。
API 参考
有关完整的端点列表、请求/响应结构、错误码和交互式示例,请参阅知识库 API 参考。