开发工具中集成Burncloud API 文档

This book is a comprehensive technical guide that details how to integrate Burncloud LMMs API into various software development tools. Burncloud LMMs API serves as a unified interface, connecting to numerous large language models worldwide, providing developers with powerful AI capabilities.

开发工具接入BurnCloud API前（必看）

本文涉及到接入Burncloud API用到的两个关键变量，接入端点 $Burncloud_API_BaseUrl 和密钥 $Burncloud_API_KEY ，请务必花1分钟过一眼，看看如何获取。

  1. Burncloud的API服务分标准服务C端和企业服务B端，接入前请先确认账号所在的端点（教程中的 $Burncloud_API_BaseUrl 的值）,教程将以标准服务C端接入点举例。

    • 标准服务C端接入点：https://ai.burncloud.com
    • 企业服务B端接入点：https://b.burncloud.com

  2. 创建账户并登录

    1.1 创建账户
    1.2 登录

  3. 创建您的API密钥 ，教程中的 $Burncloud_API_KEY 的值。

    • 来到创建Token的页面 创建令牌步骤1

    • 创建Token，填写token名称==》选择token将调用的模型所在的分组==》开启无限额度（可选）==》提交 创建令牌步骤2

  1. 在API调用中使用您的密钥。例如：

    https://ai.burncloud.com/v1/chat/completions
Token: sk-6B72ZIOj0p0tKEyaoyVAgRAz6SMtfxxxxxxxx

curl https://ai.burncloud.com/v1/chat/completions \ 
  -H "Content-Type: application/json" \ 
  -H "Authorization: Bearer sk-6B72ZIOj0p0tKEyaoyVAgRAz6SMtfxxxxxxxx" \
  -d '{
      "model": "deepseek-r1", 
      "messages": [{ 
          "role": "user", 
          "content": "你好，你今天怎么样？" 
      }], 
      "temperature": 0.7, 
      "max_tokens": 150
  }'

  2. 为您的账户充值

    开始使用API服务

chatbox接入教程

  1. 打开地址https://web.chatboxai.app 或者安装最新版桌面端软件
  2. 点setting（设置）
  3. 点击添加
  4. 选择新加的ai提供方
  5. 选择兼容模式
  6. 填入客服提供的key
  7. 输入ai的API地址：
  8. 添加模型
  1. 点击新对话，选择模型就可以使用啦

chatbox对话页面

word接入教程

  1. API地址：
  2. 下载officeAi助手 傻瓜式安装，下一步，下一步。如果有遇到要问题的，会弹出修复窗口。直接点击修复。
    • 微信图片_2025-08-27_182907_070.png
  3. 安装成功后 打开文档会自定弹出officeAi、点击右上角三个点 选择设置
  1. 保存模型
  1. 在word文档中使用
  1. 切换模型
    • 微信图片_2025-08-27_184515_061.png

vscode cline插件接入教程

  1. 插件搜索cline 安装

vscode1.png

cline 安装页面

  1. api提供方选择 OpenAl Compatible baseUrl输入： https://{{baseUrl}}/v1 填入key modelID 输入deepseek-r1

vscode2.png

cline接入页面

cherry studio接入教程

目前Bruncloud已经成为Cherry Studio模型服务商，直接在Cherry Studio模型服务页面搜索 Bruncloud 就能使用。

  1. 安装后打开设置，找到BurnCloud，前往BurnCloud把key拷贝过来填入即可使用。 微信图片_2025-08-27_191221_353.png cherry studio 接入页面

  2. 可以像正常使用Cherry Studio一样调用BurnCloud提供的模型能力。

anythingllm接入教程

  1. 安装后进入设置页面 供应商选择：Local AI Chat Model Selection：deepseek-r1 Token context window：4096 Local AI API Key：我们提供的key Local AI Base URL： https://ai.burncloud.com/v1 配置完后点击保存

anythingllm1.png

anythingllm 接入页面

  1. 返回对话窗口就可对话了

anythingllm2.png

anythingllm 聊天页面

Pycharm-Continue插件接入教程

  1. 安装插件后 在右边打开插件

Pycharm1.png

Pycharm-Continue页面

  1. 点击上方三个点 打开设置界面，打开配置文件

pycharm2.png

Pycharm-Continue接入页面

  1. models里面输入 保存
{
  "model": "deepseek-r1",
  "provider": "deepseek",
  "apiKey": "sk-y6fiVJcNh7cSy5zslivJHgRAD4cIZi7kI5Bj3JdJRF6bRFj5",
  "apiBase": "https://ai.burncloud.com/v1",
  "title": "deepseek-r1"
},
{
  "model": "deepseek-v3",
  "provider": "deepseek",
  "apiKey": "sk-y6fiVJcNh7cSy5zslivJHgRAD4cIZi7kI5Bj3JdJRF6bRFj5",
  "apiBase": "https://ai.burncloud.com/v1",
  "title": "deepseek-v3"
}
  1. 返回对话界面选择模型 即可发起对话

Pycharm3.png

Pycharm-Continue聊天页面

Pycharm4.png

Pycharm-Continue聊天页面

vscode Roo Code插件接入教程

  1. 插件搜索cline 安装 微信图片_2025-08-27_190550_985.png cline接入页面

Claude code router的接入Burncloud LLMs API教学视频

Claude code router的接入Burncloud LLMs API教学视频，少废话，直接上视频

前端接口

适合二开，使用burncloud作为供应商，包含用户余额，积分记录，任务记录，token余额等等，满足二开，建立服务后端。

前端接口

鉴权体系说明（Auth）

说明

系统采用四级鉴权机制：公开、用户、管理员、Root

🔐 鉴权

前端接口

获取可用模型列表（Model）

说明

接口前缀统一为 http(s)://<your-domain>

生产环境应使用 HTTPS 以保证认证令牌。HTTP 仅建议用于开发环境。

接口信息

💡 请求示例

const response = await fetch('/api/models', {  
  method: 'GET',  
  headers: {  
    'Content-Type': 'application/json',  
    'Authorization': 'Bearer your_user_token',
    'New-Api-User': 'Bearer your_user_id'
  }  
});  
const data = await response.json();

✅ 成功响应示例

{  
  "success": true,  
  "data": {  
    "1": ["gpt-3.5-turbo", "gpt-4"],  
    "2": ["claude-3-sonnet", "claude-3-haiku"]  
  }  
}

❗ 失败响应示例

{  
  "success": false,  
  "message": "未授权访问"  
}

🧾 字段说明

前端接口

公共信息模块

功能说明

接口前缀为：

  1. 主站：https://ai.burncloud.com
  2. 企业站：https://b.burncloud.com

提供无需认证或低权限访问的系统信息，包括模型列表、定价信息、公告内容等。支持多语言显示和动态配置。前端首页和模型广场主要依赖这些接口获取展示数据。

🔐 无需鉴权

获取公告栏内容

💡 请求示例：

const response = await fetch('/api/notice', {  
  method: 'GET',  
  headers: {  
    'Content-Type': 'application/json'  
  }  
});  
const data = await response.json();

✅ 成功响应示例：

{  
  "success": true,  
  "message": "",  
  "data": "# 系统公告\n\n欢迎使用New API系统！"  
}

❗ 失败响应示例：

{  
  "success": false,  
  "message": "获取公告失败"  
}

🧾 字段说明：

关于页面信息

💡 请求示例：

const response = await fetch('/api/about', {  
  method: 'GET',  
  headers: {  
    'Content-Type': 'application/json'  
  }  
});  
const data = await response.json();

✅ 成功响应示例：

{  
  "success": true,  
  "message": "",  
  "data": "# 关于我们\n\nNew API是一个强大的AI网关系统..."  
}

❗ 失败响应示例：

{  
  "success": false,  
  "message": "获取关于信息失败"  
}

🧾 字段说明：

首页自定义内容

💡 请求示例：

const response = await fetch('/api/home_page_content', {  
  method: 'GET',  
  headers: {  
    'Content-Type': 'application/json'  
  }  
});  
const data = await response.json();

✅ 成功响应示例：

{  
  "success": true,  
  "message": "",  
  "data": "# 欢迎使用New API\n\n这是一个功能强大的AI网关系统..."  
}

❗ 失败响应示例：

{  
  "success": false,  
  "message": "获取首页内容失败"  
}

🧾 字段说明：

模型倍率配置

💡 请求示例：

const response = await fetch('/api/ratio_config', {  
  method: 'GET',  
  headers: {  
    'Content-Type': 'application/json'  
  }  
});  
const data = await response.json();

✅ 成功响应示例：

{  
  "success": true,  
  "data": {  
    "model_ratio": {  
      "gpt-3.5-turbo": 1.0,  
      "gpt-4": 15.0,  
      "claude-3-sonnet": 3.0  
    },  
    "completion_ratio": {  
      "gpt-3.5-turbo": 1.0,  
      "gpt-4": 1.0  
    },  
    "model_price": {  
      "gpt-3.5-turbo-instruct": 0.002  
    }  
  }  
}

❗ 失败响应示例：

{  
  "success": false,  
  "message": "获取倍率配置失败"  
}

🧾 字段说明：

价格与套餐信息

💡 请求示例：

const response = await fetch('/api/pricing', {  
  method: 'GET',  
  headers: {  
    'Content-Type': 'application/json',  
    'Authorization': 'Bearer your_token', // 可选，登录用户可获得更详细信息
    'New-Api-User': 'Bearer your_user_id' // 可选
  }  
});  
const data = await response.json();

✅ 成功响应示例：

{  
  "success": true,  
  "data": [  
    {  
      "model_name": "gpt-3.5-turbo",  
      "enable_group": ["default", "vip"],  
      "model_ratio": 1.0,  
      "completion_ratio": 1.0,  
      "model_price": 0.002,  
      "quota_type": 1,  
      "description": "GPT-3.5 Turbo模型",  
      "vendor_id": 1,  
      "supported_endpoint_types": [1, 2]  
    }  
  ],  
  "vendors": [  
    {  
      "id": 1,  
      "name": "OpenAI",  
      "description": "OpenAI官方模型",  
      "icon": "openai.png"  
    }  
  ],  
  "group_ratio": {  
    "default": 1.0,  
    "vip": 0.8  
  },  
  "usable_group": {  
    "default": "默认分组",  
    "vip": "VIP分组"  
  },  
  "supported_endpoint": {  
    "1": {"method": "POST", "path": "/v1/chat/completions"},  
    "2": {"method": "POST", "path": "/v1/embeddings"}  
  },  
  "auto_groups": ["default"]  
}

❗ 失败响应示例：

{  
  "success": false,  
  "message": "获取定价信息失败"  
}

🧾 字段说明：

🔐 用户鉴权

获取前端可用模型列表

💡 请求示例：

const response = await fetch('/api/models', {  
  method: 'GET',  
  headers: {  
    'Content-Type': 'application/json',  
    'Authorization': 'Bearer your_user_token',
    'New-Api-User': 'Bearer your_user_id'
  }  
});  
const data = await response.json();

✅ 成功响应示例：

{  
  "success": true,  
  "data": {  
    "1": ["gpt-3.5-turbo", "gpt-4"],  
    "2": ["claude-3-sonnet", "claude-3-haiku"]  
  }  
}

❗ 失败响应示例：

{  
  "success": false,  
  "message": "未授权访问"  
}

🧾 字段说明：

前端接口

邮箱身份验证模块

功能说明

接口前缀为：

  1. 主站：https://ai.burncloud.com
  2. 企业站：https://b.burncloud.com

实现邮箱验证和密码重置功能，集成限流和 Turnstile 防护。支持自动生成随机密码和邮件模板定制。在用户注册、账户绑定等场景中广泛使用。

🔐 无需鉴权

发送邮箱验证邮件

💡 请求示例：

const response = await fetch(`/api/verification?email=${email}&turnstile=${turnstileToken}`, {  
  method: 'GET',  
  headers: {  
    'Content-Type': 'application/json'  
  }  
});  
const data = await response.json();

✅ 成功响应示例：

{  
  "success": true,  
  "message": ""  
}

❗ 失败响应示例：

{  
  "success": false,  
  "message": "无效的参数"  
}

🧾 字段说明：

发送重置密码邮件

💡 请求示例：

const response = await fetch(`/api/reset_password?email=${email}&turnstile=${turnstileToken}`, {  
  method: 'GET',  
  headers: {  
    'Content-Type': 'application/json'  
  }  
});  
const data = await response.json();

✅ 成功响应示例：

{  
  "success": true,  
  "message": ""  
}

❗ 失败响应示例：

{  
  "success": false,  
  "message": "该邮箱地址未注册"  
}

🧾 字段说明：

提交重置密码请求

💡 请求示例：

const response = await fetch('/api/user/reset', {  
  method: 'POST',  
  headers: {  
    'Content-Type': 'application/json'  
  },  
  body: JSON.stringify({  
    email: "user@example.com",  
    token: "verification_token_from_email"  
  })  
});  
const data = await response.json();

✅ 成功响应示例：

{  
  "success": true,  
  "message": "",  
  "data": "newPassword123"  
}

❗ 失败响应示例：

{  
  "success": false,  
  "message": "重置链接非法或已过期"  
}

🧾 字段说明：

前端接口

OAuth 第三方登录模块

功能说明

接口前缀为：

  1. 主站：https://ai.burncloud.com
  2. 企业站：https://b.burncloud.com

支持 GitHub、OIDC、LinuxDO、微信、Telegram 等多种 OAuth 登录方式。实现 CSRF 防护和会话管理，支持账户绑定和自动注册。前端通过重定向方式处理 OAuth 流程。

🔐 无需鉴权

GitHub OAuth 跳转

💡 请求示例：

// 前端通过重定向方式调用，通常由GitHub OAuth授权后自动回调
window.location.href = `https://github.com/login/oauth/authorize?client_id=${github_client_id}&state=${state}&scope=user:email`;

✅ 成功响应示例：

{  
  "success": true,  
  "message": "登录成功",  
  "data": {  
    "token": "user_access_token",  
    "user": {  
      "id": 1,  
      "username": "github_user",  
      "display_name": "GitHub User",  
      "email": "user@example.com"  
    }  
  }  
}

❗ 失败响应示例：

{  
  "success": false,  
  "message": "管理员未开启通过 GitHub 登录以及注册"  
}

🧾 字段说明：

OIDC 通用 OAuth 跳转

💡 请求示例：

// 前端通过重定向方式调用
const url = new URL(auth_url);  
url.searchParams.set('client_id', client_id);  
url.searchParams.set('redirect_uri', `${window.location.origin}/oauth/oidc`);  
url.searchParams.set('response_type', 'code');  
url.searchParams.set('scope', 'openid profile email');  
url.searchParams.set('state', state);  
window.location.href = url.toString();

✅ 成功响应示例：

{  
  "success": true,  
  "message": "登录成功",  
  "data": {  
    "token": "user_access_token",  
    "user": {  
      "id": 1,  
      "username": "oidc_user",  
      "email": "user@example.com"  
    }  
  }  
}

❗ 失败响应示例：

{  
  "success": false,  
  "message": "OIDC 获取用户信息失败！请检查设置！"  
}

🧾 字段说明：

LinuxDo OAuth 跳转

💡 请求示例：

// 前端通过重定向方式调用
window.location.href = `https://connect.linux.do/oauth2/authorize?response_type=code&client_id=${linuxdo_client_id}&state=${state}`;

✅ 成功响应示例：

{  
  "success": true,  
  "message": "登录成功",  
  "data": {  
    "token": "user_access_token",  
    "user": {  
      "id": 1,  
      "username": "linuxdo_user",  
      "display_name": "LinuxDo User"  
    }  
  }  
}

❗ 失败响应示例：

{  
  "success": false,  
  "message": "管理员关闭了新用户注册"  
}

🧾 字段说明：

微信扫码登录跳转

💡 请求示例：

const response = await fetch(`/api/oauth/wechat?code=${wechat_verification_code}`, {  
  method: 'GET',  
  headers: {  
    'Content-Type': 'application/json'  
  }  
});  
const data = await response.json();

✅ 成功响应示例：

{  
  "success": true,  
  "message": "登录成功",  
  "data": {  
    "token": "user_access_token",  
    "user": {  
      "id": 1,  
      "username": "wechat_user",  
      "wechat_id": "wechat_openid"  
    }  
  }  
}

❗ 失败响应示例：

{  
  "success": false,  
  "message": "验证码无效或已过期"  
}

🧾 字段说明：

微信账户绑定

💡 请求示例：

const response = await fetch(`/api/oauth/wechat/bind?code=${wechat_verification_code}`, {  
  method: 'GET',  
  headers: {  
    'Content-Type': 'application/json'  
  }  
});  
const data = await response.json();

✅ 成功响应示例：

{  
  "success": true,  
  "message": "微信账户绑定成功！"  
}

❗ 失败响应示例：

{  
  "success": false,  
  "message": "验证码无效或该微信账户已被绑定"  
}

🧾 字段说明：

邮箱绑定

💡 请求示例：

const response = await fetch(`/api/oauth/email/bind?email=${email}&code=${email_verification_code}`, {  
  method: 'GET',  
  headers: {  
    'Content-Type': 'application/json'  
  }  
});  
const data = await response.json();

✅ 成功响应示例：

{  
  "success": true,  
  "message": "邮箱账户绑定成功！"  
}

❗ 失败响应示例：

{  
  "success": false,  
  "message": "验证码无效或邮箱已被使用"  
}

🧾 字段说明：

Telegram 登录

💡 请求示例：

const params = {  
  id: telegram_user_id,  
  first_name: "John",  
  last_name: "Doe",   
  username: "johndoe",  
  photo_url: "https://...",  
  auth_date: 1640995200,  
  hash: "telegram_hash"  
};  
const query = new URLSearchParams(params).toString();
const response = await fetch(`/api/oauth/telegram/login?${query}`, {
  method: 'GET'
});
const data = await response.json();

✅ 成功响应示例：

{  
  "success": true,  
  "message": "登录成功",  
  "data": {  
    "token": "user_access_token",  
    "user": {  
      "id": 1,  
      "username": "telegram_user",  
      "telegram_id": "123456789"  
    }  
  }  
}

❗ 失败响应示例：

{  
  "success": false,  
  "message": "Telegram验证失败"  
}

🧾 字段说明：

Telegram 账户绑定

💡 请求示例：

// 通过TelegramLoginButton组件自动处理参数  
// 参数格式与Telegram登录相同  
const response = await fetch('/api/oauth/telegram/bind', {  
  method: 'GET',  
  params: telegram_auth_params  
});  
const data = await response.json();

✅ 成功响应示例：

{  
  "success": true,  
  "message": "Telegram账户绑定成功！"  
}

❗ 失败响应示例：

{  
  "success": false,  
  "message": "该Telegram账户已被绑定"  
}

🧾 字段说明：

获取随机 state（防 CSRF）

💡 请求示例：

let path = '/api/oauth/state';  
let affCode = localStorage.getItem('aff');  
if (affCode && affCode.length > 0) {  
  path += `?aff=${affCode}`;  
}  
const response = await fetch(path, {  
  method: 'GET',  
  headers: {  
    'Content-Type': 'application/json'  
  }  
});  
const data = await response.json();

✅ 成功响应示例：

{  
  "success": true,  
  "message": "",  
  "data": "random_state_string_12chars"  
}

❗ 失败响应示例：

{  
  "success": false,  
  "message": "生成state失败"  
}

🧾 字段说明：

前端接口

用户模块

功能说明

接口前缀为：

  1. 主站：https://ai.burncloud.com
  2. 企业站：https://b.burncloud.com

核心用户管理系统，实现四级权限体系（公开/用户/管理员/Root）和完整的用户生命周期管理。包含注册登录、个人资料、Token 管理、充值支付、推广系统等功能。支持 2FA、邮箱验证和多种 OAuth 登录方式。

账号注册/登录

🔐 无需鉴权

注册新账号

💡 请求示例：
const response = await fetch('/api/user/register', {  
  method: 'POST',  
  headers: {  
    'Content-Type': 'application/json'  
  },  
  body: JSON.stringify({  
    username: "newuser",  
    password: "password123",  
    email: "user@example.com",  
    verification_code: "123456",  
    aff_code: "INVITE123"  
  })  
});  
const data = await response.json();
✅ 成功响应示例：
{  
  "success": true,  
  "message": "用户注册成功"  
}
❗ 失败响应示例：
{  
  "success": false,  
  "message": "管理员关闭了新用户注册"  
}
🧾 字段说明：

用户登录

💡 请求示例：
const response = await fetch('/api/user/login', {  
  method: 'POST',  
  headers: {  
    'Content-Type': 'application/json'  
  },  
  body: JSON.stringify({  
    username: "testuser",  
    password: "password123"  
  })  
});  
const data = await response.json();
✅ 成功响应示例（无 2FA）：
{  
  "success": true,  
  "message": "登录成功",  
  "data": {  
    "token": "user_access_token",  
    "user": {  
      "id": 1,  
      "username": "testuser",  
      "role": 1,  
      "quota": 1000000  
    }  
  }  
}
✅ 成功响应示例（需要 2FA）：
{  
  "success": true,  
  "message": "请输入两步验证码",  
  "data": {  
    "require_2fa": true  
  }  
}
❗ 失败响应示例：
{  
  "success": false,  
  "message": "管理员关闭了密码登录"  
}
🧾 字段说明：

Epay 支付回调

💡 请求示例：
// 通常由支付系统自动回调，前端无需主动调用  
// 示例URL: /api/user/epay/notify?trade_no=USR1NO123456&money=10.00&trade_status=TRADE_SUCCESS
✅ 成功响应示例：
{  
  "success": true,  
  "message": "支付成功"  
}
❗ 失败响应示例：
{  
  "success": false,  
  "message": "订单不存在或已处理"  
}
🧾 字段说明：

列出所有分组（无鉴权版）

💡 请求示例：
const response = await fetch('/api/user/groups', {  
  method: 'GET',  
  headers: {  
    'Content-Type': 'application/json'  
  }  
});  
const data = await response.json();
✅ 成功响应示例：
{  
  "success": true,  
  "message": "",  
  "data": {  
    "default": {  
      "ratio": 1.0,  
      "desc": "默认分组"  
    },  
    "vip": {  
      "ratio": 0.8,  
      "desc": "VIP分组"  
    },  
    "auto": {  
      "ratio": "自动",  
      "desc": "自动选择最优分组"  
    }  
  }  
}
❗ 失败响应示例：
{  
  "success": false,  
  "message": "获取分组信息失败"  
}
🧾 字段说明：

🔐 用户鉴权

退出登录

💡 请求示例：
const response = await fetch('/api/user/logout', {  
  method: 'GET',  
  headers: {  
    'Content-Type': 'application/json',  
    'Authorization': 'Bearer your_user_token',
    'New-Api-User': 'Bearer your_user_id'
  }  
});  
const data = await response.json();
✅ 成功响应示例：
{  
  "success": true,  
  "message": ""  
}
❗ 失败响应示例：
{  
  "success": false,  
  "message": "会话清除失败"  
}
🧾 字段说明：

用户自身操作

🔐 用户鉴权

获取自己所在分组

💡 请求示例：
const response = await fetch('/api/user/self/groups', {  
  method: 'GET',  
  headers: {  
    'Content-Type': 'application/json',  
    'Authorization': 'Bearer your_user_token',
    'New-Api-User': 'Bearer your_user_id'
  }  
});  
const data = await response.json();
✅ 成功响应示例：
{  
  "success": true,  
  "message": "",  
  "data": {  
    "default": {  
      "ratio": 1.0,  
      "desc": "默认分组"  
    },  
    "vip": {  
      "ratio": 0.8,  
      "desc": "VIP分组"  
    },  
    "auto": {  
      "ratio": "自动",  
      "desc": "自动选择最优分组"  
    }  
  }  
}
❗ 失败响应示例：
{  
  "success": false,  
  "message": "获取分组信息失败"  
}
🧾 字段说明：

获取个人资料

💡 请求示例：
const response = await fetch('/api/user/self', {  
  method: 'GET',  
  headers: {  
    'Content-Type': 'application/json',  
    'Authorization': 'Bearer your_user_token',
    'New-Api-User': 'Bearer your_user_id'
  }  
});  
const data = await response.json();
✅ 成功响应示例：
{  
  "success": true,  
  "message": "",  
  "data": {  
    "id": 1,  
    "username": "testuser",  
    "display_name": "Test User",  
    "role": 1,  
    "status": 1,  
    "email": "user@example.com",  
    "group": "default",  
    "quota": 1000000,  
    "used_quota": 50000,  
    "request_count": 100,  
    "aff_code": "ABC123",  
    "aff_count": 5,  
    "aff_quota": 10000,  
    "aff_history_quota": 50000,  
    "inviter_id": 0,  
    "linux_do_id": "",  
    "setting": "{}",  
    "stripe_customer": "",  
    "sidebar_modules": "{\"chat\":{\"enabled\":true}}",  
    "permissions": {  
      "can_view_logs": true,  
      "can_manage_tokens": true  
    }  
  }  
}
❗ 失败响应示例：
{  
  "success": false,  
  "message": "获取用户信息失败"  
}
🧾 字段说明：

获取模型可见性

💡 请求示例：
const response = await fetch('/api/user/models', {  
  method: 'GET',  
  headers: {  
    'Content-Type': 'application/json',  
    'Authorization': 'Bearer your_user_token',
    'New-Api-User': 'Bearer your_user_id'
  }  
});  
const data = await response.json();
✅ 成功响应示例：
{  
  "success": true,  
  "message": "",  
  "data": [  
    "gpt-3.5-turbo",  
    "gpt-4",  
    "claude-3-sonnet",  
    "claude-3-haiku"  
  ]  
}
❗ 失败响应示例：
{  
  "success": false,  
  "message": "获取模型列表失败"  
}
🧾 字段说明：

修改个人资料

💡 请求示例（更新个人信息）：
const response = await fetch('/api/user/self', {  
  method: 'PUT',  
  headers: {  
    'Content-Type': 'application/json',  
    'Authorization': 'Bearer your_user_token',
    'New-Api-User': 'Bearer your_user_id'
  },  
  body: JSON.stringify({  
    display_name: "New Display Name",  
    email: "newemail@example.com"  
  })  
});  
const data = await response.json();
💡 请求示例（更新侧边栏设置）：
const response = await fetch('/api/user/self', {  
  method: 'PUT',  
  headers: {  
    'Content-Type': 'application/json',  
    'Authorization': 'Bearer your_user_token',
    'New-Api-User': 'Bearer your_user_id'
  },  
  body: JSON.stringify({  
    sidebar_modules: JSON.stringify({  
      chat: { enabled: true, playground: true },  
      console: { enabled: true, token: true }  
    })  
  })  
});  
const data = await response.json();
✅ 成功响应示例：
{  
  "success": true,  
  "message": "更新成功"  
}
❗ 失败响应示例：
{  
  "success": false,  
  "message": "输入不合法"  
}
🧾 字段说明：

注销账号

💡 请求示例：
const response = await fetch('/api/user/self', {  
  method: 'DELETE',  
  headers: {  
    'Content-Type': 'application/json',  
    'Authorization': 'Bearer your_user_token',
    'New-Api-User': 'Bearer your_user_id'
  }  
});  
const data = await response.json();
✅ 成功响应示例：
{  
  "success": true,  
  "message": ""  
}
❗ 失败响应示例：
{  
  "success": false,  
  "message": "不能删除超级管理员账户"  
}
🧾 字段说明：

生成用户级别 Access Token

💡 请求示例：
const response = await fetch('/api/user/token', {  
  method: 'GET',  
  headers: {  
    'Content-Type': 'application/json',  
    'Authorization': 'Bearer your_user_token',
    'New-Api-User': 'Bearer your_user_id'
  }  
});  
const data = await response.json();
✅ 成功响应示例：
{  
  "success": true,  
  "message": "",  
  "data": "<YOUR_API_KEY>"  
}
❗ 失败响应示例：
{  
  "success": false,  
  "message": "生成令牌失败"  
}
🧾 字段说明：

获取推广码信息

💡 请求示例：
const response = await fetch('/api/user/aff', {  
  method: 'GET',  
  headers: {  
    'Content-Type': 'application/json',  
    'Authorization': 'Bearer your_user_token',
    'New-Api-User': 'Bearer your_user_id'
  }  
});  
const data = await response.json();
✅ 成功响应示例：
{  
  "success": true,  
  "message": "",  
  "data": "ABC123"  
}
❗ 失败响应示例：
{  
  "success": false,  
  "message": "获取推广码失败"  
}
🧾 字段说明：

余额直充

💡 请求示例：
const response = await fetch('/api/user/topup', {  
  method: 'POST',  
  headers: {  
    'Content-Type': 'application/json',  
    'Authorization': 'Bearer your_user_token',
    'New-Api-User': 'Bearer your_user_id'
  },  
  body: JSON.stringify({  
    key: "REDEEM123456"  
  })  
});  
const data = await response.json();
✅ 成功响应示例：
{  
  "success": true,  
  "message": "兑换成功",  
  "data": 100000  
}
❗ 失败响应示例：
{  
  "success": false,  
  "message": "兑换码无效或已使用"  
}
🧾 字段说明：

提交支付订单

💡 请求示例：
const response = await fetch('/api/user/pay', {  
  method: 'POST',  
  headers: {  
    'Content-Type': 'application/json',  
    'Authorization': 'Bearer your_user_token',
    'New-Api-User': 'Bearer your_user_id'
  },  
  body: JSON.stringify({  
    amount: 10000,  
    payment_method: "alipay",  
    top_up_code: ""  
  })  
});  
const data = await response.json();
✅ 成功响应示例：
{  
  "success": true,  
  "message": "success",  
  "data": {  
    "pid": "12345",  
    "type": "alipay",  
    "out_trade_no": "USR1NO123456",  
    "notify_url": "https://example.com/notify",  
    "return_url": "https://example.com/return",  
    "name": "TUC10000",  
    "money": "10.00",  
    "sign": "abc123def456"  
  },  
  "url": "https://pay.example.com/submit"  
}
❗ 失败响应示例：
{  
  "success": false,  
  "message": "充值数量不能小于 1000"  
}
🧾 字段说明：

余额支付

💡 请求示例：
const response = await fetch('/api/user/amount', {  
  method: 'POST',  
  headers: {  
    'Content-Type': 'application/json',  
    'Authorization': 'Bearer your_user_token',
    'New-Api-User': 'Bearer your_user_id'
  },  
  body: JSON.stringify({  
    amount: 10000,  
    top_up_code: ""  
  })  
});  
const data = await response.json();
✅ 成功响应示例：
{  
  "success": true,  
  "message": "success",  
  "data": "10.00"  
}
❗ 失败响应示例：
{  
  "success": false,  
  "message": "充值数量不能小于 1000"  
}
🧾 字段说明：

推广额度转账

💡 请求示例：
const response = await fetch('/api/user/aff_transfer', {  
  method: 'POST',  
  headers: {  
    'Content-Type': 'application/json',  
    'Authorization': 'Bearer your_user_token',
    'New-Api-User': 'Bearer your_user_id'
  },  
  body: JSON.stringify({  
    quota: 50000  
  })  
});  
const data = await response.json();
✅ 成功响应示例：
{  
  "success": true,  
  "message": "划转成功"  
}
❗ 失败响应示例：
{  
  "success": false,  
  "message": "邀请额度不足！"  
}
🧾 字段说明：

更新用户设置

💡 请求示例：
const response = await fetch('/api/user/setting', {  
  method: 'PUT',  
  headers: {  
    'Content-Type': 'application/json',  
    'Authorization': 'Bearer your_user_token',
    'New-Api-User': 'Bearer your_user_id'
  },  
  body: JSON.stringify({  
    theme: "dark",  
    language: "zh-CN",  
    notifications: {  
      email: true,  
      browser: false  
    }  
  })  
});  
const data = await response.json();
✅ 成功响应示例：
{  
  "success": true,  
  "message": "设置更新成功"  
}
❗ 失败响应示例：
{  
  "success": false,  
  "message": "设置格式错误"  
}
🧾 字段说明：

管理员用户管理

🔐 管理员鉴权

获取全部用户列表

💡 请求示例：
const response = await fetch('/api/user/?p=1&page_size=20', {  
  method: 'GET',  
  headers: {  
    'Content-Type': 'application/json',  
    'Authorization': 'Bearer your_admin_token',
    'New-Api-User': 'Bearer your_user_id'
  }  
});  
const data = await response.json();
✅ 成功响应示例：
{  
  "success": true,  
  "message": "",  
  "data": {  
    "items": [  
      {  
        "id": 1,  
        "username": "testuser",  
        "display_name": "Test User",  
        "role": 1,  
        "status": 1,  
        "email": "user@example.com",  
        "group": "default",  
        "quota": 1000000,  
        "used_quota": 50000,  
        "request_count": 100  
      }  
    ],  
    "total": 50,  
    "page": 1,  
    "page_size": 20  
  }  
}
❗ 失败响应示例：
{  
  "success": false,  
  "message": "获取用户列表失败"  
}
🧾 字段说明：

搜索用户

💡 请求示例：
const response = await fetch('/api/user/search?keyword=test&group=default&p=1&page_size=20', {  
  method: 'GET',  
  headers: {  
    'Content-Type': 'application/json',  
    'Authorization': 'Bearer your_admin_token',
    'New-Api-User': 'Bearer your_user_id'
  }  
});  
const data = await response.json();
✅ 成功响应示例：
{  
  "success": true,  
  "message": "",  
  "data": {  
    "items": [  
      {  
        "id": 1,  
        "username": "testuser",  
        "display_name": "Test User",  
        "role": 1,  
        "status": 1,  
        "email": "test@example.com",  
        "group": "default"  
      }  
    ],  
    "total": 1,  
    "page": 1,  
    "page_size": 20  
  }  
}
❗ 失败响应示例：
{  
  "success": false,  
  "message": "搜索用户失败"  
}
🧾 字段说明：

获取单个用户信息

💡 请求示例：
const response = await fetch('/api/user/123', {  
  method: 'GET',  
  headers: {  
    'Content-Type': 'application/json',  
    'Authorization': 'Bearer your_admin_token',
    'New-Api-User': 'Bearer your_user_id'
  }  
});  
const data = await response.json();
✅ 成功响应示例：
{  
  "success": true,  
  "message": "",  
  "data": {  
    "id": 123,  
    "username": "targetuser",  
    "display_name": "Target User",  
    "role": 1,  
    "status": 1,  
    "email": "target@example.com",  
    "group": "default",  
    "quota": 1000000,  
    "used_quota": 50000,  
    "request_count": 100,  
    "aff_code": "ABC123",  
    "aff_count": 5  
  }  
}
❗ 失败响应示例：
{  
  "success": false,  
  "message": "无权获取同级或更高等级用户的信息"  
}
🧾 字段说明：

创建用户

💡 请求示例：
const response = await fetch('/api/user/', {  
  method: 'POST',  
  headers: {  
    'Content-Type': 'application/json',  
    'Authorization': 'Bearer your_admin_token',
    'New-Api-User': 'Bearer your_user_id' 
  },  
  body: JSON.stringify({  
    username: "newuser",  
    password: "password123",  
    display_name: "New User",  
    role: 1  
  })  
});  
const data = await response.json();
✅ 成功响应示例：
{  
  "success": true,  
  "message": ""  
}
❗ 失败响应示例：
{  
  "success": false,  
  "message": "无法创建权限大于等于自己的用户"  
}
🧾 字段说明：

冻结/重置等管理操作

💡 请求示例：
const response = await fetch('/api/user/manage', {  
  method: 'POST',  
  headers: {  
    'Content-Type': 'application/json',  
    'Authorization': 'Bearer your_admin_token',
    'New-Api-User': 'Bearer your_user_id'
  },  
  body: JSON.stringify({  
    id: 123,  
    action: "disable"  
  })  
});  
const data = await response.json();
✅ 成功响应示例：
{  
  "success": true,  
  "message": ""  
}
❗ 失败响应示例：
{  
  "success": false,  
  "message": "无法禁用超级管理员用户"  
}
🧾 字段说明：

更新用户

💡 请求示例：
const response = await fetch('/api/user/', {  
  method: 'PUT',  
  headers: {  
    'Content-Type': 'application/json',  
    'Authorization': 'Bearer your_admin_token',
    'New-Api-User': 'Bearer your_user_id'
  },  
  body: JSON.stringify({  
    id: 123,  
    username: "updateduser",  
    display_name: "Updated User",  
    email: "updated@example.com",  
    quota: 2000000,  
    role: 1,  
    status: 1  
  })  
});  
const data = await response.json();
✅ 成功响应示例：
{  
  "success": true,  
  "message": ""  
}
❗ 失败响应示例：
{  
  "success": false,  
  "message": "无权更新同权限等级或更高权限等级的用户信息"  
}
🧾 字段说明：

删除用户

💡 请求示例：
const response = await fetch('/api/user/123', {  
  method: 'DELETE',  
  headers: {  
    'Content-Type': 'application/json',  
    'Authorization': 'Bearer your_admin_token',
    'New-Api-User': 'Bearer your_user_id'
  }  
});  
const data = await response.json();
✅ 成功响应示例：
{  
  "success": true,  
  "message": ""  
}
❗ 失败响应示例：
{  
  "success": false,  
  "message": "无权删除同权限等级或更高权限等级的用户"  
}
🧾 字段说明：
前端接口

Token 管理模块

功能说明

接口前缀为：

  1. 主站：https://ai.burncloud.com
  2. 企业站：https://b.burncloud.com

用户 API Token 的完整管理系统。支持 Token 创建、更新、删除、批量操作等功能。包含模型限制、IP 限制、配额管理、过期时间等精细化控制。前端 Token 页面的核心数据来源。

🔐 用户鉴权

获取全部 Token

💡 请求示例：

const response = await fetch('/api/token/?p=1&size=20', {  
  method: 'GET',  
  headers: {  
    'Content-Type': 'application/json',  
    'Authorization': 'Bearer your_user_token',
    'New-Api-User': 'Bearer your_user_id'
  }  
});  
const data = await response.json();

✅ 成功响应示例：

{  
  "success": true,  
  "message": "",  
  "data": {  
    "items": [  
      {  
        "id": 1,  
        "name": "API Token",  
        "key": "<YOUR_API_KEY>",  
        "status": 1,  
        "remain_quota": 1000000,  
        "unlimited_quota": false,  
        "expired_time": 1640995200,  
        "created_time": 1640908800,  
        "accessed_time": 1640995000  
      }  
    ],  
    "total": 5,  
    "page": 1,  
    "page_size": 20  
  }  
}

❗ 失败响应示例：

{  
  "success": false,  
  "message": "获取Token列表失败"  
}

🧾 字段说明：

搜索 Token

💡 请求示例：

const response = await fetch('/api/token/search?keyword=api&token=sk-123', {  
  method: 'GET',  
  headers: {  
    'Content-Type': 'application/json',  
    'Authorization': 'Bearer your_user_token',
    'New-Api-User': 'Bearer your_user_id'
  }  
});  
const data = await response.json();

✅ 成功响应示例：

{  
  "success": true,  
  "message": "",  
  "data": [  
    {  
      "id": 1,  
      "name": "API Token",  
      "key": "sk-your-token-placeholder",  
      "status": 1,  
      "remain_quota": 1000000  
    }  
  ]  
}

❗ 失败响应示例：

{  
  "success": false,  
  "message": "搜索Token失败"  
}

🧾 字段说明：

获取单个 Token

💡 请求示例：

const response = await fetch('/api/token/123', {  
  method: 'GET',  
  headers: {  
    'Content-Type': 'application/json',  
    'Authorization': 'Bearer your_user_token',
    'New-Api-User': 'Bearer your_user_id'
  }  
});  
const data = await response.json();

✅ 成功响应示例：

{  
  "success": true,  
  "message": "",  
  "data": {  
    "id": 123,  
    "name": "API Token",  
    "key": "sk-your-token-placeholder",  
    "status": 1,  
    "remain_quota": 1000000,  
    "unlimited_quota": false,  
    "model_limits_enabled": true,  
    "model_limits": "gpt-3.5-turbo,gpt-4",  
    "allow_ips": "192.168.1.1,10.0.0.1",  
    "group": "default",  
    "expired_time": 1640995200,  
    "created_time": 1640908800,  
    "accessed_time": 1640995000  
  }  
}

❗ 失败响应示例：

{  
  "success": false,  
  "message": "Token不存在"  
}

🧾 字段说明：

创建 Token

💡 请求示例：

const response = await fetch('/api/token/', {  
  method: 'POST',  
  headers: {  
    'Content-Type': 'application/json',  
    'Authorization': 'Bearer your_user_token',
    'New-Api-User': 'Bearer your_user_id'
  },  
  body: JSON.stringify({  
    name: "My API Token",  
    expired_time: 1640995200,  
    remain_quota: 1000000,  
    unlimited_quota: false,  
    model_limits_enabled: true,  
    model_limits: ["gpt-3.5-turbo", "gpt-4"],  
    allow_ips: "192.168.1.1,10.0.0.1",  
    group: "default"  
  })  
});  
const data = await response.json();

✅ 成功响应示例：

{  
  "success": true,  
  "message": ""  
}

❗ 失败响应示例：

{  
  "success": false,  
  "message": "令牌名称过长"  
}

🧾 字段说明：

更新 Token

💡 请求示例（完整更新）：

const response = await fetch('/api/token/', {  
  method: 'PUT',  
  headers: {  
    'Content-Type': 'application/json',  
    'Authorization': 'Bearer your_user_token',
    'New-Api-User': 'Bearer your_user_id' 
  },  
  body: JSON.stringify({  
    id: 123,  
    name: "Updated Token",  
    expired_time: 1640995200,  
    remain_quota: 2000000,  
    unlimited_quota: false,  
    model_limits_enabled: true,  
    model_limits: ["gpt-3.5-turbo", "gpt-4"],  
    allow_ips: "192.168.1.1",  
    group: "vip"  
  })  
});  
const data = await response.json();

💡 请求示例（仅更新状态）：

const response = await fetch('/api/token/?status_only=true', {  
  method: 'PUT',  
  headers: {  
    'Content-Type': 'application/json',  
    'Authorization': 'Bearer your_user_token',
    'New-Api-User': 'Bearer your_user_id'
  },  
  body: JSON.stringify({  
    id: 123,  
    status: 1  
  })  
});  
const data = await response.json();

✅ 成功响应示例：

{  
  "success": true,  
  "message": "",  
  "data": {  
    "id": 123,  
    "name": "Updated Token",  
    "status": 1  
  }  
}

❗ 失败响应示例：

{  
  "success": false,  
  "message": "令牌已过期，无法启用，请先修改令牌过期时间，或者设置为永不过期"  
}

🧾 字段说明：

删除 Token

💡 请求示例：

const response = await fetch('/api/token/123', {  
  method: 'DELETE',  
  headers: {  
    'Content-Type': 'application/json',  
    'Authorization': 'Bearer your_user_token',
    'New-Api-User': 'Bearer your_user_id' 
  }  
});  
const data = await response.json();

✅ 成功响应示例：

{  
  "success": true,  
  "message": ""  
}

❗ 失败响应示例：

{  
  "success": false,  
  "message": "Token不存在"  
}

🧾 字段说明：

批量删除 Token

💡 请求示例：

const response = await fetch('/api/token/batch', {  
  method: 'POST',  
  headers: {  
    'Content-Type': 'application/json',  
    'Authorization': 'Bearer your_user_token',
    'New-Api-User': 'Bearer your_user_id'
  },  
  body: JSON.stringify({  
    ids: [1, 2, 3, 4, 5]  
  })  
});  
const data = await response.json();

✅ 成功响应示例：

{  
  "success": true,  
  "message": "",  
  "data": 5  
}

❗ 失败响应示例：

{  
  "success": false,  
  "message": "参数错误"  
}

🧾 字段说明：

前端接口

令牌用量查询（Token Usage）API 文档

功能说明

通过认证查询当前 Bearer Token 的额度使用情况：授予总量、已用、剩余、是否无限、模型限额及到期时间。

📮 端点

GET /api/usage/token

🔐 鉴权

在请求头中包含以下内容进行 API 密钥认证：

Authorization: Bearer $NEWAPI_API_KEY

💡 请求示例

curl -X GET https://ai.burncloud.com/api/usage/token \
  -H "Authorization: Bearer $NEWAPI_API_KEY"

✅ 成功响应示例

{
  "code": true,
  "message": "ok",
  "data": {
    "object": "token_usage",
    "name": "Default Token",
    "total_granted": 1000000,
    "total_used": 12345,
    "total_available": 987655,
    "unlimited_quota": false,
    "model_limits": {
      "gpt-4o-mini": true
    },
    "model_limits_enabled": false,
    "expires_at": 0
  }
}

❗ 错误响应示例

缺少鉴权头：

{
  "success": false,
  "message": "No Authorization header"
}

非 Bearer 方案：

{
  "success": false,
  "message": "Invalid Bearer token"
}

Token 查找失败（例如无效或已删除）：

{
  "success": false,
  "message": "token not found"
}

🧾 字段说明（data）

字段 描述
object 固定为 token_usage
name 令牌名称
total_granted 授予总量（= 已用 + 剩余）
total_used 已使用额度
total_available 可用剩余额度
unlimited_quota 是否为无限额度
model_limits 允许使用的模型列表
model_limits_enabled 是否启用模型限额
expires_at 到期时间的 Unix 时间戳（秒）。若永不过期返回 0（由后端将 -1 归一化为 0）
前端接口

日志模块

功能说明

接口前缀为：

  1. 主站：https://ai.burncloud.com
  2. 企业站：https://b.burncloud.com

分层的日志查询系统，支持管理员查看全站日志和用户查看个人日志。提供实时统计（RPM/TPM）、多维度过滤、历史数据清理等功能。支持 CORS 的 Token 查询接口便于第三方集成。

🔐 无需鉴权

根据 Token 查询日志

💡 请求示例：

const response = await fetch('/api/log/token?key=<TOKEN_PLACEHOLDER>', {  
  method: 'GET',  
  headers: {  
    'Content-Type': 'application/json'  
  }  
});  
const data = await response.json();

✅ 成功响应示例：

{  
  "success": true,  
  "message": "",  
  "data": [  
    {  
      "id": 1,  
      "type": 2,  
      "content": "API调用成功",  
      "model_name": "gpt-4",  
      "quota": 1000,  
      "created_at": 1640995000  
    }  
  ]  
}

❗ 失败响应示例：

{  
  "success": false,  
  "message": "Token不存在或无权限"  
}

🧾 字段说明：

🔐 用户鉴权

我的日志统计

💡 请求示例：

const response = await fetch('/api/log/self/stat?type=2&start_timestamp=1640908800&end_timestamp=1640995200&token_name=api_token&model_name=gpt-4&group=default', {  
  method: 'GET',  
  headers: {  
    'Content-Type': 'application/json',  
    'Authorization': 'Bearer your_user_token',
    'New-Api-User': 'Bearer your_user_id'
  }  
});  
const data = await response.json();

✅ 成功响应示例：

{  
  "success": true,  
  "message": "",  
  "data": {  
    "quota": 50000,  
    "rpm": 10,  
    "tpm": 1500  
  }  
}

❗ 失败响应示例：

{  
  "success": false,  
  "message": "获取统计信息失败"  
}

🧾 字段说明：

获取我的日志

💡 请求示例：

const response = await fetch('/api/log/self?p=1&page_size=20&type=2&start_timestamp=1640908800&end_timestamp=1640995200&token_name=api_token&model_name=gpt-4&group=default', {  
  method: 'GET',  
  headers: {  
    'Content-Type': 'application/json',  
    'Authorization': 'Bearer your_user_token',
    'New-Api-User': 'Bearer your_user_id'
  }  
});  
const data = await response.json();

✅ 成功响应示例：

{  
  "success": true,  
  "message": "",  
  "data": {  
    "items": [  
      {  
        "id": 1,  
        "user_id": 1,  
        "created_at": 1640995000,  
        "type": 2,  
        "content": "API调用成功",  
        "token_name": "api_token",  
        "model_name": "gpt-4",  
        "quota": 1000,  
        "prompt_tokens": 50,  
        "completion_tokens": 100  
      }  
    ],  
    "total": 25,  
    "page": 1,  
    "page_size": 20  
  }  
}

❗ 失败响应示例：

{  
  "success": false,  
  "message": "获取日志失败"  
}

🧾 字段说明：

请求参数与获取全部日志接口相同，但只返回当前用户的日志记录

搜索我的日志

💡 请求示例：

const response = await fetch('/api/log/self/search?keyword=gpt-4', {  
  method: 'GET',  
  headers: {  
    'Content-Type': 'application/json',  
    'Authorization': 'Bearer your_user_token',
    'New-Api-User': 'Bearer your_user_id'
  }  
});  
const data = await response.json();

✅ 成功响应示例：

{  
  "success": true,  
  "message": "",  
  "data": [  
    {  
      "id": 1,  
      "type": 2,  
      "content": "GPT-4调用成功",  
      "model_name": "gpt-4",  
      "created_at": 1640995000  
    }  
  ]  
}

❗ 失败响应示例：

{  
  "success": false,  
  "message": "搜索日志失败"  
}

🧾 字段说明：

🔐 管理员鉴权

获取全部日志

💡 请求示例：

const response = await fetch('/api/log/?p=1&page_size=20&type=2&start_timestamp=1640908800&end_timestamp=1640995200&username=testuser&token_name=api_token&model_name=gpt-4&channel=1&group=default', {  
  method: 'GET',  
  headers: {  
    'Content-Type': 'application/json',  
    'Authorization': 'Bearer your_admin_token',
    'New-Api-User': 'Bearer your_user_id'
  }  
});  
const data = await response.json();

✅ 成功响应示例：

{  
  "success": true,  
  "message": "",  
  "data": {  
    "items": [  
      {  
        "id": 1,  
        "user_id": 1,  
        "created_at": 1640995000,  
        "type": 2,  
        "content": "API调用成功",  
        "username": "testuser",  
        "token_name": "api_token",  
        "model_name": "gpt-4",  
        "quota": 1000,  
        "prompt_tokens": 50,  
        "completion_tokens": 100,  
        "use_time": 2,  
        "is_stream": false,  
        "channel_id": 1,  
        "channel_name": "OpenAI渠道",  
        "token_id": 1,  
        "group": "default",  
        "ip": "192.168.1.1",  
        "other": "{\"model_ratio\":15.0}"  
      }  
    ],  
    "total": 100,  
    "page": 1,  
    "page_size": 20  
  }  
}

❗ 失败响应示例：

{  
  "success": false,  
  "message": "获取日志失败"  
}

🧾 字段说明：

删除历史日志

💡 请求示例：

const response = await fetch('/api/log/?target_timestamp=1640908800', {  
  method: 'DELETE',  
  headers: {  
    'Content-Type': 'application/json',  
    'Authorization': 'Bearer your_admin_token',
    'New-Api-User': 'Bearer your_user_id'
  }  
});  
const data = await response.json();

✅ 成功响应示例：

{  
  "success": true,  
  "message": "",  
  "data": 1500  
}

❗ 失败响应示例：

{  
  "success": false,  
  "message": "target timestamp is required"  
}

🧾 字段说明：

日志统计

💡 请求示例：

const response = await fetch('/api/log/stat?type=2&start_timestamp=1640908800&end_timestamp=1640995200&username=testuser&token_name=api_token&model_name=gpt-4&channel=1&group=default', {  
  method: 'GET',  
  headers: {  
    'Content-Type': 'application/json',  
    'Authorization': 'Bearer your_admin_token',
    'New-Api-User': 'Bearer your_user_id' 
  }  
});  
const data = await response.json();

✅ 成功响应示例：

{  
  "success": true,  
  "message": "",  
  "data": {  
    "quota": 150000,  
    "rpm": 25,  
    "tpm": 3500  
  }  
}

❗ 失败响应示例：

{  
  "success": false,  
  "message": "获取统计信息失败"  
}

🧾 字段说明：

请求参数与获取全部日志接口相同

搜索全部日志

💡 请求示例：

const response = await fetch('/api/log/search?keyword=error', {  
  method: 'GET',  
  headers: {  
    'Content-Type': 'application/json',  
    'Authorization': 'Bearer your_admin_token',
    'New-Api-User': 'Bearer your_user_id'
  }  
});  
const data = await response.json();

✅ 成功响应示例：

{  
  "success": true,  
  "message": "",  
  "data": [  
    {  
      "id": 1,  
      "type": 4,  
      "content": "API调用错误",  
      "username": "testuser",  
      "created_at": 1640995000  
    }  
  ]  
}

❗ 失败响应示例：

{  
  "success": false,  
  "message": "搜索日志失败"  
}

🧾 字段说明：

前端接口

数据统计模块

功能说明

接口前缀为：

  1. 主站：https://ai.burncloud.com
  2. 企业站：https://b.burncloud.com

用量数据的聚合统计系统。管理员可查看全站统计，用户可查看个人统计。数据按模型和日期分组，用于生成图表和报表，监控系统使用趋势。

🔐 用户鉴权

我的用量按日期统计

💡 请求示例：

const response = await fetch('/api/data/self?start_timestamp=1640908800&end_timestamp=1640995200', {  
  method: 'GET',  
  headers: {  
    'Content-Type': 'application/json',  
    'Authorization': 'Bearer your_user_token',
    'New-Api-User': 'Bearer your_user_id'
  }  
});  
const data = await response.json();

✅ 成功响应示例：

{  
  "success": true,  
  "message": "",  
  "data": [  
    {  
      "model_name": "gpt-3.5-turbo",  
      "count": 25,  
      "quota": 12500,  
      "token_used": 2000,  
      "created_at": 1640995200,  
      "user_id": 1,  
      "username": "testuser"  
    },  
    {  
      "model_name": "gpt-4",  
      "count": 10,  
      "quota": 30000,  
      "token_used": 1500,  
      "created_at": 1640995200,  
      "user_id": 1,  
      "username": "testuser"  
    }  
  ]  
}

❗ 失败响应示例：

{  
  "success": false,  
  "message": "获取个人统计数据失败"  
}

🧾 字段说明：

🔐 管理员鉴权

全站用量按日期统计

💡 请求示例：

const response = await fetch('/api/data/?start_timestamp=1640908800&end_timestamp=1640995200&username=testuser', {  
  method: 'GET',  
  headers: {  
    'Content-Type': 'application/json',  
    'Authorization': 'Bearer your_admin_token',
    'New-Api-User': 'Bearer your_user_id'
  }  
});  
const data = await response.json();

✅ 成功响应示例：

{  
  "success": true,  
  "message": "",  
  "data": [  
    {  
      "model_name": "gpt-3.5-turbo",  
      "count": 150,  
      "quota": 75000,  
      "token_used": 12500,  
      "created_at": 1640995200  
    },  
    {  
      "model_name": "gpt-4",  
      "count": 50,  
      "quota": 150000,  
      "token_used": 8000,  
      "created_at": 1640995200  
    }  
  ]  
}

❗ 失败响应示例：

{  
  "success": false,  
  "message": "获取统计数据失败"  
}

🧾 字段说明：

前端接口

Midjourney 任务模块

功能说明

接口前缀为：

  1. 主站：https://ai.burncloud.com
  2. 企业站：https://b.burncloud.com

图像生成任务的管理系统。支持任务状态跟踪、进度监控、结果查看等功能。包含图片 URL 转发和后台轮询更新机制。

🔐 用户鉴权

获取自己的 MJ 任务

💡 请求示例：

const response = await fetch('/api/mj/self?p=1&page_size=20&mj_id=task123&start_timestamp=1640908800&end_timestamp=1640995200', {  
  method: 'GET',  
  headers: {  
    'Content-Type': 'application/json',  
    'Authorization': 'Bearer your_user_token',
    'New-Api-User': 'Bearer your_user_id'
  }  
});  
const data = await response.json();

✅ 成功响应示例：

{  
  "success": true,  
  "message": "",  
  "data": {  
    "items": [  
      {  
        "id": 1,  
        "mj_id": "task123456",  
        "action": "IMAGINE",  
        "prompt": "a beautiful landscape",  
        "prompt_en": "a beautiful landscape",  
        "status": "SUCCESS",  
        "progress": "100%",  
        "image_url": "https://example.com/image.jpg",  
        "video_url": "https://example.com/video.mp4",  
        "video_urls": "[\"https://example.com/video1.mp4\"]",  
        "submit_time": 1640908800,  
        "start_time": 1640909000,  
        "finish_time": 1640909200,  
        "fail_reason": "",  
        "quota": 1000  
      }  
    ],  
    "total": 25,  
    "page": 1,  
    "page_size": 20  
  }  
}

❗ 失败响应示例：

{  
  "success": false,  
  "message": "获取任务列表失败"  
}

🧾 字段说明：

返回字段说明：

🔐 管理员鉴权

获取全部 MJ 任务

💡 请求示例：

const response = await fetch('/api/mj/?p=1&page_size=20&channel_id=1&mj_id=task123&start_timestamp=1640908800&end_timestamp=1640995200', {  
  method: 'GET',  
  headers: {  
    'Content-Type': 'application/json',  
    'Authorization': 'Bearer your_admin_token',
    'New-Api-User': 'Bearer your_user_id'
  }  
});  
const data = await response.json();

✅ 成功响应示例：

{  
  "success": true,  
  "message": "",  
  "data": {  
    "items": [  
      {  
        "id": 1,  
        "user_id": 1,  
        "mj_id": "task123456",  
        "action": "IMAGINE",  
        "prompt": "a beautiful landscape",  
        "status": "SUCCESS",  
        "progress": "100%",  
        "image_url": "https://example.com/image.jpg",  
        "channel_id": 1,  
        "quota": 1000,  
        "submit_time": 1640908800,  
        "finish_time": 1640909200  
      }  
    ],  
    "total": 100,  
    "page": 1,  
    "page_size": 20  
  }  
}

❗ 失败响应示例：

{  
  "success": false,  
  "message": "获取任务列表失败"  
}

🧾 字段说明：

返回字段包含用户自身任务的所有字段，另外增加：

前端接口

任务中心模块

功能说明

接口前缀为：

  1. 主站：https://ai.burncloud.com
  2. 企业站：https://b.burncloud.com

通用异步任务管理系统。主要支持 Suno 等平台的音乐生成任务。包含任务状态自动更新、失败重试、配额退还等机制。

🔐 用户鉴权

获取我的任务

💡 请求示例：

const response = await fetch('/api/task/self?p=1&page_size=20&platform=suno&task_id=task123&status=SUCCESS&action=song&start_timestamp=1640908800&end_timestamp=1640995200', {  
  method: 'GET',  
  headers: {  
    'Content-Type': 'application/json',  
    'Authorization': 'Bearer your_user_token',
    'New-Api-User': 'Bearer your_user_id'
  }  
});  
const data = await response.json();

✅ 成功响应示例：

{  
  "success": true,  
  "message": "",  
  "data": {  
    "items": [  
      {  
        "id": 1,  
        "created_at": 1640908800,  
        "updated_at": 1640909000,  
        "task_id": "task123456",  
        "platform": "suno",  
        "user_id": 1,  
        "quota": 1000,  
        "action": "song",  
        "status": "SUCCESS",  
        "fail_reason": "",  
        "submit_time": 1640908800,  
        "start_time": 1640908900,  
        "finish_time": 1640909000,  
        "progress": "100%",  
        "properties": {},  
        "data": {}  
      }  
    ],  
    "total": 25,  
    "page": 1,  
    "page_size": 20  
  }  
}

❗ 失败响应示例：

{  
  "success": false,  
  "message": "获取任务列表失败"  
}

🧾 字段说明：

🧾 返回字段说明：

🔐 管理员鉴权

获取全部任务

💡 请求示例：

const response = await fetch('/api/task/?p=1&page_size=20&channel_id=1&platform=suno&task_id=task123&status=SUCCESS&action=song&start_timestamp=1640908800&end_timestamp=1640995200', {  
  method: 'GET',  
  headers: {  
    'Content-Type': 'application/json',  
    'Authorization': 'Bearer your_admin_token',
    'New-Api-User': 'Bearer your_user_id'
  }  
});  
const data = await response.json();

✅ 成功响应示例：

{  
  "success": true,  
  "message": "",  
  "data": {  
    "items": [  
      {  
        "id": 1,  
        "created_at": 1640908800,  
        "task_id": "task123456",  
        "platform": "suno",  
        "user_id": 1,  
        "channel_id": 1,  
        "quota": 1000,  
        "action": "song",  
        "status": "SUCCESS",  
        "submit_time": 1640908800,  
        "finish_time": 1640909000,  
        "progress": "100%",  
        "data": {}  
      }  
    ],  
    "total": 100,  
    "page": 1,  
    "page_size": 20  
  }  
}

❗ 失败响应示例：

{  
  "success": false,  
  "message": "获取任务列表失败"  
}

🧾 字段说明：

返回字段包含用户任务的所有字段，另外增加：

前端接口

账户计费面板模块

功能说明

接口前缀为：

  1. 主站：https://ai.burncloud.com
  2. 企业站：https://b.burncloud.com

OpenAI SDK 兼容的计费查询接口。使用 Token 认证，提供订阅信息和使用量查询。主要用于第三方应用和 SDK 集成，确保与 OpenAI API 的完全兼容性。

🔐 用户鉴权

获取订阅额度信息

💡 请求示例：

const response = await fetch('/dashboard/billing/subscription', {  
  method: 'GET',  
  headers: {  
    'Content-Type': 'application/json',  
    'Authorization': 'Bearer your_user_token',
    'New-Api-User': 'Bearer your_user_id'
  }  
});  
const data = await response.json();

✅ 成功响应示例：

{  
  "object": "billing_subscription",  
  "has_payment_method": true,  
  "soft_limit_usd": 100.0,  
  "hard_limit_usd": 100.0,  
  "system_hard_limit_usd": 100.0,  
  "access_until": 1640995200  
}

❗ 失败响应示例：

{  
  "error": {  
    "message": "获取配额失败",  
    "type": "upstream_error"  
  }  
}

🧾 字段说明：

兼容 OpenAI SDK 路径 - 获取订阅额度信息

💡 请求示例：

const response = await fetch('/v1/dashboard/billing/subscription', {  
  method: 'GET',  
  headers: {  
    'Content-Type': 'application/json',  
    'Authorization': 'Bearer your_user_token',
    'New-Api-User': 'Bearer your_user_id'
  }  
});  
const data = await response.json();

✅ 成功响应示例：

{  
  "object": "billing_subscription",  
  "has_payment_method": true,  
  "soft_limit_usd": 100.0,  
  "hard_limit_usd": 100.0,  
  "system_hard_limit_usd": 100.0,  
  "access_until": 1640995200  
}

❗ 失败响应示例：

{  
  "error": {  
    "message": "获取配额失败",  
    "type": "upstream_error"  
  }  
}

🧾 字段说明：

获取使用量信息

💡 请求示例：

const response = await fetch('/dashboard/billing/usage', {  
  method: 'GET',  
  headers: {  
    'Content-Type': 'application/json',  
    'Authorization': 'Bearer your_user_token',
    'New-Api-User': 'Bearer your_user_id'
  }  
});  
const data = await response.json();

✅ 成功响应示例：

{  
  "object": "list",  
  "total_usage": 2500.0  
}

❗ 失败响应示例：

{  
  "error": {  
    "message": "获取使用量失败",  
    "type": "new_api_error"  
  }  
}

🧾 字段说明：

兼容 OpenAI SDK 路径 - 获取使用量信息

💡 请求示例：

const response = await fetch('/v1/dashboard/billing/usage', {  
  method: 'GET',  
  headers: {  
    'Content-Type': 'application/json',  
    'Authorization': 'Bearer your_user_token',
    'New-Api-User': 'Bearer your_user_id'
  }  
});  
const data = await response.json();

✅ 成功响应示例：

{  
  "object": "list",  
  "total_usage": 2500.0  
}

❗ 失败响应示例：

{  
  "error": {  
    "message": "获取使用量失败",  
    "type": "new_api_error"  
  }  
}

🧾 字段说明：