Documentation
OpenAI Realtime
Use the hosted-only Realtime helper when you need OpenAI Realtime plus Milkey-hosted MCP delivery.
Overview
Realtime is the narrowest OpenAI path in the SDK. It is currently a hosted-only surface.
Use it when you already have a Realtime architecture and want to attach Milkey through the provider-native hosted MCP configuration.
Recommended
Recommended default: hosted
Supported modes
hosted, auto
Helpers
- milkey.openai.realtime.tools(...)
- milkey.openai.realtime.resolveMode(...)
Examples
Full GitHub example
Use the complete provider example in the SDK repo when you want the full runnable file with imports, env handling, and a realistic integration shape. Open the GitHub example.
TS
const realtimeTools = milkey.openai.realtime.tools({ client: milkeyClient, mode: "hosted", approvalMode: "never",})Edge cases and production notes
- Treat Realtime as a specialized path. Document it for teams that need it, but onboard most users through Responses first.
- The helper returns provider-native hosted MCP configuration, not an inline tool set.
Watch for these edges
- Inline mode is not supported for Realtime.
- If you request an unsupported mode, the SDK will fail fast through the capability resolver.