API Reference

Text Translation · WebSocket

WSSwss://stream.shabd.tech/v1/text-translate

Connection headers

x-api-keystringrequired
API key for authentication.

Message flow

Outgoing Message (↑): The client sends a JSON object with the necessary parameters for text translation.
Incoming Message (↓): The server responds json with requestId, status, translation, chunk, completed, mode.

Send Message (↑):

{  "requestId": "a216e43a-9d81-444c-a9ae-3c1e400fcb02",  "text": "नमस्ते, आपका दिन शुभ हो!",  "sourceLanguage": "hindi",  "targetLanguage": "tamil"}

Initial messageapplication/json

requestIdstringrequired
Unique identifier for the request
textstringrequired
Text content to be translated
sourceLanguagestringrequired
Source Language of the text
targetLanguagestringrequired
Target language of the text

Server messages

101The server streams translated text along with status and progress updates.

Receive Translation (↓):

{  "requestId": "a216e43a-9d81-444c-a9ae-3c1e400fcb02",  "status": true,  "translation": "வணக்கம் இனிய நாள்!",  "chunk": 1,  "completed": false,  "mode": "ttt"}

When the translation is complete:

{  "requestId": "a216e43a-9d81-444c-a9ae-3c1e400fcb02",  "status": true,  "translation": "",  "chunk": 2,  "completed": true,  "mode": "ttt"}

Messages

Message Type	Example	Description
Send (↑)	`{ "requestId": "a216e43a-9d81-444c-a9ae-3c1e400fcb02", "text": "नमस्ते, आपका दिन शुभ हो!", "sourceLanguage": "hindi", "targetLanguage": "tamil" }`	The client sends parameters for getting the translated text.
Receive (↓)	`{ "requestId": "a216e43a-9d81-444c-a9ae-3c1e400fcb02", "status": true, "translation": "வணக்கம் இனிய நாள்!", "chunk": 1, "completed": false, "mode": "ttt" }`	The server sends translation along with status and progress updates.
Receive (↓)	`{ "requestId": "a216e43a-9d81-444c-a9ae-3c1e400fcb02", "status": true, "translation": "", "chunk": 2, "completed": true, "mode": "ttt" }`	The server sends completed message.

Example response

{  "requestId": "a216e43a-9d81-444c-a9ae-3c1e400fcb02",  "status": true,  "translation": "வணக்கம் இனிய நாள்!",  "chunk": 1,  "completed": false,  "mode": "ttt"} {  "requestId": "a216e43a-9d81-444c-a9ae-3c1e400fcb02",  "status": true,  "translation": "",  "chunk": 2,  "completed": true,  "mode": "ttt"}

Request

1from websockets.sync.client import connect2import json3 4api_key = "your_api_key"5 6url = f'wss://stream.shabd.tech/v1/text-translate'7headers = {"x-api-key": api_key}8 9metadata = {10    "requestId": "your_uuid_here",11    "text": "नमस्ते, आपका दिन शुभ हो!",12    "sourceLanguage": "hindi",13    "targetLanguage": "tamil"14}15 16with connect(url, additional_headers=headers) as ws:17    ws.send(json.dumps(metadata))18 19    for message in ws:20        response = json.loads(message)21        22        status = response.get("status", False)23        translation = response.get("translation", "")24        chunk = response.get("chunk") 25        completed = response.get("completed", False)26        27        if not status:28            print("Request Failed: ",response.get('message', 'Unknown Error'))29            break30        if translation:31            print(f"Translation {chunk}: {translation}") # chunk id and translation32        if completed:33            print("Translation completed")34            break

1const WebSocket = require('ws');2 3const api_key = "your_api_key";4const url = `wss://stream.shabd.tech/v1/text-translate`; 5const headers = {6  "x-api-key": api_key7};8 9const metadata = {10  requestId: "your_uuid_here",11  text: "नमस्ते, आपका दिन शुभ हो!",12  sourceLanguage: "hindi",13  targetLanguage: "tamil",14};15 16// Initialize WebSocket connection17const ws = new WebSocket(url, {18  headers: headers19});20 21ws.on('open', () => {22  ws.send(JSON.stringify(metadata));             23});24 25ws.on('message', (data) => {26  if (Buffer.isBuffer(data)) {27    try {28      const stringData = data.toString('utf8');29      if (stringData && stringData.startsWith("{") && stringData.endsWith("}")) {30        const response = JSON.parse(stringData);31        32        status = response.status;33        translation = response.translation;34        chunk = response.chunk;35        completed = response.completed;36      37        if (!status) 38          console.log("Request Failed: ", response.message || 'Unknown Error');39        40        if (translation) 41          console.log(`Translation ${chunk}: ${translation}`);42        43        if (completed) {44          console.log("Translation completed");45          ws.close();46        }47      } 48    } catch (err) {49      console.log("Error processing buffer: ", err);50    }51  } else {52    console.log("Unexpected data type received");53  }54});55 56ws.onerror = (error) => console.error('WebSocket error:', error);57ws.onclose = () => console.log('WebSocket connection closed');