Plexichat Backend Documentation

This portal documents the Plexichat backend runtime surface: the REST API, the WebSocket gateway, common response shapes, and integration guidance.

Documentation Surfaces

• Getting Started
• API Reference
• WebSocket Gateway
• Deployment Guide
• Client Development
• End-User Guide
• generated OpenAPI docs at /docs
• raw schema at /openapi.json

Runtime Endpoints

• REST API base: http://api.plexichat.com/api/v1
• WebSocket gateway: ws://api.plexichat.com/gateway
• Health check: /health
• Version endpoints: /api/v1/version, /api/v1/version/negotiate, /api/v1/status

What This Portal Covers

• authentication, sessions, and capability discovery
• users, relationships, servers, channels, and messages
• reactions, presence, notifications, polls, voice, media, and reports
• shared behaviors such as rate limits, common errors, and WebSocket lifecycle rules

Suggested Reading Order

1. Getting Started
2. Configuration
3. Deployment Guide
4. API Reference
5. WebSocket Gateway
6. Client Development
7. End-User Guide
8. Rate Limits
9. Security