Skip to content

docs(guide): document API Route configuration #308

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

docs(guide): document API Route configuration #308

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 docs/guide/new-backend.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ A single `base_url` + `api_key` pair lets you point SkillOpt at, for example:
| OpenRouter / Fireworks / xAI / … | provider base URL | provider model id |
| OrcaRouter | `https://api.orcarouter.ai/v1` | `openai/gpt-5.5` |
| Cheaper Inference | `https://api.cheaperinference.com/v1` | `gpt-5.4-mini` |
| API Route | `https://global.api-route.com/v1` | `gpt-6.1-sol` |

[OrcaRouter](https://www.orcarouter.ai) exposes OpenAI, Anthropic, Google,
DeepSeek and other models behind one OpenAI-compatible endpoint. Its model IDs
Expand All @@ -40,6 +41,23 @@ the bare ID as the model. See its [API docs](https://www.cheaperinference.com/do
for the base URL and its [model list](https://www.cheaperinference.com/markets)
for the model IDs.

For [API Route](https://www.api-route.com/), use the exact gateway model ID,
such as `gpt-6.1-sol` or `claude-fable-5-1`, without adding an upstream-provider
prefix. Both use `openai_compatible` here. Its authenticated `/models` catalog
depends on the key's group and account permissions; choose a chat model visible
to that key rather than assuming every model on the public pricing page is
available. See the [API documentation](https://github.com/DennyHo0917/api-route/blob/main/API.md)
for Bearer authentication and model discovery.

```bash
export OPENAI_COMPATIBLE_BASE_URL="https://global.api-route.com/v1"
export OPENAI_COMPATIBLE_API_KEY="your_api_route_key"
export OPENAI_COMPATIBLE_MODEL="gpt-6.1-sol"
```

Select `openai_compatible` for each role as described in the environment-variable
section; these connection variables do not select the training script's backend.

### Python API

Select and configure the backend directly when embedding SkillOpt as a Python
Expand Down