API Reference
This is the complete HTTP API, generated from the server's OpenAPI
specification (via utoipa) and rendered with
Scalar. The specification is regenerated on
every docs build, so it always matches the running node. For request signing,
the message lifecycle, and end-to-end examples, read
Building a Client first.
The interactive explorer below loads its viewer from a CDN, so it needs network access to render. Offline, use the raw specification at
openapi.json, or the Swagger UI served by any running node at/swagger-ui.
Open the interactive API reference in full screen →
Endpoints at a glance
| Method | Path | Description |
|---|---|---|
| GET | /conversations | List the caller's chats with unread counts |
| POST | /dialogs/{peer}/messages | Send a direct text message |
| POST | /dialogs/{peer}/messages/control | Send a direct control (E2EE) message |
| GET | /dialogs/{peer}/messages | Fetch direct message history (paginated) |
| POST | /dialogs/{peer}/messages/read | Mark direct messages as read |
| POST | /groups/{chat_id}/ops | Compound membership operations (create/add/remove) |
| DELETE | /groups/{chat_id}/membership | Leave a group |
| POST | /groups/{chat_id}/messages | Send a group text message |
| POST | /groups/{chat_id}/messages/control | Send a group control (E2EE) message |
| GET | /groups/{chat_id}/messages | Fetch group message history (paginated) |
| POST | /groups/{chat_id}/messages/read | Mark group messages as read |
| GET | /groups/{chat_id}/members | List group members and their roles |
| PUT | /identity | Publish the caller's identity blob |
| GET | /identity/{address} | Fetch a user's identity blob |
Every endpoint requires the authentication headers described in Building a Client and summarized in API Overview. See Cryptography & Authentication for the signing algorithm.