Skip to content

docs: document using OrcaRouter as the AI provider #331

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
XiaoHuo888-hue wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: document using OrcaRouter as the AI provider #331

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
18 changes: 18 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -703,6 +703,24 @@ Huly provides AI-powered chatbot that provides several services:
> [!NOTE]
> You can also add the `AI_OPENAI_MODEL`, `AI_OPENAI_TRANSLATE_MODEL`, `AI_OPENAI_SUMMARY_MODEL` environment variables to the aibot service to use a different model, by default it uses `gpt-4o-mini` for all of them

### Use OrcaRouter as your AI provider

If you don't have an OpenAI account, you can route the AI service through [OrcaRouter](https://www.orcarouter.ai), an OpenAI-compatible gateway that exposes many models through a single API key. Follow the steps above, but configure the `aibot` container with your OrcaRouter key and base URL:

```yaml
aibot:
...
environment:
# your OrcaRouter API key (starts with sk-orca-)
- OPENAI_API_KEY=<ORCAROUTER_API_KEY>
- OPENAI_BASE_URL=https://api.orcarouter.ai/v1
# optional — `orcarouter/auto` picks the best model automatically
- AI_OPENAI_MODEL=orcarouter/auto
...
```

No other changes are required: the AI service uses the standard OpenAI-compatible chat completions API, which OrcaRouter implements.

## Configure Google Calendar Service

To integrate Google Calendar with Huly, follow these steps:
Expand Down
3 changes: 3 additions & 0 deletions helm/huly/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -341,6 +341,9 @@ All app services share these overridable keys: `<svc>.replicas`, `<svc>.resource
| `secrets.openaiApiKey` | OpenAI API key (required when enabled) | `""` |
| `secrets.openaiBaseUrl` | OpenAI API base URL override | `""` |

> [!TIP]
> The AI bot uses the standard OpenAI-compatible chat completions API. To route it through [OrcaRouter](https://www.orcarouter.ai), an OpenAI-compatible gateway with a single API key, set `secrets.openaiApiKey` to your OrcaRouter key (starts with `sk-orca-`) and `secrets.openaiBaseUrl` to `https://api.orcarouter.ai/v1`. You can optionally set `aibot.openaiModel` to `orcarouter/auto` to let the gateway pick the best model automatically.

### Global Pod Settings

| Key | Description | Default |
Expand Down