Skip to content

docs: clarify Azure Realtime GA endpoint configuration#2440

Draft
OiPunk wants to merge 1 commit intoopenai:mainfrom
OiPunk:codex/openai-agents-realtime-azure-ga-docs
Draft

docs: clarify Azure Realtime GA endpoint configuration#2440
OiPunk wants to merge 1 commit intoopenai:mainfrom
OiPunk:codex/openai-agents-realtime-azure-ga-docs

Conversation

@OiPunk
Copy link
Contributor

@OiPunk OiPunk commented Feb 9, 2026

Summary

  • add explicit Azure OpenAI realtime connection examples to docs using the GA endpoint format
  • document both API key and bearer-token auth header variants in model_config
  • warn against the legacy beta realtime URL format for realtime agents

Why

Issue: #1748 shows repeated confusion around Azure realtime URL/auth configuration and session.created validation errors caused by using legacy endpoint patterns.

Validation

  • docs snippets added in:
    • docs/realtime/quickstart.md
    • docs/realtime/guide.md
  • snippets align with existing RealtimeModelConfig fields (url, headers) used by realtime examples

Fixes #1748

@github-actions github-actions bot added documentation Improvements or additions to documentation feature:realtime labels Feb 9, 2026

The session configuration allows you to control the underlying realtime model behavior. You can configure the model name (such as `gpt-realtime`), voice selection (alloy, echo, fable, onyx, nova, shimmer), and supported modalities (text and/or audio). Audio formats can be set for both input and output, with PCM16 being the default.

When connecting to Azure OpenAI, use the GA Realtime endpoint format and pass credentials via
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you move this to the bottom as a new section?

@seratch seratch marked this pull request as draft February 9, 2026 20:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation feature:realtime

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Runtime error with Azure Realtime API when using the latest examples

2 participants