API 文档介绍

从 4.15.0 开始，FastGPT API 文档均采用 zod-openapi 自动生成的方式。可通过访问 API 文档地址查看最新的接口情况，该文档里左侧手动编辑的接口说明不再更新。

FastGPT API 文档一共分成两套：

• Dev API: 所有开发的 API，不一定能通过 ApiKey 调用。
• System OpenAPI: 系统所有开放的接口，可以通过系统 ApiKey 调用。

API 文档地址

endpoint 是你的 FastGPT 访问地址，拼上对应 path 即可打开文档。

• Dev API: {{endpoint}}/apidoc/devapi
• System OpenAPI: {{endpoint}}/apidoc/systemopenapi

云服务 API 文档地址

Dev API:

• 中国大陆版文档
• 国际版文档

System OpenAPI

• 中国大陆版文档
• 国际版文档

使用说明

FastGPT OpenAPI 接口允许你使用 API Key 进行鉴权，从而操作 FastGPT 上的相关服务和资源，例如：调用应用对话接口、上传知识库数据、搜索测试等等。出于兼容性和安全考虑，并不是所有的接口都允许通过 API Key 访问。

如何获取 API Key

系统里有两个地方可看到 API 密钥

1. 在 账号 - Api 密钥 中获取
2. 在 应用 - 发布渠道 - API 访问 里查看。

API 密钥可用范围

API 密钥相当于当前账号，在当前团队下的访问凭证。也就是，在该团队下有权限的资源，都可以通过 API 密钥进行操作。

密钥使用规范

• 使用 API Key 鉴权。调用 chat/completions 时，推荐在请求体中传入 appId。
• 为兼容 OpenAI SDK，也支持 Authorization: Bearer <apiKey>-<appId>，此时可以不传 body.appId。
• appId 的优先级为：body.appId > <apiKey>-<appId> 中的 appId > API Key 关联的 appId（旧版兼容）。
• 部分 SDK 需要在 BaseURL 后添加 v1 路径。如果出现 404，可补充 v1 后重试。
• 如需通过 authProxy 代理团队成员身份，需要团队所有者在创建或编辑密钥时开启 authProxy；代理身份仍需具备目标应用和会话的访问权限。（FastGPT >= v4.15.0）

如何获取应用 ID（appId）

打开应用详情，可在浏览器地址栏的 URL 中获取 appId。

如何获取知识库 ID 和文件集合 ID

知识库 ID（datasetId）	文件集合 ID（collectionId）

基本配置

OpenAPI 中，所有的接口都通过 Header.Authorization 进行鉴权。

baseUrl: "http://localhost:3000/api"
headers: {
    Authorization: "Bearer {{apikey}}"
}