SoruxGPT 官网介绍

Appearance

SoruxGPT SaaS API 支持 ​

SoruxGPT SaaS 是一款 SaaS 平台，提供 SoruxGPT 最新研制的 Next 应用级程序，具有开箱即用，立即托管的功能。

TIP

SoruxGPT SaaS 支持无感迁移所有其他镜像系统的用户数据，让你开箱即用的使用 SoruxGPT SaaS，并兼容已有的软件生态。

TIP

所有请求均需要携带 adminapi 的 Header，值为管理员下发给你的值。 特别的，如果你使用的是 SoruxGPT Proxy 渠道商服务，无需考虑本 API，您的分区管理员会为您操作。

加号 POST ​

TIP

SoruxGPT Next 支持 API 形式加号，支持 rc, rk, rt, at, app 模式的加号

向 /adminapi/addAccount 发送 POST 请求，请求体（form-data）为：

account: 账号
password: 密码
refresh_token: 可选
access_token: 可选
refresh_cookies: 可选

获取账号情况 POST ​

TIP

SoruxGPT Next 支持 API 形式加号，支持 rc, rk, rt, at, app 模式的加号

向 /adminapi/stateAccount 发送 POST 请求

Audit 接口 / Notify 接口 POST ​

TIP

SoruxGPT Next 支持 Audit / Notify 接口进行用户审计

请求内容：

  1. Header 携带 Authorization 字段，格式为 Bearer xxx, xxx 为用户 Token
  2. POST 请求体为 Json，内容为用户提问的请求体
  3. Header 携带 queries 字段，表示倍率计费

返回内容：

  1. 状态码 200 表示正常
  2. 状态码非 200 表示异常，并且把返回 Json 的 detail.message 字段作为错误信息展示给前端

TIP

在语音提问的场景下，如果携带了 queries，表示用户一次性对话了多少条。例如，如果这个值为 queries = 2，那么你需要计费 2 次。 Notify 接口也会回传用户提问的 body。请注意，如果用户的对话发生了错误进行了转号，网关消耗次数可能多于 notify/audit 请求的次数。

OAuth 接口 POST ​

TIP

SoruxGPT Next 支持 Audit 用户审计

请求内容：

  1. Form-Data 格式请求，传递 usertoken 信息

返回 Json 格式的回复，你需要包含以下属性：

  1. code: 1 表示成功，0 表示失败。
  2. 【可选】avatar：头像地址，应为一个 url 绝对地址
  3. 【可选】email：邮箱地址，如果不填默认为 [email protected]
  4. 【可选】nickname：昵称，如果不填默认为 default-user
  5. 【可选】uid：用户 ID，如果不填默认为 1
  6. 【可选】priority：优先使用的账号类型：可以为 pro, team, plus
  7. 【可选】apikey：用户绑定的 ApiKey，用于作为 Api 功能的使用密钥
  8. 【可选】forcetoken：以 forcetoken 作为真正使用的 Token。

TIP

可选信息不给，不会发生任何错误。

OAuth 接口 POST ​

TIP

SoruxGPT Next 支持 Audit 用户审计

请求内容：

  1. Form-Data 格式请求，传递 usertoken 信息

返回 Json 格式的回复，你需要包含以下属性：

  1. code: 1 表示成功，0 表示失败。
  2. 【可选】avatar：头像地址，应为一个 url 绝对地址
  3. 【可选】email：邮箱地址，如果不填默认为 [email protected]
  4. 【可选】nickname：昵称，如果不填默认为 default-user
  5. 【可选】uid：用户 ID，如果不填默认为 1
  6. 【可选】priority：优先使用的账号类型：可以为 pro, team, plus
  7. 【可选】apikey：用户绑定的 ApiKey，用于作为 Api 功能的使用密钥
  8. 【可选】forcetoken：以 forcetoken 作为真正使用的 Token。

TIP

可选信息不给，不会发生任何错误。

网页会话记录导入接口 POST ​

TIP

本接口旨在导入官网特定的对话请求

json
{
    "user": "xxx",
    "conversations": [
        {
            "gpt_account_mail": "",
            "gpt_account_id": "",
            "access_token": "",
            "conversation_id": "",
        }
    ]
}

注意：

  1. user 表示的是用户的激活码，也就是在 SaaS 系统中，你想要把这个对话绑定的激活码对象
  2. conversations 数组里面可以放置多个 ChatGPT 对话信息，会根据 SaaS 内置的数据结构进行拼接。

镜像站对话记录导入 POST ​

TIP

本接口旨在导入指定对话请求的记录

向 /adminapi/importConversationBySelf 发送 POST 请求

json
{
    "user": "xxx",
    "conversations": [
        {

        }
    ]
}

注意：

  1. user 表示的是用户的激活码，也就是在 SaaS 系统中，你想要把这个对话绑定的激活码对象
  2. conversations 数组里面可以放置多个会话记录，Json 格式为 /backend-api/conversation/:convId 接口的返回值。可选为官网的返回值，也可以选择为镜像站的返回值

网页会话记录导入接口 POST ​

TIP

本接口旨在导入官网特定的对话请求

向 /adminapi/importConversationByWeb 发送 POST 请求

json
{
    "user": "xxx",
    "conversations": [
        {
            "gpt_account_mail": "",
            "gpt_account_id": "",
            "access_token": "",
            "conversation_id": "",
        }
    ]
}

注意：

  1. user 表示的是用户的激活码，也就是在 SaaS 系统中，你想要把这个对话绑定的激活码对象
  2. conversations 数组里面可以放置多个 ChatGPT 对话信息，会根据 SaaS 内置的数据结构进行拼接。