Skip to content

Docs: add Azure OpenAI provider guide#25166

Closed
Zifeng-Jiang wants to merge 5 commits intoopenclaw:mainfrom
Zifeng-Jiang:docs/azure-openai
Closed

Docs: add Azure OpenAI provider guide#25166
Zifeng-Jiang wants to merge 5 commits intoopenclaw:mainfrom
Zifeng-Jiang:docs/azure-openai

Conversation

@Zifeng-Jiang
Copy link
Copy Markdown

@Zifeng-Jiang Zifeng-Jiang commented Feb 24, 2026

Summary

  • Problem: No documentation exists for configuring Azure OpenAI as a model provider in OpenClaw.
  • Why it matters: Azure OpenAI uses a different auth scheme (api-key header instead of Authorization: Bearer) and requires manual provider configuration. Users have no guidance for this setup.
  • What changed: Added docs/providers/azure-openai.md with full setup instructions (auth, base URL, model config, reasoning effort, troubleshooting). Added link in docs/providers/index.md and navigation entry in docs/docs.json.
  • What did NOT change (scope boundary): No code changes. No existing provider docs modified.

Change Type (select all)

  • Docs

Scope (select all touched areas)

  • Integrations

Linked Issue/PR

  • Related: discussion in GitHub Discussions about Azure OpenAI configuration

User-visible / Behavior Changes

None. Docs-only change.

Security Impact (required)

  • New permissions/capabilities? No
  • Secrets/tokens handling changed? No
  • New/changed network calls? No
  • Command/tool execution surface changed? No
  • Data access scope changed? No

Repro + Verification

Environment

  • OS: Windows 10 + MacOS + Linux
  • Runtime/container: N/A (docs only)
  • Model/provider: Azure OpenAI (GPT-5.2-Codex, GPT-5.2)
  • Integration/channel (if any): N/A

Steps

  1. Deploy GPT-5.2-Codex and GPT-5.2 models in Azure OpenAI
  2. Follow the guide in docs/providers/azure-openai.md to configure openclaw.json
  3. Run openclaw gateway restart
  4. Send a message and verify the agent responds

Expected

  • Agent responds using Azure OpenAI models
  • Reasoning effort directives (/think:high) work as documented

Actual

  • Confirmed working with both GPT-5.2-Codex and GPT-5.2 on Azure OpenAI

Evidence

  • Screenshot/recording: Verified configuration works with live Azure OpenAI deployment

Human Verification (required)

  • Verified scenarios: Full setup flow from openclaw onboard through config edit to working agent responses on Azure OpenAI
  • Edge cases checked: Both GPT-5.2-Codex (reasoning) and GPT-5.2 (reasoning) models; reasoning effort directives
  • What you did not verify: Mintlify docs rendering (no local Mintlify dev server)

Compatibility / Migration

  • Backward compatible? Yes
  • Config/env changes? No
  • Migration needed? No

Failure Recovery (if this breaks)

  • How to disable/revert this change quickly: Revert the 3 files
  • Files/config to restore: docs/providers/azure-openai.md, docs/providers/index.md, docs/docs.json
  • Known bad symptoms reviewers should watch for: Broken sidebar navigation if docs.json entry is malformed

Risks and Mitigations

None.

lobster-biscuit

Greptile Summary

Added comprehensive Azure OpenAI provider documentation with setup instructions, authentication configuration, and troubleshooting guidance. The new guide follows existing provider doc patterns and correctly documents Azure's non-standard api-key header authentication and Responses API compatibility flags.

Confidence Score: 5/5

  • This PR is safe to merge with no identified risks
  • Documentation-only change that adds a new provider guide following established patterns. The technical content is accurate (verified against codebase patterns for authHeader, supportsStore, and model configuration). All three file changes are cohesive: new doc file, navigation entry, and index listing. No code changes, no breaking changes, proper Mintlify formatting.
  • No files require special attention

Last reviewed commit: 01a53dd

(2/5) Greptile learns from your feedback when you react with thumbs up/down!

@openclaw-barnacle openclaw-barnacle bot added docs Improvements or additions to documentation size: XS labels Feb 24, 2026
@Sockolet
Copy link
Copy Markdown

@steipete this is the high quality PR to merge for Azure OpenAI support. Extensively tested on: https://github.com/openclaw/openclaw/discussions/13307

Once this is merged I will create another PR for the chat completions provider for non-OpenAI models sold by Azure.

@openclaw-barnacle
Copy link
Copy Markdown

This pull request has been automatically marked as stale due to inactivity.
Please add updates or it will be closed.

@openclaw-barnacle openclaw-barnacle bot added the stale Marked as stale due to inactivity label Mar 3, 2026
@openclaw-barnacle openclaw-barnacle bot removed the stale Marked as stale due to inactivity label Mar 4, 2026
@openclaw-barnacle
Copy link
Copy Markdown

This pull request has been automatically marked as stale due to inactivity.
Please add updates or it will be closed.

@openclaw-barnacle openclaw-barnacle bot added stale Marked as stale due to inactivity and removed stale Marked as stale due to inactivity labels Mar 22, 2026
@openclaw-barnacle
Copy link
Copy Markdown

This pull request has been automatically marked as stale due to inactivity.
Please add updates or it will be closed.

@openclaw-barnacle openclaw-barnacle bot added the stale Marked as stale due to inactivity label Mar 30, 2026
@openclaw-barnacle
Copy link
Copy Markdown

Closing due to inactivity.
If you believe this PR should be revived, post in #pr-thunderdome-dangerzone on Discord to talk to a maintainer.
That channel is the escape hatch for high-quality PRs that get auto-closed.

@openclaw-barnacle openclaw-barnacle bot closed this Apr 3, 2026
Copy link
Copy Markdown

@tonyxu-io tonyxu-io left a comment

Choose a reason for hiding this comment

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

This is very helpful, thanks for adding.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs Improvements or additions to documentation size: XS stale Marked as stale due to inactivity

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants