Skip to content

docs: add OrcaRouter as a named compatible provider #18

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
kuswardhanietidims-svg wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: add OrcaRouter as a named compatible provider #18

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 8 additions & 1 deletion .env.example
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,18 @@
# LLM Provider Configuration
# Support Anthropic API or compatible providers (e.g. OpenRouter)
# Support Anthropic API or compatible providers (e.g. OpenRouter, OrcaRouter)
ANTHROPIC_API_KEY=sk-ant-xxxxx
MODEL_ID=claude-sonnet-4-20250514

# Optional: custom base URL for API-compatible providers
# ANTHROPIC_BASE_URL=https://openrouter.ai/api/v1

# OrcaRouter: OpenAI-compatible AI gateway (models + agents), with adaptive
# routing, failover, observability, guardrails and agent-tool governance.
# Works with the Anthropic SDK via base_url; use a namespaced model id:
# ANTHROPIC_API_KEY=<your OrcaRouter key>
# ANTHROPIC_BASE_URL=https://api.orcarouter.ai
# MODEL_ID=orcarouter/auto

# Telegram (optional, for s04_channels.py)
# TELEGRAM_BOT_TOKEN=123456:ABC-DEF

Expand Down
4 changes: 4 additions & 0 deletions README.ja.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,6 +81,10 @@ pip install -r requirements.txt
# 3. 設定
cp .env.example .env
# .env を編集: ANTHROPIC_API_KEY と MODEL_ID を設定
# 互換性のある API ゲートウェイを名前付きプロバイダーとして使うこともできます (例: OrcaRouter):
# ANTHROPIC_API_KEY=<あなたの OrcaRouter キー>
# ANTHROPIC_BASE_URL=https://api.orcarouter.ai
# MODEL_ID=orcarouter/auto

# 4. 任意のセクションを実行 (言語を選択)
python sessions/ja/s01_agent_loop.py # 日本語
Expand Down
4 changes: 4 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,6 +81,10 @@ pip install -r requirements.txt
# 3. Configure
cp .env.example .env
# Edit .env: set ANTHROPIC_API_KEY and MODEL_ID
# Or use any API-compatible gateway as a named provider, e.g. OrcaRouter:
# ANTHROPIC_API_KEY=<your OrcaRouter key>
# ANTHROPIC_BASE_URL=https://api.orcarouter.ai
# MODEL_ID=orcarouter/auto

# 4. Run any section (pick your language)
python sessions/en/s01_agent_loop.py # English
Expand Down
4 changes: 4 additions & 0 deletions README.zh.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,6 +81,10 @@ pip install -r requirements.txt
# 3. 配置
cp .env.example .env
# 编辑 .env: 填入 ANTHROPIC_API_KEY 和 MODEL_ID
# 也可使用任意 API 兼容网关作为命名服务商, 例如 OrcaRouter:
# ANTHROPIC_API_KEY=<你的 OrcaRouter key>
# ANTHROPIC_BASE_URL=https://api.orcarouter.ai
# MODEL_ID=orcarouter/auto

# 4. 运行任意章节 (选择你的语言)
python sessions/zh/s01_agent_loop.py # 中文
Expand Down