Before you begin
Use the v0.13 CLI and authenticate. Run workspace-management and recipe commands from your local terminal. Commands identified as running inside a workspace require its console terminal or SSH session. Replace example resource IDs with the values returned for your account. Start the target workspace first and verify its identity withrig workspace ls. AI calls require managed credits or an appropriately configured provider account.
How It Works
Every workspace can reach the proxy athttp://172.16.0.1:9090 from inside the VM. When managed mode is active, SDK requests configured to use this endpoint pass through that bridge-local proxy, which fronts an OpenRouter gateway. The proxy:
- Receives the request addressed to the proxy by your workspace code
- Resolves the workspace from the VM’s source IP on the compute bridge
- Injects Rigbox’s managed OpenRouter key (your VM never sees it)
- Forwards the request to OpenRouter, which routes to the appropriate upstream provider for the requested model
- Logs token usage and deducts from your credit balance
- Returns the response to your code
anthropic/claude-sonnet-4, openai/gpt-4o, google/gemini-2.5-pro).
Endpoints
The proxy speaks two HTTP shapes — OpenAI-compatible (used by most SDKs and tools) and an Anthropic-shaped passthrough for Claude Code. Both terminate on the same OpenRouter gateway behind the scenes.A small set of free-tier models is also exposed through a
free alias when Rigbox has the matching managed key. They consume credits at zero rate but otherwise behave identically.Base URLs for clients
Clients take a base URL and add the endpoint path themselves, so the base URL depends on the API shape:
Don’t add
/v1 to an Anthropic base URL: the client would request /v1/v1/messages. The Claude Code catalog item sets ANTHROPIC_BASE_URL to the proxy root for you.
Credit Tiers
Userig status and your account’s credit response to inspect the current balance and renewal information. Included credits depend on your plan; purchased credits and included credit buckets can have different renewal behavior.
Credits map roughly to API cost - one credit equals approximately $0.01 of upstream provider spend. The exact mapping depends on the model and token count.
Activate Managed Mode
With the CLI
Set a workspace to managed mode withrig workspace ai mode:
rig workspace ai mode managed changes that workspace and prints the same suggestions without -w.
Provider and model are account-level defaults. rig ai defaults with no flags shows them; pass flags to change them:
rig ai defaults shows the defaults but can’t change them; change them from your machine.
Inside a Workspace VM
Managed workspaces already injectOPENROUTER_BASE_URL and OPENROUTER_API_KEY into every login shell, so most tools work without any setup step. The rig proxy on helper is a convenience for scripts or CI where you want the exports printed explicitly:
export statements for the proxy’s root and its OpenAI-compatible /v1 base, with the managed-by-rigbox placeholder key that the proxy replaces:
ANTHROPIC_BASE_URL to the proxy root as described in Base URLs for clients.
To deactivate:
rig proxy off unsets RIGBOX_AI_PROXY_URL, and unsets a provider variable only while it still points at the proxy: a base URL such as OPENAI_BASE_URL or ANTHROPIC_BASE_URL whose value is the proxy address, or a key such as OPENAI_API_KEY or ANTHROPIC_API_KEY that holds the managed-by-rigbox placeholder. Your own keys and base URLs stay set, and so do the workspace’s OPENROUTER_BASE_URL and OPENROUTER_API_KEY.
Check Your Credit Balance
The fastest path is the CLI:rig status prints your remaining credits, monthly total, current mode, and active workspaces. For programmatic access, see the Credits API reference.
View Usage Breakdown
Get a daily breakdown of credit consumption across your workspaces.Per-subject cost and budgets
If your app fronts many end-users through a single workspace — a multi-tenant SaaS, an agent platform, a shared chatbot — you can attribute managed-AI cost to each end-user (“subject”), read their spend, and cap it. The proxy is the mechanism (accurate cost, attribution, enforcement); your app owns the policy (which tiers exist, the amounts, the windows) and asserts the subject id over the already-IP-attested channel. This covers the OpenAI-shape endpoints (/v1/chat/completions, /v1/completions, /v1/responses, /v1/embeddings).
Read the settled cost of a call
The settled rigbox-credit cost rides on the response — no second lookup. 1 credit ≈ $0.01; 1,000,000 microcredits = 1 credit.cost_micro is the exact integer; cost_credits is the convenience float. The fields are best-effort: present only when the upstream model reports a cost, so don’t treat their absence as zero.
"stream": true), the same cost_micro / cost_credits are spliced into the final usage chunk:
Attribute a call to a subject
Tag any call withX-Rigbox-Subject (it wins) or the OpenAI user body field. Trimmed; empty = unattributed; capped at 256 characters.
Read a subject’s rolling spend
window accepts 30s / 15m / 5h / 7d or a bare number of seconds (default 86400). It’s a rolling window scoped to your workspace — you can only read your own subjects, and they’re isolated from each other. Attribution is forward-only. This read alone is enough to enforce policy yourself (read spend → decide whether to call); the next section is for letting the proxy do it. See the Get Subject Usage API reference.
Enforce budgets and rate limits
Declare the policy inline on each request and the proxy checks it against the subject’s recorded spend before the call runs:- Amount — a bare number is credits (
5= 5 credits); areqsuffix is a request count (100req). - Window —
5h/30m/3600/7d. - Enforcement requires
X-Rigbox-Subject; with no subject, the limit headers are ignored.
Retry-After header and a structured body. OpenAI SDKs still read error.message / error.code; error.details is the rich payload for your UX:
subject_over_budget, a rate breach 429 subject_rate_limited (budget is evaluated first if several trip), and a malformed limit header 400 subject_limit_malformed. The full schema is in the Chat Completion API reference.
/v1/messages (Anthropic) and the audio endpoints are not yet covered by per-subject attribution or enforcement.What Happens When Credits Run Out
When your credit balance reaches zero:- API requests return HTTP 402 - the proxy rejects new managed AI calls until credits are available
- The UI shows an upgrade prompt - you can upgrade to Pro or switch to BYOK mode
- Existing services keep running - only new AI API calls are blocked; your workspace and non-AI services are unaffected
End-to-End Example
Here is a complete flow: activate managed mode, make an AI call from inside the workspace, then check remaining credits. Step 1 - Activate managed mode for a workspace:rig status prints your balance directly. For the raw payload, query the endpoint with rig api:
Credit deduction happens synchronously - the balance is updated before the proxy returns the response to your code, so a completed request’s settled usage can be checked after its response.
Switching Providers and Models
Because the managed gateway is OpenRouter, you can switch the upstream provider and model at any time by changing themodel field on your request — there’s no environment change, no proxy restart, and no separate “configure provider” step:
rig ai defaults) define the default provider and model used by tools that don’t ask for one explicitly, and are also surfaced by rig proxy status.
Verify and troubleshoot
Inside the workspace, inspectrig proxy status, then make one small request with your chosen tool. Verify the configured endpoint and check the corresponding Rigbox or provider usage. After changing keys or mode, start a fresh shell and restart processes that retained their old configuration. Never print a provider key to verify it.
For failures, start with runtime logs, health checks, or resource exhaustion.
Next Steps
- AI Coding Tools - use Rigbox credits with Claude Code, Codex, OpenCode, and Kilocode
- App Catalog - install the built-in coding agents with one command
- Bring Your Own Keys - use your own API keys for unlimited usage
- Setup Scripts - automate SDK installation in new workspaces
- Service Specs - run AI-powered services as background daemons