Skip to content

Fix Realtime API: correct model name, remove beta header, fix session flow #5

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
Copilot wants to merge 2 commits into
base: main
Choose a base branch
from
Draft

Fix Realtime API: correct model name, remove beta header, fix session flow #5

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
180fa3a
Initial plan
Copilot Mar 10, 2026
3f37e3f
Fix Realtime API: correct model, remove beta header, improve error su…
Copilot Mar 10, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions .env.example
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@ OPENAI_API_KEY=sk-your-api-key-here
# Server port (optional, default: 3001)
PORT=3001

# OpenAI Realtime model (optional, default: gpt-realtime-1.5)
OPENAI_MODEL=gpt-realtime-1.5
# OpenAI Realtime model (optional, default: gpt-4o-realtime-preview)
OPENAI_MODEL=gpt-4o-realtime-preview

# Custom system prompt (optional – overrides the built-in HUD assistant prompt)
# HUD_SYSTEM_PROMPT=You are a custom HUD assistant...
19 changes: 16 additions & 3 deletions server/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ dotenv.config();
const __dirname = path.dirname(fileURLToPath(import.meta.url));
const PORT = parseInt(process.env.PORT ?? '3001', 10);
const OPENAI_API_KEY = process.env.OPENAI_API_KEY ?? '';
const OPENAI_MODEL = process.env.OPENAI_MODEL ?? 'gpt-realtime-1.5';
const OPENAI_MODEL = process.env.OPENAI_MODEL ?? 'gpt-4o-realtime-preview';
const HUD_SYSTEM_PROMPT = process.env.HUD_SYSTEM_PROMPT ?? '';
const IS_PRODUCTION = process.env.NODE_ENV === 'production';

Expand Down Expand Up @@ -75,7 +75,6 @@ wss.on('connection', (clientWs) => {
{
headers: {
Authorization: `Bearer ${OPENAI_API_KEY}`,
'OpenAI-Beta': 'realtime=v1',
},
}
);
Expand Down Expand Up @@ -123,8 +122,22 @@ wss.on('connection', (clientWs) => {
});

openaiWs.on('close', (code, reason) => {
console.log(`[server] OpenAI WebSocket closed: ${code} ${reason.toString()}`);
const reasonStr = reason.toString();
const isAbnormal = code !== 1000 && code !== 1001;
if (isAbnormal || reasonStr) {
console.error(`[server] OpenAI WebSocket closed: code=${code} reason=${reasonStr || '(none)'}`);
} else {
console.log(`[server] OpenAI WebSocket closed: code=${code}`);
}
if (clientWs.readyState === WebSocket.OPEN) {
if (isAbnormal) {
clientWs.send(
JSON.stringify({
type: 'error',
error: { message: `OpenAI session closed unexpectedly (code ${code})${reasonStr ? ': ' + reasonStr : ''}` },
})
);
}
clientWs.close();
}
});
Expand Down
27 changes: 21 additions & 6 deletions src/services/providers/openai.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ Guidelines:
- Flag potential errors, warnings, or important details you notice`;

/**
* OpenAI Realtime API provider using gpt-realtime-1.5.
* OpenAI Realtime API provider using gpt-4o-realtime-preview.
* Communicates via the backend WebSocket proxy at /api/realtime.
*/
export class OpenAIRealtimeProvider implements AIProvider {
Expand Down Expand Up @@ -63,7 +63,7 @@ export class OpenAIRealtimeProvider implements AIProvider {
this.ws = new WebSocket(wsUrl);

this.ws.onopen = () => {
this.configureSession();
console.log('[OpenAI Realtime] WebSocket connected, waiting for session.created...');
};

this.ws.onmessage = (event) => {
Expand All @@ -82,8 +82,18 @@ export class OpenAIRealtimeProvider implements AIProvider {
reject(new Error(msg));
};

this.ws.onclose = () => {
if (this._state !== 'idle') {
this.ws.onclose = (event) => {
// Surface any close reason so errors from OpenAI are visible
if (event.reason) {
console.error('[OpenAI Realtime] WebSocket closed with reason:', event.reason, 'code:', event.code);
}
if (this._state === 'connecting') {
const reason = event.reason ? `: ${event.reason}` : '';
const msg = `Connection closed before session was established (code ${event.code})${reason}`;
this.setState('error');
events.onError(msg);
reject(new Error(msg));
} else if (this._state !== 'idle') {
this.setState('idle');
events.onDisconnected();
}
Expand Down Expand Up @@ -124,7 +134,7 @@ export class OpenAIRealtimeProvider implements AIProvider {
},
{
type: 'input_image',
image: `data:image/jpeg;base64,${base64Jpeg}`,
image_url: `data:image/jpeg;base64,${base64Jpeg}`,
detail: 'auto',
},
],
Expand Down Expand Up @@ -183,7 +193,12 @@ export class OpenAIRealtimeProvider implements AIProvider {
private handleEvent(event: RealtimeEvent, resolveConnect?: (value: void) => void): void {
switch (event.type) {
case 'session.created':
// Initial session from OpenAI – now send our configuration
this.configureSession();
break;

case 'session.updated':
// Our session.update was applied; session is fully ready
this.sessionConfigured = true;
this.setState('active');
this.events?.onConnected();
Expand Down Expand Up @@ -218,7 +233,7 @@ export class OpenAIRealtimeProvider implements AIProvider {

case 'error': {
const errMsg = (event.error as { message?: string })?.message ?? 'Unknown error';
console.error('[OpenAI Realtime] Error:', errMsg);
console.error('[OpenAI Realtime] Error event:', errMsg, event);
this.events?.onError(errMsg);
break;
}
Expand Down