WebSocket API

Real-time communication with MedAssist through WebSocket connection

WebSocket Endpoint

Connect to the MedAssist WebSocket for real-time medical consultations:

wss://matrix-ws.eka.care/ws/med-assist/session/<session-id>

Replace <session-id> with the session ID obtained from the Create Session API.

Authentication

After establishing the WebSocket connection, authenticate using the session token:

{
  "ev": "auth",
  "data": {
    "token": "{{matrix-token}}"
  }
}

Message Types

Text Messages

Send text-based medical queries:

{
  "ev": "chat",
  "ct": "text",
  "ts": 1757343458000,
  "_id": "1757343458010",
  "data": {
    "text": "I have a headache"
  }
}

Audio Messages

Send base64-encoded audio for voice consultations:

{
  "ev": "chat",
  "ct": "audio",
  "ts": 175510119698,
  "_id": "175510119699",
  "data": {
    "audio": "base64_encoded_audio_data",
    "audio_format": "audio/mp3"
  }
}

File Upload

File uploads require a two-step process:

Step 1: Request presigned URL

{
  "ev": "chat",
  "ct": "file",
  "_id": "175510119698"
}

Step 2: Send file URL after upload

{
  "ev": "chat",
  "ct": "file",
  "_id": "175510119698",
  "data": {
    "url": "presigned-url-after-upload"
  }
}

Message Fields

ev · string · required

Event type. Use “auth” for authentication, “chat” for messages

ct · string

Content type. Options: “text”, “audio”, “file”

ts · number

Timestamp in milliseconds

_id · string · required

Unique message identifier

data · object · required

Message payload containing the actual content

Example Implementation

JavaScript

const socket = new WebSocket('wss://matrix-ws.eka.care/ws/med-assist/session/your-session-id');

// Authenticate on connection
socket.onopen = function(event) {
  socket.send(JSON.stringify({
    "ev": "auth",
    "data": {
      "token": "your-session-token"
    }
  }));
};

// Send text message
function sendTextMessage(text) {
  const message = {
    "ev": "chat",
    "ct": "text",
    "ts": Date.now(),
    "_id": Date.now().toString(),
    "data": {
      "text": text
    }
  };
  socket.send(JSON.stringify(message));
}

// Handle responses
socket.onmessage = function(event) {
  const response = JSON.parse(event.data);
  console.log('Received:', response);
};

Error Handling

The WebSocket may return error messages for various scenarios:

• Authentication failure: Invalid or expired token
• Invalid message format: Malformed JSON or missing required fields
• Rate limiting: Too many messages sent in a short period
• Session expired: Session has exceeded its lifetime

Always implement proper error handling and reconnection logic in your WebSocket client.