FastGPTFastGPT

开发者

选择 API 集成或扩展开发,连接 FastGPT 并开发插件、模型预设与 Skill。

选择开发任务

开发者集成全景

FastGPT 面向业务系统与开发者提供完整的开放能力矩阵:

通过可信后端集成 FastGPT通过可信后端集成 FastGPT

API Key 保存在可信服务端。身份代理按需启用,要求接口支持并建立同团队成员的可信身份映射。MCP 客户端通过单独配置的 MCP 服务及其认证方式接入。

凭证体系与鉴权方式

各接口分别声明接受的凭证类型,接入前在 /apidoc/systemopenapi 或 /apidoc/devapi 中确认该接口的鉴权方式。

凭证类型传输位置权限作用域适用场景
个人 API KeyAuthorization: Bearer <apiKey>以创建成员身份访问当前团队中有权限且支持个人 API Key 鉴权的资源业务系统对接、自动化任务、模型调用
应用 API Key(v4.18.0+)Authorization: Bearer <apiKey>绑定单个应用,仅用于该应用的对话与对话管理接口;调用授权来自密钥本身业务系统对接指定应用,通过 customUid 标识业务用户
用户登录会话Cookie fastgpt_token 或 token 头当前成员的资源权限,受接口授权与会话校验约束前端界面通信、同源管理接口
Root 管理密钥请求头 rootkey: <ROOT_KEY>明确启用 Root 鉴权的管理接口,具体资源约束由接口决定跨团队运维、模型探测与自动化迁移任务

核心集成任务

  1. API 极速入门:选择个人 API Key 或应用 API Key,执行首次端到端请求,使用 OpenAI 官方 SDK 接入。
  2. 身份代理机制:可信服务端通过 authProxy 代表真实用户发起调用,实现细粒度权限控制与操作审计。
  3. 知识库全生命周期集成:通过 API 创建集合、异步推送文档到训练队列、检索测试与命中调优。

插件系统

机器可读 OpenAPI 契约

FastGPT 每个部署实例均在本地动态生成最新的 OpenAPI 3.1 规范文档:

  • System OpenAPI(API Key 开放接口):访问 /apidoc/systemopenapi(页面)或 /api/apidoc/systemopenapi.json(JSON 契约)。
  • Dev API(完整开发接口):访问 /apidoc/devapi(页面)或 /api/apidoc/devapi.json(JSON 契约)。

维护历史已有集成时,参考 历史 API 参数与迁移。

在 GitHub 上编辑

文件更新时间

本页导航

准备好开始了吗?

让你的企业知识真正被 AI 用起来