技术速查官方文档7 分钟阅读基准数据页

FastGPT OpenAPI 接口速查表(v4.17.2)

本页汇总 FastGPT v4.17.2 官方 OpenAPI 文档(应用、对话、知识库三篇)中出现的 33 个接口,并按 v4.17.2 的开源仓库目录核对 projects/app/src/pages/api/ 下是否有对应路由文件。

本页汇总 FastGPT v4.17.2 官方 OpenAPI 文档(应用、对话、知识库三篇)中出现的 33 个接口,并按 v4.17.2 的开源仓库目录核对 projects/app/src/pages/api/ 下是否有对应路由文件。

方法接口数
DELETE5
GET6
POST20
PUT2

应用接口(2 个)

方法路径用途文档分节开源仓库路由
GET/api/proApi/core/app/logs/getTotalData获取应用总体数据统计日志接口未见(以官方文档为准)
POST/api/proApi/core/app/logs/getChartData获取应用图表数据日志接口未见(以官方文档为准)

对话接口(11 个)

方法路径用途文档分节开源仓库路由
POST/api/v1/chat/completions发起会话;交互节点继续运行;请求插件发起会话有
POST/api/core/chat/history/getHistories获取会话列表会话管理有
PUT/api/core/chat/history/updateHistory修改会话标题;修改会话置顶状态会话管理有
DELETE/api/core/chat/history/delHistory删除单个会话会话管理有
DELETE/api/core/chat/history/clearHistories清空应用会话会话管理有
GET/api/core/chat/init获取会话基本信息对话管理有
POST/api/core/chat/record/getPaginationRecords获取对话列表对话管理有
GET/api/core/chat/record/getResData获取单个对话运行详情对话管理有
DELETE/api/core/chat/record/delete删除对话对话管理有
POST/api/core/chat/feedback/updateUserFeedback更新反馈(点赞 / 点踩)对话管理有
POST/api/core/ai/agent/v2/createQuestionGuide猜你想问猜你想问有

知识库接口(20 个)

方法路径用途文档分节开源仓库路由
POST/api/core/dataset/create创建知识库知识库有
POST/api/core/dataset/list获取知识库列表知识库有
GET/api/core/dataset/detail获取知识库详情知识库有
DELETE/api/core/dataset/delete删除知识库知识库有
POST/api/core/dataset/collection/create创建空集合/目录集合有
POST/api/core/dataset/collection/create/text创建一个纯文本集合集合有
POST/api/core/dataset/collection/create/link创建一个链接集合集合有
POST/api/core/dataset/collection/create/localFile创建一个文件集合集合有
POST/api/core/dataset/collection/create/apiCollection通过 API 数据集创建集合(V1)集合有
POST/api/proApi/core/dataset/collection/create/externalFileUrl创建一个外部文件库集合(商业版)集合未见(以官方文档为准)
POST/api/core/dataset/collection/listV2获取集合列表集合有
GET/api/core/dataset/collection/detail获取集合详情集合有
POST/api/core/dataset/collection/update更新数据集集合信息集合有
POST/api/core/dataset/collection/delete删除集合集合有
POST/api/core/dataset/data/pushData推送数据到训练队列数据有
POST/api/core/dataset/data/v2/list获取集合的数据列表数据有
GET/api/core/dataset/data/detail获取单条数据详情数据有
PUT/api/core/dataset/data/update修改单条数据数据有
DELETE/api/core/dataset/data/delete删除单条数据数据有
POST/api/core/dataset/searchTest搜索测试搜索测试有

怎么读这张表

  1. 路径取自官方文档的请求示例,文档示例里的服务地址是 http://localhost:3000,调用时换成实际部署地址。
  2. 同一路径在文档中出现多次(例如对话接口的不同用法)时,本页只列一次,「用途」列出各处的小节标题。
  3. 「开源仓库路由」一列为「未见」的接口,开源仓库对应目录下没有同名路由文件,可能由商业版服务提供,调用前以官方文档与实际部署为准。
  4. 接口鉴权、请求体与返回字段见官方 OpenAPI 文档对应小节。

这张表的适用范围

接口清单取自 FastGPT v4.17.2 的官方 OpenAPI 文档与开源仓库目录。文档未收录的内部接口不在本页范围内;私有化部署若做过二次开发,以实际部署为准。

来源