IntelligenceX

API Reference

Class

OpenAIRealtimeClient

Edit on GitHub
Namespace IntelligenceX.OpenAI.Realtime
Assembly IntelligenceX
Source OpenAIRealtimeClient.cs:40
Implements
IDisposable
Modifiers sealed

Mints short-lived OpenAI Realtime credentials and opens Realtime WebSocket sessions.

Inheritance

  • Object
  • OpenAIRealtimeClient

Remarks

When no API key is supplied, this client reuses the existing ChatGPT/Codex OAuth bundle. Applications can keep that bundle in device-protected storage and call OpenAI directly; no intermediary relay is required.

Constructors

public OpenAIRealtimeClient(OpenAIRealtimeOptions? options = null, OpenAINativeOptions? chatGptOptions = null) #
OpenAIRealtimeClient.cs:40

Initializes a Realtime client.

Parameters

options IntelligenceX.OpenAI.Realtime.OpenAIRealtimeOptions? = null optionalposition: 0
Realtime endpoint and API-key options.
chatGptOptions IntelligenceX.OpenAI.Native.OpenAINativeOptions? = null optionalposition: 1
ChatGPT OAuth bundle options used when no API key is supplied.

Methods

ConnectAsync 2 overloads
public async Task<OpenAIRealtimeSession> ConnectAsync(OpenAIRealtimeSessionOptions? sessionOptions = null, CancellationToken cancellationToken = default) #
Returns: Task<OpenAIRealtimeSession>

Mints a short-lived credential and opens an authenticated Realtime WebSocket.

Parameters

sessionOptions IntelligenceX.OpenAI.Realtime.OpenAIRealtimeSessionOptions? = null optionalposition: 0
cancellationToken System.Threading.CancellationToken = default optionalposition: 1
public async Task<OpenAIRealtimeSession> ConnectAsync(OpenAIRealtimeClientSecret secret, CancellationToken cancellationToken = default) #
Returns: Task<OpenAIRealtimeSession>

Opens a Realtime WebSocket with an existing short-lived credential. This overload is useful when another local component owns credential minting.

Parameters

secret IntelligenceX.OpenAI.Realtime.OpenAIRealtimeClientSecret requiredposition: 0
cancellationToken System.Threading.CancellationToken = default optionalposition: 1
public async Task<OpenAIRealtimeClientSecret> CreateClientSecretAsync(OpenAIRealtimeSessionOptions? sessionOptions = null, CancellationToken cancellationToken = default) #
Returns: Task<OpenAIRealtimeClientSecret>

Mints a short-lived Realtime client credential. The returned value is sensitive and must not be persisted.

Parameters

sessionOptions IntelligenceX.OpenAI.Realtime.OpenAIRealtimeSessionOptions? = null optionalposition: 0
cancellationToken System.Threading.CancellationToken = default optionalposition: 1
public Void Dispose() #
OpenAIRealtimeClient.cs:127
Returns: Void

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.