SWAYAM API

🚀 Quick Start

Get started with SWAYAM in under a minute.

Option 1: Embed Widget (Easiest)

<script src="https://swayam.digimitra.guru/swayam-widget.js"
        data-persona="swayam"
        data-language="hi">
</script>

Option 2: NPM Package

npm install @swayam/sdk

// JavaScript/TypeScript
import { Swayam } from '@swayam/sdk';

const swayam = new Swayam({
  persona: 'wowtruck',
  language: 'hi'
});

swayam.on('response', (text, audio) => {
  console.log('AI:', text);
});

await swayam.connect();
await swayam.send('Delhi से Mumbai का route बताओ');

Option 3: Direct WebSocket

const ws = new WebSocket('wss://swayam.digimitra.guru/swayam');

ws.onopen = () => {
  ws.send(JSON.stringify({
    type: 'join',
    sessionId: 'my_session',
    userId: 'user_123',
    language: 'hi',
    persona: 'swayam'
  }));
};

ws.onmessage = (event) => {
  const msg = JSON.parse(event.data);
  console.log('Response:', msg);
};

// Send text
ws.send(JSON.stringify({ type: 'text', text: 'नमस्ते' }));

🔌 WebSocket API

Real-time bidirectional communication with voice AI.

Endpoints

Message Types

Join Message

{
  "type": "join",
  "sessionId": "unique_session_id",
  "userId": "user_123",
  "language": "hi",     // See Languages section
  "persona": "swayam",  // See Personas section
  "wakeWord": false,    // Enable wake word detection
  "streaming": true     // Enable streaming TTS
}

📡 REST API

Check service health and version.

Text-to-Speech synthesis.

// Request
{ "text": "नमस्ते", "language": "hi", "voice": "anushka" }

// Response
{ "audio": "base64...", "duration": 1.5, "voice": "anushka" }

List all available MCP tools.

Execute a specific MCP tool.

// Request
{ "tool": "gst_calc", "params": { "amount": 10000, "rate": 18 } }

// Response
{ "success": true, "result": { "totalAmount": "11800.00" } }

Get learning analytics and patterns.

Prometheus-compatible metrics.

🎭 AI Personas

8 specialized AI assistants for different use cases.

🌐 Supported Languages

11 Indian languages with TTS and STT support.

🔧 MCP Tools (53)

Integrated tools for compliance, logistics, finance, and more.

Compliance & Tax

gst_calc gst_verify hsn_lookup tds_calc income_tax pan_verify

Finance

emi_calc sip_calc calculator upi_send upi_verify

Logistics

logistics_search logistics_route logistics_compliance distance_calc toll_estimate

Fleet & Shipping

fleet_vehicles vehicle_position drivers trips container_track

Government APIs

vehicle_verify fastag pm_kisan epf_balance pincode_info

📦 SDK Installation

NPM

npm install @swayam/sdk

React

import { useSwayam, SwayamWidget } from '@swayam/sdk/react';

function App() {
  const { send, response, isConnected } = useSwayam({
    persona: 'wowtruck',
    language: 'hi'
  });

  return (
    <div>
      <p>{response}</p>
      <button onClick={() => send('Hello')}>Send</button>
      <SwayamWidget persona="swayam" language="hi" />
    </div>
  );
}

CDN (Browser)

<script src="https://swayam.digimitra.guru/swayam-widget.js"></script>
<script>
  SwayamWidget.open();
  SwayamWidget.send('नमस्ते');
</script>