Files

T

boos e0a5f57793 feat(desktop): embed BoosAPI Desktop client as a subproject

Vendor the rebranded BoosAPI Desktop client (Tauri + Vue) into metapi as
a monorepo subdirectory under desktop/. Source only — node_modules,
dist, Cargo target and the upstream .git history are excluded.

desktop/ keeps its own independent Cargo workspace (desktop/src-tauri
with crates/*); it is not part of the backend boosapi crate, so a
`cargo check` at the metapi root still compiles only the backend. Build
the desktop app from desktop/src-tauri per desktop/README.md.

Note: app icons are still placeholder assets pending the final BoosAPI
logo. The updater signing keys live outside the repo and are not
included.

2026-06-22 11:32:57 +08:00

5.1 KiB

Raw Blame History

API Gateway

What is the API Gateway?

BoosApi includes a built-in local API server that exposes your configured providers as OpenAI-compatible, Claude-native, and Gemini-native endpoints. Any tool or client that speaks one of these protocols can use BoosApi as its backend — no separate API keys or relay services required.

Use cases:

Run Claude Code CLI, OpenAI Codex CLI, Gemini CLI, or OpenCode through BoosApi.
Feed your IDE extensions through a single, locally managed endpoint.
Share one set of provider keys across many tools with per-key rate limiting.

Getting Started

Open Settings → API Gateway (or press Cmd/Ctrl+Shift+G).
Click Start to launch the gateway server.
By default the server listens on 127.0.0.1:8080 (HTTP). You can change the listen address and port in the Settings tab.

::: tip Enable Auto-start in the gateway settings to launch the server automatically when BoosApi starts. :::

API Key Management

The gateway authenticates incoming requests with its own API keys, separate from your provider keys.

Go to the API Keys tab.
Click Generate New Key.
Optionally add a description (e.g. Claude Code, VS Code) to identify each key.
Copy the key — it is only displayed once.

Each key shows its prefix, creation date, and last used timestamp. You can enable/disable or delete keys at any time.

::: warning Treat gateway keys like any other API key. Anyone with the key can send requests to your local gateway while it is running. :::

SSL/TLS

The gateway can serve HTTPS alongside or instead of HTTP.

Auto-Generated Certificate

Open the Settings tab.
Enable SSL/TLS and select Generate mode.
BoosApi creates a self-signed certificate and private key at:
```
~/.boosapi/ssl/cert.pem
~/.boosapi/ssl/key.pem
```
Set the HTTPS port (default 8443).
Optionally enable Force SSL to redirect all HTTP requests to HTTPS.

Custom Certificate

Select Upload mode and provide the paths to your own certificate and private key files.

::: info The private key is stored with file mode 0600 on Unix systems to prevent other users from reading it. :::

Usage Analytics

The Metrics tab provides dashboards for monitoring gateway activity:

View	Description
By API Key	Request volume and token usage broken down by each gateway key
By Provider	Requests and tokens routed to each upstream AI provider
By Day	Daily usage trends over time

Use these dashboards to track cost, spot anomalies, and balance load across providers.

Request Logs

The Overview tab shows recent request logs with the following details:

Timestamp, HTTP method, path
Status code and response time
Provider and model used
Token count (prompt + completion)

Click any log entry to inspect the full request and response. Use the Clear Logs button to reset the log history.

Configuration Templates

BoosApi ships with ready-made configuration snippets for popular CLI tools. Go to the Templates tab, pick a tool, and click Copy to get the configuration you need.

Claude Code CLI

claude config set --global apiUrl http://127.0.0.1:8080
claude config set --global apiKey boosapi-xxxx

OpenAI Codex CLI

export OPENAI_BASE_URL=http://127.0.0.1:8080/v1
export OPENAI_API_KEY=boosapi-xxxx
codex

OpenCode

Add to your OpenCode configuration:

{
  "provider": "openai",
  "baseURL": "http://127.0.0.1:8080/v1",
  "apiKey": "boosapi-xxxx"
}

Gemini CLI

export GEMINI_API_BASE=http://127.0.0.1:8080
export GEMINI_API_KEY=boosapi-xxxx
gemini

Custom Client

Any tool that accepts an OpenAI-compatible base URL can connect to the gateway:

Base URL:  http://127.0.0.1:8080/v1
API Key:   boosapi-xxxx

Replace boosapi-xxxx with a key generated in the API Keys tab. If SSL is enabled, use https:// and port 8443 (or your configured HTTPS port).

Connecting External Tools

Below is a general pattern for connecting any OpenAI-compatible client:

Generate a gateway API key in BoosApi.
Set the base URL in your tool's configuration to http://127.0.0.1:8080/v1 (or the HTTPS equivalent).
Set the API key to the gateway key you generated.
Select a model that you have configured in one of your BoosApi providers.
Start using the tool — all requests route through BoosApi to the upstream provider.

::: tip If a tool requires a specific API format (e.g. Claude or Gemini native), BoosApi automatically detects the request format and routes it to the correct provider. You do not need to configure separate endpoints per format. :::

Next Steps

Getting Started — return to the quick start guide
Configure Providers — add the upstream providers the gateway routes to
MCP Servers — connect external tools for AI tool calling

5.1 KiB Raw Blame History