OpenAI

OpenAI provides VoxEngine clients for chat completions, the Responses API, and the Realtime API. Use this page as the consolidated API surface for creating clients, configuring parameters, sending media, and handling provider events.

For real-time voice scenarios, create an OpenAI.RealtimeAPIClient, bridge call media to it, and listen for OpenAI.Events plus OpenAI.RealtimeAPIEvents.

Related guides

Contents

• Usage: required module import and high-level client flow.
• Factory functions: create chat completions, responses, or realtime clients.
• Parameter types: configuration objects used by OpenAI client factories.
• Client methods: methods grouped by client type.
• Events: WebSocket media bridge events.
• RealtimeAPIEvents: OpenAI Realtime server events and provider payload fields.

Usage

Add the module before using the namespace:

1
require(Modules.OpenAI);

Create the client for the API style you need, then call methods on that client instance. Realtime voice scenarios typically use createRealtimeAPIClient, sendMediaTo, and event listeners for Realtime API server messages.

Factory functions

Use the tabs to choose the OpenAI API surface you are creating: Chat Completions for text chat completions, Responses for the newer Responses API, or Realtime for voice scenarios over WebSocket.

1
createChatCompletionsAPIClient(parameters: {
2
  statistics?: boolean;
3
  trace?: boolean;
4
  privacy?: boolean;
5
  apiKey: string;
6
  storeContext?: boolean;
7
  baseUrl?: string;
8
  project?: string;
9
  summaryModel?: string;
10
  summaryPrompt?: string;
11
}): Promise<OpenAI.ChatCompletionsAPIClient>

Parameter types

These parameter objects match the same three API families as the factory functions.

Client methods

Use the tabs to switch between Chat Completions, Responses, and Realtime client methods.

1
addEventListener(event: OpenAI.Events | OpenAI.ChatCompletionsAPIEvents | string, callback: (event: object) => any): void

1
close(): void

1
createChatCompletions(parameters: Object): void

1
id(): string

1
removeEventListener(event: OpenAI.Events | OpenAI.ChatCompletionsAPIEvents | string, callback?: (event: object) => any): void

1
webSocketId(): string

Events

Event tabs mirror the same API families: media bridge events apply to realtime WebSocket media, while the API-specific tabs document provider responses for each client type.