Relay Server

​

Setting up a Relay Server

​

1. Install Realtime Console

git clone https://github.com/soketlabs/realtime-console.git
cd realtime-console
npm install

​

2. Set environment variables for realtime-console

OPENAI_API_KEY=<your-api-key>

​

3. Start the Relay Server

cd realtime-console
npm run relay

​

Start using Tensorstudio Speech API through NodeJS SDK

​

Install NodeJS SDK

npm install https://github.com/soketlabs/openai-realtime-api-beta

​

Using Node.js SDK

import { RealtimeClient } from '@openai/realtime-api-beta';

const client = new RealtimeClient({
  url: 'your-relay-server-url'
});

​

Production Deployment

1. Use secure WebSocket (WSS) with SSL/TLS
2. Update the relay server URL to your production domain
3. Add authentication if needed
4. Use environment variables for configuration

const client = new RealtimeClient({
  baseURL: 'wss://your-domain.com/relay',
  // Other configuration options
});

​

Security Considerations

• Never expose your OpenAI API key in client-side code
• Use HTTPS/WSS in production
• Implement rate limiting
• Add authentication to your relay server
• Monitor server usage and implement proper error handling

​

Common Issues

1. Connection Refused: Make sure the relay server is running
2. SSL/TLS Errors: Check certificate configuration for WSS
3. Authentication Errors: Verify API key in .env file