Skip to content

赵月辉 / fastgpt-migrated

Go to a project
Commit 651b2091 by Copilot Committed by GitHub
Options

revert: rollback openapi app docs to previous version (#7026) 

* revert: rollback openapi app docs to previous version

Agent-Logs-Url: https://github.com/labring/FastGPT/sessions/f52610f3-f610-4cd0-9ede-0f08c7e76cf7

Co-authored-by: c121914yu <50446880+c121914yu@users.noreply.github.com>

* revert: rollback openapi intro docs only

Agent-Logs-Url: https://github.com/labring/FastGPT/sessions/6247c4b5-3ec0-4608-b680-0aed97800f78

Co-authored-by: c121914yu <50446880+c121914yu@users.noreply.github.com>

---------

Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: c121914yu <50446880+c121914yu@users.noreply.github.com>
parent 1992b76a
Showing with 20 additions and 33 deletions
document/content/openapi/intro.en.mdx
......@@ -3,21 +3,14 @@ title: OpenAPI Introduction
description: FastGPT OpenAPI Introduction
---
## Latest OpenAPI Documentation
## Automated API Documentation
These are the FastGPT APIs published for external use. If you are integrating with FastGPT externally, use the endpoints in this documentation and authenticate with an API key.
- [China Mainland API Documentation](https://cloud.fastgpt.cn/openapi)
- [International API Documentation](https://cloud.fastgpt.io/openapi)
## Developer API Documentation
The developer API documentation covers all endpoints in the current version, regardless of whether they can be called via API key.
The automated API documentation covers all endpoints in the current version, regardless of whether they can be called via API Key.
All future endpoints will be auto-generated, with documentation continuously improved.
- [China Mainland API Documentation](https://cloud.fastgpt.cn/devapidoc)
- [International API Documentation](https://cloud.fastgpt.io/devapidoc)
- [China Mainland API Documentation](https://cloud.fastgpt.cn/openapi)
- [International API Documentation](https://cloud.fastgpt.io/openapi)
## Usage Guide
......@@ -35,10 +28,11 @@ FastGPT has **2 types** of API Keys: a global key (cannot directly call app chat
We recommend using `app-specific keys` only for app or chat-related endpoints, and `global keys` for everything else.
| Global Key | App-Specific Key |
| --------------------------------------- | --------------------------------------- |
| Global Key | App-Specific Key |
| --------------------- | --------------------- |
| ![](../../public/imgs/fastgpt-api2.jpg) | ![](../../public/imgs/fastgpt-api1.jpg) |
## Basic Configuration
In OpenAPI, all endpoints authenticate via Header.Authorization.
......
document/content/openapi/intro.mdx
......@@ -3,25 +3,18 @@ title: OpenAPI 介绍
description: FastGPT OpenAPI 介绍
---
## 最新 OpenAPI 文档
## 自动化 API 文档
这部分接口是 FastGPT 对外提供 API 能力的文档，如果你是外部使用 FastGPT 需使用这个文档里的接口，并通过 apikey 鉴权。
- [中国大陆版 API 文档](https://cloud.fastgpt.cn/openapi)
- [国际版 API 文档](https://cloud.fastgpt.io/openapi)
## 开发者 API 文档
开发者 API 文档为当前版本系统的所有接口，不区分是否可通过 API Key 调用。
自动化 API 文档为当前版本系统的所有接口，不区分是否可通过 API Key 调用。
后续所有接口都将做自动化生成，会逐步完善文档。
- [中国大陆版 API 文档](https://cloud.fastgpt.cn/devapidoc)
- [国际版 API 文档](https://cloud.fastgpt.io/devapidoc)
- [中国大陆版 API 文档](https://cloud.fastgpt.cn/openapi)
- [国际版 API 文档](https://cloud.fastgpt.io/openapi)
## 使用说明
FastGPT OpenAPI 接口允许你使用 API Key 进行鉴权，从而操作 FastGPT 上的相关服务和资源，例如：调用应用对话接口、上传知识库数据、搜索测试等等。出于兼容性和安全考虑，并不是所有的接口都允许通过 API Key 访问。
FasGPT OpenAPI 接口允许你使用 Api Key 进行鉴权，从而操作 FastGPT 上的相关服务和资源，例如：调用应用对话接口、上传知识库数据、搜索测试等等。出于兼容性和安全考虑，并不是所有的接口都允许通过 Api Key 访问。
## 如何查看 BaseURL
......@@ -29,16 +22,17 @@ FastGPT OpenAPI 接口允许你使用 API Key 进行鉴权，从而操作 FastGP
![](../../public/imgs/fastgpt-api-baseurl.png)
## 如何获取 API Key
## 如何获取 Api Key
FastGPT 的 API Key **有 2 类**，一类是全局通用的 key (无法直接调用应用对话)；一类是携带了 AppId 也就是有应用标记的 key (可直接调用应用对话)。
我们建议，仅操作应用或者对话的相关接口使用 `应用特定key`，其他接口使用 `通用key`。
| 通用 key | 应用特定 key |
| --------------------------------------- | --------------------------------------- |
| 通用key | 应用特定 key |
| --------------------- | --------------------- |
| ![](../../public/imgs/fastgpt-api2.jpg) | ![](../../public/imgs/fastgpt-api1.jpg) |
## 基本配置
OpenAPI 中，所有的接口都通过 Header.Authorization 进行鉴权。
......@@ -71,7 +65,7 @@ curl --location --request POST 'http://localhost:3000/api/v1/chat/completions' \
## 自定义用户 ID
`v4.8.13` 后支持传入自定义的用户 ID, 并且存入历史记录中。
`v4.8.13`后支持传入自定义的用户 ID, 并且存入历史记录中。
```sh
curl --location --request POST 'http://localhost:3000/api/v1/chat/completions' \
......
document/data/doc-last-modified.json
......@@ -153,8 +153,8 @@
"content/openapi/dataset.mdx": "2026-05-29T19:08:31+08:00",
"content/openapi/index.en.mdx": "2026-04-26T21:08:47+08:00",
"content/openapi/index.mdx": "2026-04-26T21:08:47+08:00",
"content/openapi/intro.en.mdx": "2026-05-29T19:08:31+08:00",
"content/openapi/intro.mdx": "2026-05-29T19:08:31+08:00",
"content/openapi/intro.en.mdx": "2026-04-26T21:08:47+08:00",
"content/openapi/intro.mdx": "2026-04-26T21:08:47+08:00",
"content/openapi/share.en.mdx": "2026-04-26T21:08:47+08:00",
"content/openapi/share.mdx": "2026-04-26T21:08:47+08:00",
"content/self-host/config/env.en.mdx": "2026-05-27T12:17:46+08:00",
......@@ -424,4 +424,4 @@
"content/self-host/upgrading/upgrade-intruction.mdx": "2026-04-26T21:08:47+08:00",
"content/toc.en.mdx": "2026-05-25T11:21:30+08:00",
"content/toc.mdx": "2026-05-25T11:21:30+08:00"
}
\ No newline at end of file
}
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or sign in to comment