Quickstart with SDK

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

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

const client = new RealtimeClient({
  apiKey: 'your-api-key',
  // For browser environments, set this to true
  dangerouslyAllowAPIKeyInBrowser: true 
});

// Or use a relay server to protect your API key
const client = new RealtimeClient({
  url: 'your-relay-server-url'
});

// Configure the session with multiple parameters
client.updateSession({
  // Set system instructions for the AI
  instructions: 'You are a helpful assistant',
  
  // Set voice and language
  voice: 'monica',
  language: 'en',
  
  // Set up Voice Activity Detection
  turn_detection: {
    type: 'server_vad',
    threshold: 0.5,
    prefix_padding_ms: 300,
    silence_duration_ms: 500
  }
});

// Connect to the service
await client.connect();

// Send a text message
client.sendUserMessageContent([{
  type: 'input_text',
  text: 'Hello!'
}]);

// Listen for responses
client.on('conversation.updated', ({ item, delta }) => {
  if (delta?.audio) {
    // Handle audio response
    playAudio(delta.audio);
  }
  if (item.formatted.text) {
    // Handle text response
    console.log(item.formatted.text);
  }
});

// Stream audio input from microphone
const wavRecorder = new WavRecorder({ sampleRate: 8000 });
await wavRecorder.record((data) => {
  client.appendInputAudio(data.mono);
});

// Handle audio responses
client.on('conversation.updated', ({ delta }) => {
  if (delta?.audio) {
    const audioPlayer = new WavStreamPlayer({ sampleRate: 8000 });
    audioPlayer.add16BitPCM(delta.audio);
  }
});

// Configure VAD (Voice Activity Detection)
client.updateSession({
  turn_detection: {
    type: 'server_vad',
    threshold: 0.5,
    prefix_padding_ms: 300,
    silence_duration_ms: 500
  }
});

// Change voice and language
client.updateSession({
  voice: 'monica',  // Set voice
  language: 'en'    // Set language
});

// Add a custom tool
client.addTool(
  {
    name: 'get_weather',
    description: 'Get weather for location',
    parameters: {
      type: 'object',
      properties: {
        location: {
          type: 'string',
          description: 'City name'
        }
      },
      required: ['location']
    }
  },
  async ({ location }) => {
    // Tool implementation
    return { temperature: 72, conditions: 'sunny' };
  }
);