Skip to content

[Docs] Add multi-provider routing documentation#337

Open
Aakashwije wants to merge 3 commits into
wso2:mainfrom
Aakashwije:add-ai-gateway-multi-provider-routing-docs
Open

[Docs] Add multi-provider routing documentation#337
Aakashwije wants to merge 3 commits into
wso2:mainfrom
Aakashwije:add-ai-gateway-multi-provider-routing-docs

Conversation

@Aakashwije

Copy link
Copy Markdown

Purpose

Document multi-provider routing for AI Gateway LLM proxies. This enables applications to use a single OpenAI-compatible endpoint while routing requests to OpenAI, Anthropic, Azure OpenAI, Mistral, Gemini, or AWS Bedrock.

Related implementation: wso2/api-platform#2586

Checklist

  • Verified that llms.txt (located at en/docs/llms.txt) is updated for AI readiness content.
  • Ensured meaningful alt text for images and that the information contained in an image also appears in text so the relevant info exists in the body of the document. No images were added by this PR.
  • Added or updated frontmatter for the respective pages.

Goals

  • Explain how multi-provider routing works.
  • Document primary and additional LLM provider configuration.
  • Explain vendor, provider loopback, and proxy consumer authentication.
  • Provide examples for OpenAI, Anthropic, Azure OpenAI, Mistral, Gemini, and AWS Bedrock.
  • Document header-based provider selection, aliases, validation, troubleshooting, and security recommendations.
  • Make the new guide discoverable through the AI Gateway overview and documentation navigation.

Approach

  • Added a new multi-provider routing guide under the AI Gateway next documentation.
  • Added provider deployment, API-key creation, proxy deployment, and invocation examples.
  • Added configuration references and troubleshooting guidance.
  • Added AWS Bedrock to the supported additional-provider examples.
  • Updated the AI Gateway overview with a link to the new guide.
  • Added the guide to the MkDocs navigation.

This change does not affect a UI, so no screenshots or animated GIFs are required.

User stories

  • As an application developer, I want to use one OpenAI-compatible endpoint with multiple LLM providers so that I can switch providers without changing application code.
  • As a platform administrator, I want vendor credentials to remain in the gateway so that they are not distributed to applications.
  • As a platform administrator, I want consistent authentication, rate limits, and guardrails across providers.
  • As an application developer, I want provider selection through a request header so that I can compare or route requests to different providers.
  • As a platform administrator, I want provider-specific transformers so that OpenAI-compatible requests can be sent to providers using different wire formats.

Release note

Added documentation for routing OpenAI-compatible LLM proxy requests to multiple providers, including OpenAI, Anthropic, Azure OpenAI, Mistral, Gemini, and AWS Bedrock.

Documentation

  • en/docs/ai-gateway/next/llm-proxy/multi-provider-routing.md
  • en/docs/ai-gateway/next/overview.md
  • en/mkdocs.yml

Training

N/A. This documentation change does not require updates to WSO2 training content.

Certification

N/A. This documentation change does not affect existing certification exams.

Marketing

N/A. No marketing content is included in this PR.

Automation tests

  • Unit tests

    N/A. This PR contains documentation changes only.

  • Integration tests

    N/A. This PR contains documentation changes only.

Validation performed:

The complete MkDocs build was not run because the required MkDocs dependencies were not installed in the local environment.

Security checks

  • Followed secure coding standards in http://wso2.com/technical-reports/wso2-secure-engineering-guidelines? N/A — documentation-only change.
  • Ran FindSecurityBugs plugin and verified report? N/A — documentation-only change.
  • Confirmed that this PR doesn't commit any keys, passwords, tokens, usernames, or other secrets? Yes. All credentials in the examples use placeholders.

Samples

The guide provides examples for:

  • Deploying OpenAI and Anthropic LLM providers.
  • Creating provider loopback API keys.
  • Deploying a multi-provider LLM proxy.
  • Selecting providers using the x-provider header.
  • Configuring Azure OpenAI, Mistral, Gemini, and AWS Bedrock as additional providers.
  • Configuring provider aliases.
  • Troubleshooting provider routing, authentication, and transformer configuration.

Related PRs

Migrations (if applicable)

N/A. No migration is required.

Test environment

  • Operating system: macOS
  • Documentation format: Markdown and YAML
  • JDK: N/A
  • Database: N/A
  • Browser: N/A

Learning

The documentation was developed by reviewing:

@coderabbitai

coderabbitai Bot commented Jul 13, 2026

Copy link
Copy Markdown

Review Change Stack

Warning

Review limit reached

@Aakashwije, you've reached your PR review limit, so we couldn't start this review.

Next review available in: 28 minutes

Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available.
You're only billed for reviews past your plan's rate limits ($0.25/file).

How can I continue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews.

How do review limits work?

CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability.

For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window.

Please refer docs for additional details.

Review details
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 5d5ebab4-c9d5-4e37-946a-0635b86d1da7

📥 Commits

Reviewing files that changed from the base of the PR and between e12717e and d0df708.

📒 Files selected for processing (1)
  • en/docs/ai-gateway/next/llm-proxy/multi-provider-routing.md
📝 Walkthrough

Walkthrough

Adds a complete guide for routing requests through one OpenAI-compatible LLM proxy to multiple providers using request headers, provider aliases, and inline transformers. It documents provider and credential setup, proxy deployment, invocation examples, extension patterns, configuration parameters, troubleshooting, and security guidance. The AI Gateway overview is revised to reference the new LLM Proxy terminology and guide, and the new page is added to the documentation navigation.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and concisely describes the main change: adding multi-provider routing documentation.
Description check ✅ Passed The PR description follows the template well and fills the required sections with clear, relevant details.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant