WebSocket V1 Quick Start Guide

Legacy — V1 remains supported but is not recommended for new integrations. Use V2 for new production work, or evaluate V3 (beta) if you need per-message MP4 delivery.

Get up and running with the V1 WebSocket API in minutes with this simple Hello World example.

Prerequisites

A WebSocket client (browser, Node.js, or any WebSocket-capable environment)
Access to wss://ai.api.production.signapsesolutions.com

Hello World

Select a language in the code panel to see the complete example. Each example connects, sends a “Hello World” translation request, and handles the response.

Understanding the Message

The minimal V1 message has two required fields:

action — Use "LiveTranslation" for simple, fast translations without rate limiting
sentence — The text you want to translate to sign language video

Add Output Format

Specify HLS or MP4 output by adding a metadata object:


{
  "action": "LiveTranslation",
  "sentence": "Hello World",
  "metadata": {
    "responseFormat": "mp4"
  }
}

Common Issues

Problem	Solution
No response	Check that message is valid JSON
`"success": false`	Read the `message` field for error details

V1 Full Reference V2 Quick Start REST Quick Start

Request

// Install: npm install ws
const WebSocket = require('ws');

const ws = new WebSocket('wss://ai.api.production.signapsesolutions.com');

ws.on('open', () => {
    console.log('Connected!');

    const message = {
        action: "LiveTranslation",
        sentence: "Hello World"
    };

    ws.send(JSON.stringify(message));
    console.log('Sent: Hello World');
});

ws.on('message', (data) => {
    const response = JSON.parse(data);
    if (response.success) {
        console.log('Success:', response.message);
    } else {
        console.log('Error:', response.message);
    }
});

ws.on('error', (error) => {
    console.error('WebSocket Error:', error);
});

ws.on('close', () => {
    console.log('Connection closed');
});

Response

{
  "action": "LiveTranslation",
  "success": true,
  "message": "Video processing for Hello World"
}