Skip to content

docs: clarify Azure Realtime GA endpoint configuration#2440

Merged
seratch merged 2 commits intoopenai:mainfrom
OiPunk:codex/openai-agents-realtime-azure-ga-docs
Feb 10, 2026
Merged

docs: clarify Azure Realtime GA endpoint configuration#2440
seratch merged 2 commits 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
@seratch seratch marked this pull request as draft February 9, 2026 20:23
@OiPunk
Copy link
Contributor Author

OiPunk commented Feb 10, 2026

Thanks for the review. I moved the Azure endpoint guidance to a dedicated bottom section in docs/realtime/guide.md (new section: "Azure OpenAI endpoint format").

Validation done locally before pushing:

  • make build-docs (exit code 0)

Latest commit: bc457ea

@OiPunk OiPunk marked this pull request as ready for review February 10, 2026 02:10
@seratch seratch added this to the 0.8.x milestone Feb 10, 2026
@seratch seratch merged commit 86f5c71 into openai:main Feb 10, 2026
11 checks passed
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