docs: add OrcaRouter as alternative OpenAI-compatible provider - #712
docs: add OrcaRouter as alternative OpenAI-compatible provider#712XiaoHuo888-hue wants to merge 1 commit into
Conversation
|
👋 Thanks for contributing XiaoHuo888-hue! We will review the pull request and get back to you soon. |
|
XiaoHuo888-hue please read the following Contributor License Agreement(CLA). If you agree with the CLA, please reply with the following information.
Contributor License AgreementContribution License AgreementThis Contribution License Agreement (“Agreement”) is agreed to by the party signing below (“You”),
|
There was a problem hiding this comment.
Pull request overview
This PR updates the course setup documentation to include OrcaRouter as an additional OpenAI-compatible model provider option, alongside existing alternative providers, and adds corresponding environment variable placeholders to help learners configure it consistently.
Changes:
- Added an “Alternative Provider: OrcaRouter (OpenAI-Compatible)” section to the course setup README with required
.envvariables and example model IDs. - Added
ORCAROUTER_*environment variable entries to.env.examplenext to the existing MiniMax block.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| 00-course-setup/README.md | Documents OrcaRouter as an OpenAI-compatible alternative provider, including required env vars and usage notes. |
| .env.example | Adds an ORCAROUTER_* configuration block to mirror the documentation and guide local setup. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Summary
Adds OrcaRouter as a model provider. OrcaRouter is an OpenAI-compatible model routing gateway that exposes 150+ models from OpenAI, Anthropic, Google, DeepSeek, Qwen, MiniMax, xAI and others behind a single endpoint and API key. It also provides gateway-level security controls for AI agents.
I'm an engineer on the OrcaRouter team.
What this changes
.env.example: adds anORCAROUTER_*block alongside the existing MiniMax block00-course-setup/README.md: adds an "Alternative Provider: OrcaRouter (OpenAI-Compatible)" section alongside the existing MiniMax, Novita AI and Foundry Local sectionsWhy a named provider rather than the OpenAI-compatible escape hatch
The course already lists named alternative providers (MiniMax, Novita AI, Foundry Local) that expose OpenAI-compatible endpoints, and it notes that
OpenAIChatClientworks with any OpenAI-compatible API. This mirrors that same shape for OrcaRouter, so the config reference and setup docs stay consistent for learners who want a single key that routes to many model families.How to use it
sk-orca-).ORCAROUTER_API_KEYin your.env(optionallyORCAROUTER_BASE_URL,ORCAROUTER_MODEL_ID).orcarouter/auto,anthropic/claude-sonnet-4.6oropenai/gpt-5.5. The full catalog is available from the OrcaRouter model directory.Verification
https://api.orcarouter.ai/v1/chat/completions:orcarouter/autoreturns 200 (routes to an upstream reasoning model)anthropic/claude-sonnet-4.6returns 200sk-orca-key returns 401orcarouter/auto,anthropic/claude-sonnet-4.6,openai/gpt-5.5,google/gemini-2.5-flash,deepseek/deepseek-v4-flash-0731) are present in the OrcaRouter model catalog.