IO Gateway documentation
Routebook
A working guide for the point where client requests meet provider accounts. Start with the request path, then take the journey that matches the work in front of you.
The request path
Know where a request can change.
IO Gateway is not a provider catalog. It is the decision point between a client’s credentials, the route it asks for, and the accounts allowed to carry that request.
Operator journeys
Choose the work in front of you.
Each route begins with an action and ends with something you can verify. Open the page closest to the decision you need to make, not a generic feature bucket.
-
01
Bring online
Install the gateway, keep its first listener local, and make readiness a fact before any client depends on it.
-
02
Connect capacity
Add provider accounts, understand their state, and use the dashboard as the place to see what can serve traffic.
- Provider accountsAdd, enable, refresh, re-auth, and test upstream provider accounts.
- Codex reset-credit automationSafely preserve an expiring Codex reset credit through a managed local App Server profile when an account limit is reached.
- DashboardUse the operator dashboard for accounts, testing, custom models, keys, and history.
-
03
Set route policy
Draw client boundaries, choose model behavior, and decide when an account or fallback should be preferred.
- API keysCreate managed keys with scopes, input caps, and durable first-use daily, weekly, or monthly token/request quotas.
- Routing and modelsUnderstand gateway endpoints, model prefixes, custom aliases, failover, and routing rules.
- Priority routingPrioritize one or more provider accounts so they are used first until unavailable or fully drained.
- Custom modelsCreate ctm: aliases with provider targets, specific accounts, weights, and fallback chains.
-
04
Prove and observe
Send a real client request, test a route deliberately, and read the account and quota evidence it leaves behind.
- First client requestPoint a client at IO Gateway, inspect its model catalog, and prove a request reaches an upstream account.
- Test APIValidate upstream routes in operator-bypass mode or against a selected managed-key policy.
- Usage and quotaRead usage history, context-token charts, account health, provider quota, and useful admin endpoints.
- NotificationsConfigure Telegram or Google Chat alerts for auth errors, upstream failures, and quota events.
-
05
Repair and release
Work from the symptom outward, then use the release process only after the service is known to be healthy.