trending/ai-memory
1
0
Fork 0
mirror of https://github.com/akitaonrails/ai-memory.git synced 2026-10-02 03:24:46 +08:00
Code Issues Packages Projects Releases Wiki Activity

docs: show API Route openai-compat configuration

Browse Source
This commit is contained in:
DennyHo0917
2026-09-30 15:07:20 +08:00
parent dcb475c6bb
commit c4ae6b31aa
3 changed files with 22 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files
CHANGELOG.md
+4
View File
@@ -7,6 +7,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
## [Unreleased]
### Changed
- Documented API Route as an endpoint for the existing `openai-compat`
provider.
### Fixed
- `install-hooks --apply --as-user <user> --auth-token <key>` no longer fails
with `--as-user '<user>' requires --auth-token` when the token was supplied.
docs/install.md
+16
View File
@@ -1916,6 +1916,22 @@ another current Cheaper Inference model id (e.g. `claude-haiku-4.5` or
`deepseek-v4-flash`) when needed. Cheaper Inference serves chat models only
and has no embeddings endpoint; configure embeddings separately.
[API Route](https://www.api-route.com/) also uses the existing
`openai-compat` provider. Supply an API Route key and a model ID from its
[current catalog](https://www.api-route.com/pricing):
```bash
-e AI_MEMORY_LLM_PROVIDER=openai-compat
-e AI_MEMORY_LLM_BASE_URL=https://global.api-route.com/v1
-e AI_MEMORY_LLM_MODEL=gpt-5.5
-e LLM_API_KEY="$API_ROUTE_API_KEY"
```
Replace `gpt-5.5` with the exact model ID you intend to use. As with other
hosted compatibility endpoints, no dedicated ai-memory provider is required.
Configure embeddings separately if your chosen API Route model does not
provide an OpenAI-compatible embeddings endpoint.
OpenAI-compatible structured calls use the operation's JSON Schema by default:
```bash
docs/llm-providers.md
+2 -2
View File
@@ -50,7 +50,7 @@ Recommended defaults:
| `copilot` | `gpt-5.5` | GitHub Copilot Chat backend via `ai-memory auth login copilot` or `COPILOT_GITHUB_TOKEN`; requires a Copilot subscription. |
| `gemini` | `gemini-3.5-flash` | Google-hosted option with a generous free tier. |
| `opencode` | `claude-sonnet-4-6` | OpenCode Go or Zen via `OPENCODE_API_KEY`. Go is the default endpoint; `AI_MEMORY_LLM_BASE_URL` selects Zen. Set `AI_MEMORY_LLM_MODEL` to an id the chosen endpoint serves. |
| `openai-compat` | no default | OpenRouter, Atlas Cloud, OrcaRouter, Cheaper Inference, Ollama, vLLM, LM Studio, and other compatible endpoints. |
| `openai-compat` | no default | OpenRouter, Atlas Cloud, OrcaRouter, Cheaper Inference, API Route, Ollama, vLLM, LM Studio, and other compatible endpoints. |
| `openai-compat` + `AI_MEMORY_LLM_BASE_URL=https://openrouter.ai/api/v1` | no default (recommended: `anthropic/claude-haiku-4.5`) | Hosted access to a large model catalogue through one key. See [OpenRouter](#openrouter) below and the empirical comparison in [`llm-provider-comparison.md`](llm-provider-comparison.md). |
`openai-oauth` stores a refresh token in `<data_dir>/auth.json` and talks to
@@ -371,7 +371,7 @@ sentence embeddings run in-process (pure-Rust `all-MiniLM-L6-v2`,
pinned checksums — see [`docs/local-embeddings.md`](local-embeddings.md).
See [`docs/install.md#llm-provider-tiers`](install.md#llm-provider-tiers)
for env vars and Ollama/OpenRouter/Atlas Cloud/OrcaRouter/Cheaper Inference
for env vars and Ollama/OpenRouter/Atlas Cloud/OrcaRouter/Cheaper Inference/API Route
examples, and
[`docs/llm-provider-comparison.md`](llm-provider-comparison.md)
for the empirical model comparison.