PLEXICHATNarrative Docs
API Reference
Guides, route-group overviews, and live schema entry points for the Plexichat backend.
REST http://api.plexichat.com/api/v1Gateway ws://api.plexichat.com/gatewayVersion a.1.0-49
REST API Reference
This section organizes the backend REST API by route group. For exact request and response schemas, use the generated OpenAPI docs at /docs.
Base URL
All routes in this section are relative to https://api.plexichat.com.
Public Utility Endpoints
| Endpoint | Purpose |
|---|---|
GET /health | readiness and health signal |
GET /version | current backend version |
POST /version/negotiate | client compatibility negotiation |
GET /status | operational or maintenance status |
GET /capabilities | public runtime constants and feature hints |
GET /qr | local QR code generation |
Authenticated Product Areas
| Route group | Purpose |
|---|---|
| Authentication | registration, login, sessions, 2FA, recovery |
| Users | profiles, notes, presence, self-service user actions |
| Settings | synced user preference storage |
| Relationships | friends, blocks, and relationship state |
| Servers | servers, members, roles, invites, structure |
| Channels | channel management and channel-scoped actions |
| Messages | message CRUD, pins, acks, and attachments |
| Reactions | message reactions and reaction user lists |
| Presence | presence retrieval and updates |
| Webhooks | webhook management and execution |
| Avatars | user and server avatar endpoints |
| Emojis | custom emoji management |
| Features | public feature visibility plus admin-controlled tiers/badges |
Additional Route Groups
| Route group | Routes covered |
|---|---|
| Search | /search/messages, /search/users, /search/servers |
| Notifications | current-user notification reads and read markers |
| Polls | poll creation, voting, results, close, delete |
| Voice | ICE server discovery and voice channel info |
| Media | hash reporting, resumable upload sessions, compression status |
| Reports | user and message reporting |
| Feedback | feedback submission and status checks |
| Telemetry | response-time and CSP telemetry ingestion |
| System | capabilities, help pages, QR, health, status, version |
| Admin | operator-only admin authentication, review, security, telemetry, and UI routes |
Notes
- Some endpoints require normal authentication plus an API access token depending on server policy.
- The public narrative docs intentionally avoid private infrastructure and operator-only procedures.
- Administrative routes are mounted at a configurable root path and are documented separately in Admin.