API reference

SnowLuma's HTTP API is OneBot v11 compatible. Each action is one page, rendered by the OpenAPI plugin: request body, auth, the response envelope, code samples, and a try-it panel against your own instance.

Calling it

• Method: POST /{action}
• Body: Content-Type: application/json
• Default server: http://127.0.0.1:3000/ (on the same Docker network: http://snowluma:3000/)
• Auth (when a token is configured): Authorization: Bearer <token>, or ?access_token=
• WebSocket: ws://127.0.0.1:3001/, same action names as HTTP

Response envelope

HTTP 200 can still be a business failure. Read retcode:

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

Success is retcode 0. The shape of data is on each action page.

Try it from the docs

Open any action page, set the server URL and token, and send from the try-it panel. The browser talks to the server you entered, not to this documentation site.

MCP clients do not need handwritten HTTP. See MCP.

All actions