Back to API List
Real-time Chat API
Communication
4 Endpoints
WebSocket-based chat with rooms, typing indicators, message history, and user presence.
Internal API - Hosted by this App
API Endpoints & Usage
Explore and interact with the available endpoints for the Real-time Chat API. These API routes are live!
GET
/api/chat/rooms
List available chat rooms with participant counts.
Try it out
You can add or change query parameters in the path above (e.g., ?name=User).
POST
/api/chat/rooms
Create new chat room with customizable settings.
Try it out
GET
/api/chat/rooms/{roomId}/messages
Get message history for room with pagination. Replace {roomId} with an actual ID.
Try it out
Replace placeholders (e.g., {userId}) with actual values in the path above. You can also add/edit query parameters (e.g., ?key=value).
POST
/api/chat/rooms/{roomId}/messages
Send message to chat room. Replace {roomId} with an actual ID.
Try it out
Replace placeholders (e.g., {userId}) with actual values in the path above.