SnowLuma

API 参考

从运行时动作目录生成的 OpenAPI:参数、应答、示例和试调

SnowLuma 的 HTTP API 与 OneBot v11 兼容。每个动作一页,由 OpenAPI 插件渲染:请求体、鉴权、应答信封、代码示例,以及对着你自己的实例试调。

怎么调用

  • 方法:POST /{动作名}
  • 请求体:Content-Type: application/json
  • 默认服务:http://127.0.0.1:3000/(同一 Docker 网络里用 http://snowluma:3000/)
  • 鉴权(配置了 token 时):Authorization: Bearer <token>,或查询参数 ?access_token=
  • WebSocket:ws://127.0.0.1:3001/,动作名与 HTTP 相同

应答信封

HTTP 200 仍可能是业务失败。看信封里的 retcode:

{
  "status": "ok",
  "retcode": 0,
  "data": {},
  "message": "",
  "wording": ""
}

retcode 为 0 才是成功。data 的形状见各动作页。

在文档里试调

打开任意动作页,填服务地址和 token,用试调面板直接发请求。请求发自你的浏览器,目标是你填的服务器,不是文档站。

MCP 客户端不必手写 HTTP,见 MCP。

全部动作

扩展

115 个动作

群管理

21 个动作

信息

5 个动作

群相册

9 个动作

流式接口

6 个动作

空间

9 个动作

群文件

12 个动作

好友

3 个动作

消息

6 个动作

系统表情

4 个动作

群信息

6 个动作

请求

2 个动作

这篇文档有帮助吗?

最后更新于

本页目录