First request
Connect one subscription account and make your first client request without configuring usage allowances.
New to SubLane? Follow the chapter-by-chapter tutorial, which checks the result at each step. This page is a compact checklist for readers already familiar with the flow.
This guide is for the administrator setting up an instance. You need one supported subscription account and a client. It uses Codex as the example.
If you already have a member login, start with personal keys instead.
1. Start SubLane
With Docker, Compose, Bash, curl and jq installed, run:
curl -fsSL https://raw.githubusercontent.com/murongg/SubLane/main/scripts/install.sh | bash -s -- --runtime docker --proxy noneThe installer creates ./sublane and will not overwrite an existing directory. You can review the script before running it.
Open 127.0.0.1:8080, create the administrator, and name your first workspace in the guided setup. If your instance is already running, use its address and skip installation. On a remote server, use an SSH tunnel for initial access; see deployment for network setup and HTTPS before sharing it.
Ready to continue: you can sign in and open Accounts.
2. Connect one subscription
In Accounts, add a Codex account through browser authorization. After authorizing, copy the complete localhost callback address from the browser address bar back into SubLane. A localhost connection error at this point is expected; copy the address anyway.
Select Verify connection, then open Models to check the available model IDs. For credential import, follow Connect an account.
Ready to continue: the account is enabled, verification succeeds and its model list contains a model you want to use.
3. Put the account in a pool
Open Account pools, create a pool with a name you recognize, select the subscription account, and save. An account pool is simply the set of subscription accounts a key can use.
New accounts are initially Unassigned. Creating a pool is required; a default pool is not created automatically. Leave model restrictions off for this first connection.
You are signed in as the administrator, so you can use this enabled pool without a separate member grant. To give members access later, follow Members and access.
Ready to continue: the pool contains your enabled subscription account.
4. Create your personal key
Open API keys, create a key, name it, and select your pool. Copy the key for your client. Keep the default expiry unless you need a specific deadline.
This is a SubLane gateway key, separate from the provider's subscription credentials. You do not need a resource allowance, percentages or prices.
Ready to continue: you have a key and a model ID from that pool.
5. Connect the client and send a message
Open the key's configuration guide and follow Codex client configuration. Use your instance address ending in /v1, your personal key, and a model ID from the pool. For a local instance, the base URL is http://127.0.0.1:8080/v1.
Send a short message from the client. Check that a response arrives, then open Requests in SubLane to find the call. A successful login or a visible model list alone does not prove generation works.
Finished: your client receives a model response and the request is recorded. You can use the gateway now.
If a step does not work
| Symptom | Check first |
|---|---|
| No pool to select | Create an enabled account pool and assign the account. Members also need a direct pool grant in this workspace. |
| No model available | Verify the account connection and check its model list. See model discovery if it remains empty. |
| The client rejects the key | Check the key, its status and the configured instance address. See personal keys. |
| A request fails | Inspect the matching request and use Everyday use to narrow down the cause. |
Next, only if needed
To add colleagues, continue with Members and access. To inspect calls and usage, see Everyday use. Usage allowances and advanced controls are optional.
Use Guided setup in the top-right toolbar to open or replay the floating guide at any time, including after a successful call. The overview also offers Start guided setup while setup is incomplete. It highlights the real action on the accounts, pools, or keys page and unlocks Next step after the server confirms completion. Use Previous step to revisit a step or Skip guide (Escape) to leave; starting again uses the current workspace’s actual progress. An active guide resumes after a reload in the same browser tab and stays scoped to the signed-in user and workspace.
The guide yields to authorization, pool, key, and client-configuration dialogs so it does not cover fields or dismiss a newly created key. Each personal key has a client guide with its permitted model list. The final step completes only after a successful generation is recorded; viewing models or creating a key does not count as a successful call.