开发者
选择 API 集成或扩展开发，连接 FastGPT 并开发插件、模型预设与 Skill。
选择开发任务
开发者集成全景
FastGPT 面向业务系统与开发者提供完整的开放能力矩阵：
API Key 保存在可信服务端。身份代理按需启用，要求接口支持并建立同团队成员的可信身份映射。MCP 客户端通过单独配置的 MCP 服务及其认证方式接入。
凭证体系与鉴权方式
各接口分别声明接受的凭证类型，接入前在 /apidoc/systemopenapi 或 /apidoc/devapi 中确认该接口的鉴权方式。
| 凭证类型 | 传输位置 | 权限作用域 | 适用场景 |
|---|---|---|---|
| 团队 API Key | Authorization: Bearer <apiKey> | 绑定创建成员在所属团队中的可用资源权限 | 业务系统对接、自动化任务、模型调用 |
| 用户登录会话 | Cookie fastgpt_token 或 token 头 | 当前成员的资源权限，受接口授权与会话校验约束 | 前端界面通信、同源管理接口 |
| Root 管理密钥 | 请求头 rootkey: <ROOT_KEY> | 明确启用 Root 鉴权的管理接口，具体资源约束由接口决定 | 跨团队运维、模型探测与自动化迁移任务 |
核心集成任务
- API 极速入门：获取团队 API Key，执行首次端到端请求，使用 OpenAI 官方 SDK 接入。
- 身份代理机制：可信服务端通过
authProxy代表真实用户发起调用，实现细粒度权限控制与操作审计。 - 应用与工作流集成：调用已发布的对话 Agent、Agent V2 与可视化工作流应用，动态注入全局变量。
- 会话与 18 类流式事件：管理持久化
chatId，深度解析回答、思考、节点状态、计划与交互挂起事件帧。 - 知识库全生命周期集成：通过 API 创建集合、异步推送文档到训练队列、检索测试与命中调优。
插件系统
- 插件开发专题：了解插件类型与开发路径，从首个工具教程开始，继续完成调试与发布。
- 系统工具开发：使用
@fastgpt-plugin/cli研发单工具（defineTool）与工具集（defineToolSet）。 - 模型预设扩展：为新模型供应商添加静态配置与 AIProxy 渠道映射。
- 插件包与 SDK 参考：查阅插件目录规范、打包产物格式与 SDK 类型定义。
- 技能开发教程：在沙箱中编写自定义技能并绑定到 Agent。
机器可读 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 上编辑
文件更新时间