本文档由 AI 自动翻译。如有任何不准确之处,请参考 英文原版。
在 Dify 中发布的每个应用都同时是一个 REST API,知识库也是如此。你可在自己的后端用 API 密钥调用终端用户所使用的同一个应用。
获取 API 密钥
只在后端调用 API。嵌入前端代码或客户端应用中的密钥可能被提取和滥用。
-
应用密钥:在应用内部创建 API 密钥。该密钥仅作用于这一个应用,且一个密钥可服务你的所有终端用户。
调用时以每人各自的 user 值区分不同的人。详见 终端用户身份。
-
知识库密钥:打开 知识库 页面,点击右上角的 服务 API。
知识库密钥的权限范围更大,可访问创建该密钥的账户下所有可见的知识库,需格外妥善保管。详见 知识库 API。
发起第一个请求
每个请求都通过 Bearer 令牌携带密钥。Dify Cloud 的基础 URL 为 https://api.dify.ai/v1;自部署时,替换为你实例的 API 基础 URL。
最快的第一个请求无需写代码:打开 获取应用基本信息,点击 试一试,把密钥粘贴到 Authorization 字段,再按 发送。它适用于所有应用类型。
在终端中发起同样的调用:
curl https://api.dify.ai/v1/info \
-H "Authorization: Bearer $DIFY_API_KEY"
收到如下响应即说明密钥有效,同时能看到它所属的应用:
{
"name": "My Chat App",
"description": "A helpful assistant",
"tags": ["assistant"],
"mode": "chat",
"author_name": "Dify Team"
}
如果你用的是知识库 API 密钥,其接口属于另一组,第一个请求可改试 获取知识库列表。
找到你的应用类型对应的接口
每种应用类型的完整 API 见其概览页: