feat: add support for openrouter by SkyeYoung · Pull Request #12878 · apache/apisix

SkyeYoung · 2026-01-09T06:18:42Z

Description

Refer to the changes in #12565 to add support for openrouter

Already tested in real world:

young@ubuntu-20:~/apisix$ apisix restart
/usr/local/openresty//luajit/bin/luajit ./apisix/cli/apisix.lua restart
configuration test is successful
nginx: [warn] [lua] config_yaml.lua:198: read_apisix_config(): config file /home/young/apisix/conf/apisix.yaml reloaded.
young@ubuntu-20:~/apisix$ curl -X POST http://localhost:9080/anything \
>   -H "Content-Type: application/json" \
>   -d '{"messages": [{"role": "user", "content": "Hello"}]}'
data: {"id":"gen-1767948065-l9Xfdy3Lv0vOkdZq5gxE","provider":"OpenAI","model":"openai/gpt-4o","object":"chat.completion.chunk","created":1767948065,"choices":[{"index":0,"delta":{"role":"assistant","content":""},"finish_reason":null,"native_finish_reason":null,"logprobs":null}],"system_fingerprint":"fp_deacdd5f6f"}

data: {"id":"gen-1767948065-l9Xfdy3Lv0vOkdZq5gxE","provider":"OpenAI","model":"openai/gpt-4o","object":"chat.completion.chunk","created":1767948065,"choices":[{"index":0,"delta":{"role":"assistant","content":"Hello"},"finish_reason":null,"native_finish_reason":null,"logprobs":null}],"system_fingerprint":"fp_deacdd5f6f"}

data: {"id":"gen-1767948065-l9Xfdy3Lv0vOkdZq5gxE","provider":"OpenAI","model":"openai/gpt-4o","object":"chat.completion.chunk","created":1767948065,"choices":[{"index":0,"delta":{"role":"assistant","content":"!"},"finish_reason":null,"native_finish_reason":null,"logprobs":null}],"system_fingerprint":"fp_deacdd5f6f"}

data: {"id":"gen-1767948065-l9Xfdy3Lv0vOkdZq5gxE","provider":"OpenAI","model":"openai/gpt-4o","object":"chat.completion.chunk","created":1767948065,"choices":[{"index":0,"delta":{"role":"assistant","content":" How"},"finish_reason":null,"native_finish_reason":null,"logprobs":null}],"system_fingerprint":"fp_deacdd5f6f"}

data: {"id":"gen-1767948065-l9Xfdy3Lv0vOkdZq5gxE","provider":"OpenAI","model":"openai/gpt-4o","object":"chat.completion.chunk","created":1767948065,"choices":[{"index":0,"delta":{"role":"assistant","content":" can"},"finish_reason":null,"native_finish_reason":null,"logprobs":null}],"system_fingerprint":"fp_deacdd5f6f"}

data: {"id":"gen-1767948065-l9Xfdy3Lv0vOkdZq5gxE","provider":"OpenAI","model":"openai/gpt-4o","object":"chat.completion.chunk","created":1767948065,"choices":[{"index":0,"delta":{"role":"assistant","content":" I"},"finish_reason":null,"native_finish_reason":null,"logprobs":null}],"system_fingerprint":"fp_deacdd5f6f"}

data: {"id":"gen-1767948065-l9Xfdy3Lv0vOkdZq5gxE","provider":"OpenAI","model":"openai/gpt-4o","object":"chat.completion.chunk","created":1767948065,"choices":[{"index":0,"delta":{"role":"assistant","content":" assist"},"finish_reason":null,"native_finish_reason":null,"logprobs":null}],"system_fingerprint":"fp_deacdd5f6f"}

data: {"id":"gen-1767948065-l9Xfdy3Lv0vOkdZq5gxE","provider":"OpenAI","model":"openai/gpt-4o","object":"chat.completion.chunk","created":1767948065,"choices":[{"index":0,"delta":{"role":"assistant","content":" you"},"finish_reason":null,"native_finish_reason":null,"logprobs":null}],"system_fingerprint":"fp_deacdd5f6f"}

data: {"id":"gen-1767948065-l9Xfdy3Lv0vOkdZq5gxE","provider":"OpenAI","model":"openai/gpt-4o","object":"chat.completion.chunk","created":1767948065,"choices":[{"index":0,"delta":{"role":"assistant","content":" today"},"finish_reason":null,"native_finish_reason":null,"logprobs":null}],"system_fingerprint":"fp_deacdd5f6f"}

data: {"id":"gen-1767948065-l9Xfdy3Lv0vOkdZq5gxE","provider":"OpenAI","model":"openai/gpt-4o","object":"chat.completion.chunk","created":1767948065,"choices":[{"index":0,"delta":{"role":"assistant","content":"?"},"finish_reason":null,"native_finish_reason":null,"logprobs":null}],"system_fingerprint":"fp_deacdd5f6f"}

data: {"id":"gen-1767948065-l9Xfdy3Lv0vOkdZq5gxE","provider":"OpenAI","model":"openai/gpt-4o","object":"chat.completion.chunk","created":1767948065,"choices":[{"index":0,"delta":{"role":"assistant","content":""},"finish_reason":"stop","native_finish_reason":"stop","logprobs":null}],"system_fingerprint":"fp_deacdd5f6f"}

data: {"id":"gen-1767948065-l9Xfdy3Lv0vOkdZq5gxE","provider":"OpenAI","model":"openai/gpt-4o","object":"chat.completion.chunk","created":1767948065,"choices":[{"index":0,"delta":{"role":"assistant","content":""},"finish_reason":null,"native_finish_reason":null,"logprobs":null}],"usage":{"prompt_tokens":8,"completion_tokens":9,"total_tokens":17,"cost":0.00011,"is_byok":false,"prompt_tokens_details":{"cached_tokens":0,"audio_tokens":0,"video_tokens":0},"cost_details":{"upstream_inference_cost":null,"upstream_inference_prompt_cost":0.00002,"upstream_inference_completions_cost":0.00009},"completion_tokens_details":{"reasoning_tokens":0,"image_tokens":0}}}

data: [DONE]

Which issue(s) this PR fixes:

Fixes #

Checklist

I have explained the need for this PR and the problem it solves
I have explained the changes or the new features added to this PR
I have added tests corresponding to this change
I have updated the documentation to reflect this change
I have verified that this change is backward compatible (If not, please discuss on the APISIX mailing list first)

Copilot

Pull request overview

This pull request adds support for the OpenRouter AI provider to APISIX's AI proxy plugins. OpenRouter is added as a new provider option alongside existing providers like OpenAI, DeepSeek, Azure, and AIMLAPI. The implementation follows the established pattern for OpenAI-compatible providers.

Changes:

Adds OpenRouter driver using the OpenAI-compatible base driver with endpoint https://openrouter.ai/api/v1/chat/completions
Updates plugin schemas to include "openrouter" as a valid provider option
Updates both English and Chinese documentation to reflect the new provider
Adds comprehensive test coverage for the OpenRouter integration

Reviewed changes

Copilot reviewed 11 out of 11 changed files in this pull request and generated 3 comments.

Show a summary per file

File	Description
t/plugin/ai-proxy-openrouter.t	Adds test suite for OpenRouter provider with authentication, streaming, and basic functionality tests
apisix/plugins/ai-drivers/openrouter.lua	New driver implementation for OpenRouter using OpenAI-compatible base
apisix/plugins/ai-drivers/schema.lua	Updates schema to include OpenRouter in provider lists and compatibility checks
apisix/plugins/ai-proxy/schema.lua	Adds "openrouter" to valid provider enums in both multi and single instance schemas
apisix/plugins/ai-request-rewrite.lua	Adds "openrouter" to the provider enum for AI request rewriting
docs/en/latest/plugins/ai-request-rewrite.md	Documents OpenRouter as available provider option (with typo fix needed)
docs/en/latest/plugins/ai-proxy.md	Documents OpenRouter provider with endpoint details (with typo fix needed)
docs/en/latest/plugins/ai-proxy-multi.md	Documents OpenRouter in multi-instance plugin configuration (with typo fix needed)
docs/zh/latest/plugins/ai-request-rewrite.md	Chinese translation with OpenRouter documentation (with typo fix needed)
docs/zh/latest/plugins/ai-proxy.md	Chinese translation with OpenRouter documentation
docs/zh/latest/plugins/ai-proxy-multi.md	Chinese translation with OpenRouter documentation

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2026-01-11T08:02:47Z

+                                        "stream": true
+                                    },
+                                    "override": {
+                                        "endpoint": "http://localhost:7737/v1/chat/completions"


The endpoint port in TEST 3 is set to 7737, but the mock server in the http_config listens on port 6724. This mismatch will cause the test to fail as it won't be able to connect to the mock server.

Suggested change

"endpoint": "http://localhost:7737/v1/chat/completions"

"endpoint": "http://localhost:6724/v1/chat/completions"

Copilot · 2026-01-11T08:02:47Z

 | ------------------------- | ------------ | -------- | ------------------------------------------------------------------------------------ |
 | prompt                    | Yes          | String   | The prompt send to LLM service.                                                      |
-| provider                  | Yes          | String   | Name of the LLM service. Available options: openai, deekseek, azure-openai, aimlapi and openai-compatible. When `aimlapi` is selected, the plugin uses the OpenAI-compatible driver with a default endpoint of `https://api.aimlapi.com/v1/chat/completions`.   |
+| provider                  | Yes          | String   | Name of the LLM service. Available options: openai, deekseek, azure-openai, aimlapi, openrouter and openai-compatible. When `aimlapi` is selected, the plugin uses the OpenAI-compatible driver with a default endpoint of `https://api.aimlapi.com/v1/chat/completions`.   |


There is a typo in "deekseek" - it should be "deepseek" for consistency with the actual provider name used throughout the codebase.

This should be fixed in another pr.

Copilot · 2026-01-11T08:02:48Z

 | ------------------------- | ------------ | -------- | ------------------------------------------------------------------------------------ |
 | prompt                    | 是          | String   | 发送到 LLM 服务的提示。                                                      |
-| provider                  | 是          | String   | LLM 服务的名称。可用选项：openai、deekseek、azure-openai、aimlapi 和 openai-compatible。当选择 `aimlapi` 时，插件使用 OpenAI 兼容驱动程序，默认端点为 `https://api.aimlapi.com/v1/chat/completions`。   |
+| provider                  | 是          | String   | LLM 服务的名称。可用选项：openai、deekseek、azure-openai、aimlapi、openrouter 和 openai-compatible。当选择 `aimlapi` 时，插件使用 OpenAI 兼容驱动程序，默认端点为 `https://api.aimlapi.com/v1/chat/completions`。   |


There is a typo in "deekseek" - it should be "deepseek" for consistency with the actual provider name used throughout the codebase.

kayx23 · 2026-01-12T02:32:38Z

 | instances                          | array[object]  | True     |                                   |              | LLM instance configurations. |
 | instances.name                     | string         | True     |                                   |              | Name of the LLM service instance. |
-| instances.provider                 | string         | True     |                                   | [openai, deepseek, azure-openai, aimlapi, openai-compatible] | LLM service provider. When set to `openai`, the Plugin will proxy the request to `api.openai.com`. When set to `deepseek`, the Plugin will proxy the request to `api.deepseek.com`. When set to `aimlapi`, the Plugin uses the OpenAI-compatible driver and proxies the request to `api.aimlapi.com` by default. When set to `openai-compatible`, the Plugin will proxy the request to the custom endpoint configured in `override`. |
+| instances.provider                 | string         | True     |                                   | [openai, deepseek, azure-openai, aimlapi, openrouter, openai-compatible] | LLM service provider. When set to `openai`, the Plugin will proxy the request to `api.openai.com`. When set to `deepseek`, the Plugin will proxy the request to `api.deepseek.com`. When set to `aimlapi`, the Plugin uses the OpenAI-compatible driver and proxies the request to `api.aimlapi.com` by default. When set to `openrouter`, the Plugin uses the OpenAI-compatible driver and proxies the request to `openrouter.ai` by default. When set to `openai-compatible`, the Plugin will proxy the request to the custom endpoint configured in `override`. |


The azure-openai PR didn't add description for the option - consider adding it here? I think it does something like this

When set to azure-openai, the plugin proxies requests to the custom endpoint configured in override and additionally removes the model parameter from user requests.

This should be handled in a separate PR.

(when I have time. Or I will create a issue.

membphis · 2026-01-12T05:49:46Z

    ["openai-compatible"] = openai_compatible_chat_schema,
-    ["azure-openai"] = openai_compatible_chat_schema
+    ["azure-openai"] = openai_compatible_chat_schema,
+    ["openrouter"] = openai_compatible_chat_schema


we can add , at the end of this line

membphis · 2026-01-12T05:53:54Z

 }

 function _M.is_openai_compatible_provider(provider)
    if provider == "openai" or


I think we can use an array object to maintain it

It is easy to maintain in this way, here is the example code:

do local openai_compatible_list = { "openai", "azure_openai", ... ... "together", } local openai_compatible_kv = {} for _, provider in ipairs(openai_compatible_list) do openai_compatible_kv[provider] = true end function _M.is_openai_compatible_provider(provider) if openai_compatible_kv[provider] then return true end ... end end

membphis · 2026-01-12T05:55:31Z

try to reuse the provider array list

we can put the array list in schema.lua

membphis · 2026-01-12T05:55:58Z

                "aimlapi",
                "openai-compatible",
-                "azure-openai"
+                "azure-openai",


SkyeYoung · 2026-01-12T06:59:19Z

copy of https://github.com/apache/apisix/blob/release/3.14/t/assets/ai-proxy-response.json. but it have a better name.

membphis

LGTM

bzp2010

Code modification approved

kayx23 · 2026-01-12T07:49:14Z

 | ------------------------- | ------------ | -------- | ------------------------------------------------------------------------------------ |
 | prompt                    | Yes          | String   | The prompt send to LLM service.                                                      |
-| provider                  | Yes          | String   | Name of the LLM service. Available options: openai, deekseek, azure-openai, aimlapi and openai-compatible. When `aimlapi` is selected, the plugin uses the OpenAI-compatible driver with a default endpoint of `https://api.aimlapi.com/v1/chat/completions`.   |
+| provider                  | Yes          | String   | Name of the LLM service. Available options: openai, deekseek, azure-openai, aimlapi, openrouter and openai-compatible. When `aimlapi` is selected, the plugin uses the OpenAI-compatible driver with a default endpoint of `https://api.aimlapi.com/v1/chat/completions`.   |


The provider description for ai-request-rewrite is not great - it only explained aimlapi. This should be noted and improved (maybe in a different PR?) cc: @Yilialinn

kayx23

Other doc changes ok

SkyeYoung added 3 commits January 9, 2026 06:10

feat: add support for openrouter

4436603

fix: test logic

8442d0e

chore: align

2cd5c0c

SkyeYoung marked this pull request as ready for review January 9, 2026 08:44

dosubot Bot added size:L This PR changes 100-499 lines, ignoring generated files. enhancement New feature or request labels Jan 9, 2026

chore: update zh docs

46b4044

SkyeYoung requested review from bzp2010, kayx23 and moonming January 9, 2026 09:59

chore: add rest part

d6fbf30

moonming requested review from Copilot and removed request for bzp2010, kayx23 and moonming January 11, 2026 07:58

Copilot started reviewing on behalf of moonming January 11, 2026 07:58 View session

Copilot AI reviewed Jan 11, 2026

View reviewed changes

SkyeYoung requested review from bzp2010, membphis and moonming January 12, 2026 01:26

kayx23 reviewed Jan 12, 2026

View reviewed changes

SkyeYoung requested a review from kayx23 January 12, 2026 02:43

membphis requested changes Jan 12, 2026

View reviewed changes

SkyeYoung added 2 commits January 12, 2026 06:33

fix: solve @membphis comments

1960e9c

chore: rm useless

5fd91c0

SkyeYoung requested a review from membphis January 12, 2026 06:41

SkyeYoung added 3 commits January 12, 2026 06:42

chore: add missing changes

05a3324

chore: solve @membphis comment

b3d426b

chore: use openai-compatible-api-response.json

5458bd7

SkyeYoung commented Jan 12, 2026

View reviewed changes

chore: add comments

230548e

membphis approved these changes Jan 12, 2026

View reviewed changes

bzp2010 approved these changes Jan 12, 2026

View reviewed changes

kayx23 reviewed Jan 12, 2026

View reviewed changes

kayx23 approved these changes Jan 12, 2026

View reviewed changes

SkyeYoung mentioned this pull request Jan 12, 2026

feat: support anthropic openai api #12881

Merged

5 tasks

SkyeYoung merged commit 9f3716d into apache:master Jan 12, 2026
52 of 56 checks passed

SkyeYoung deleted the young/feat/ai-driver-openrouter branch January 12, 2026 12:08

wistefan pushed a commit to wistefan/apisix that referenced this pull request Jun 16, 2026

feat: add support for openrouter (apache#12878)

a174cad

	"endpoint": "http://localhost:7737/v1/chat/completions"
	"endpoint": "http://localhost:6724/v1/chat/completions"

Uh oh!

Conversation

SkyeYoung commented Jan 9, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Which issue(s) this PR fixes:

Checklist

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Copilot AI Jan 11, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 11, 2026

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 11, 2026

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

membphis left a comment

Choose a reason for hiding this comment

Uh oh!

bzp2010 left a comment

Choose a reason for hiding this comment

Uh oh!

kayx23 Jan 12, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

kayx23 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

SkyeYoung commented Jan 9, 2026 •

edited

Loading

kayx23 Jan 12, 2026 •

edited

Loading