Docs

FastGpt Api Docs

输入“/”快速插入

FastGpt Api Docs

基础配置

baseUrl: "https://fastgpt.run/api"​
headers: {​
    Authorization: "Bearer apikey"​
}​

获取 Api Key

有2个渠道。

1.
账号-key秘钥(全局通用的秘钥）​

2.
应用-应用详情-外部使用-api访问(带有 appid 的秘钥，调用对话时候会调用到当前应用）​

秘钥使用

放置在请求头的Authorization中。

接口

应用

应用对话

对话接口兼容 openai 的接口！如果你有第三方项目，可以直接通过修改 BaseUrl 和 Authorization 来访问 FastGpt 应用。缺点是你无法获取到响应的token值。需要注意的是，如果你的应用不是按标准的 SSE 格式解析，可能会失败。​

标准的 SSE 流响应结构：

event: xxxx

data: xxxx

包含 event和data两部分，其中 event 可以为空，由于 openai gpt 接口的 event 为空，有些程序并没兼容含 event 的情况，会出错。​

标准的 SSE 响应解析流程：

1.
先使用 \n\n 进行分割​

2.
分割的每个元素使用 \n 进行分割，从而得到 event 和 data​

3.
对 data 进行序列化解析​

请求

•
headers.Authorization: 需要在应用中生成的 key​

•
chatId: string | undefined 。​
◦
 为 undefined 时（不传入），不使用 FastGpt 提供的上下文功能，完全通过传入的 messages 构建上下文。 不会将你的记录存储到数据库中，你也无法在记录汇总中查阅到。​
◦
为非空字符串时，意味着使用 chatId 进行对话，自动从 FastGpt 数据库取历史记录。(请自己确保chatId唯一)。​

•
messages: 与 openai gpt 接口完全一致。​

•
detail: 是否返回详细值(模块状态，响应的完整结果），会通过event进行区分​

•
variables: 变量。一个对象​

curl --location --request POST 'https://fastgpt.run/api/openapi/v1/chat/completions' \​
--header 'Authorization: Bearer apikey' \​
--header 'User-Agent: Apifox/1.0.0 (https://www.apifox.cn)' \​
--header 'Content-Type: application/json' \​
--data-raw '{​
    "chatId":"111",​
    "stream":false,​
    "detail": false,​
    "variables": {​
        "cTime": "2022/2/2 22:22"​
    },​
    "messages": [​
        {​
            "content": "导演是谁",​
            "role": "user"​
        }​
    ]​
}'​