Connexa API Docs

Connexa ships with a REST API and Socket.IO layer that the React agent console uses in production. Every endpoint returns JSON, expects bearer tokens, and emits realtime updates over sockets.

Base URL

https://api.connexa.chat

Auth

Bearer token (JWT) obtained from /api/auth/login

SDKs

JavaScript (fetch/axios). Community SDKs coming soon.

Key endpoints

POST/api/auth/loginAuthenticate

Exchange user credentials for a JWT used across chat, media, and push endpoints.

GET/api/chatList chats

Return chats for the authenticated user, including participants, status, and last message.

POST/api/messagesSend message

Send text, image, voice, file, or location messages to a chat and broadcast via Socket.IO.

GET/api/messages/chat/{chatId}Fetch chat history

Retrieve chat history with replies, reactions, read receipts, and pagination support.

POST/api/media/uploadUpload media

Upload images, voice notes, and files. Returns a URL usable inside subsequent messages.

PATCH/api/chat/{chatId}/statusUpdate chat status

Allow staff/admin roles to mark chats as open, assigned, in_progress, resolved, or closed.

Authentication

Use the `/api/auth/login` route with email and password to retrieve a JWT. Include it in an `Authorization: Bearer` <token> header for all subsequent requests. Tokens expire in 24 hours; refresh by logging in again or enable API keys via `/api/api-keys` for service-based access.

Rate limits

Express rate limiting protects key routes. Default limits: 300 requests per 5 minutes on `/api/messages`, 100 requests per 5 minutes on `/api/auth`, and configurable upload ceilings. Check response headers such as `x-ratelimit-remaining` to monitor usage.

Developer resources

Explore the included Postman collection, Socket.IO event catalogue, and example React hooks in the Connexa repository. Need something specific? Email platform@connexa.chat and we'll share internal docs or walk through the integration.