Getting Started

!

IMPORTANT

A word of advice before you start!

01📖

Before deploying and using the service, be sure to read the Model Groups and FAQ sections. If you have time, read the whole guide.

02💡

We always believe in "teach a person to fish, don't just give them a fish"

03✅

These two sections not only improve your experience, they also answer 90% of the questions you would otherwise ask in the group.

Please read the above carefully

i

Let's start here!

Your TokenFlow journey from scratch~

Take it step by step — you'll be fine!

Step 1: Register an Account

• Registration link: https://tokenflow.run/register

After opening the registration link, click "Register" in the top-right corner. If you are on the login page, you can also click "No account? Register" at the bottom to start the registration flow.

Option 1: Register with Email

1. Click "Register with username".
2. Fill in your email, username, and password.
3. Submit as prompted to complete registration.

Note

Your email is used to receive verification and notifications. We recommend a password that combines letters, numbers, and special characters. Keep your login credentials safe to avoid account theft.

Step 2: Sign In

• Login link: https://tokenflow.run/login

Sign in with Email/Username

1. Enter your email address or username.
2. Enter your account password.
3. Click "Continue" to sign in.

Device login note

The browser keeps you signed in; on a new device you need to repeat the login flow.

You can also clear the browser cache and try again:

• Windows / Linux Chrome: press Ctrl + Shift + Delete to open the clear browsing data page.
• macOS Chrome: press Command + Shift + Delete to open the clear browsing data page.

Step 3: Add Credit

Click the link https://pay.ldxp.cn/shop/N0IK02WR and select TokenFlow to purchase credit.

1. In "Redeem", enter the activation code for the credit you purchased.
2. Click the redeem button to automatically add the corresponding credit.

Payment note

The current top-up ratio is 1:1, meaning 1 CNY equals 1 USD of credit. If the payment page does not pop up when using Alipay or WeChat Pay, disable your proxy and try again.

Step 4: Create an API Token

After signing in, open the console dashboard and select the option on the left.

Open API Keys

1. Click "Create key" in the left menu.
2. A "Create key" dialog appears at the top of the page.

Create a New Token

Fill in the token details in the dialog:

• Token name: used to distinguish purposes, e.g. Claude Code, Codex, Gemini.
• Token group: required. The group determines which models this token can use.
• Custom key: you can customize the key. Only letters, numbers, underscores, and hyphens are allowed, with a minimum of 16 characters.
• IP restriction: if you are unfamiliar, keep the default and do not enable model restrictions or an IP allowlist.
• Credit limit: even with "unlimited credit" enabled, the token's actual available credit is still capped by the account balance.
• Rate limit: sets the maximum spend for this key within a given time window. 0 = unlimited.
• Key validity: defaults to "never expires"; you can also set an expiry as needed.

Choose the token group correctly

The token group directly affects which models are available. For example, Claude Code, Codex, and Gemini CLI each need the matching group. If you pick the wrong group, you'll likely hit "model not found" or call failures when configuring the CLI later.

Once filled in, click "Create" in the bottom-right to finish.

View Models Available in a Group

You can check which models each token group supports under "Available channels".

1. Click "Available channels" in the top-right corner.
2. The available groups are shown on the left under "Available channels".
3. Each model card shows the models, prices, and discount multipliers available in that group.

Step 5: Environment Check

Before configuring Claude Code, Codex, or Gemini CLI, confirm that Node.js is correctly installed on your machine.

Run the following in a Windows, macOS, or Linux terminal:

npm list -g --depth-0

If the command runs normally, Node.js and npm are ready. Even if no global packages are listed, it does not affect the following setup.

If you see "command not found" or a similar error, Node.js is not installed yet, or it was not added to the system PATH correctly. Install Node.js first, then rerun the command above to confirm.

Complete the environment check first

The CLI tools depend on Node.js and npm. If the environment is not ready, installing Claude Code, Codex, or Gemini CLI later may fail.

Step 6: Configure CLI Tools

TokenFlow supports Claude Code, Codex, and Gemini CLI on the command line.

Prerequisites

Before configuring the CLI, complete the following steps:

1. Finish the environment check to ensure Node.js and npm work.
2. Install the CLI — install Claude Code, Codex, and Gemini CLI.

OpenAI-compatible endpoints need /v1

If you use an OpenAI-compatible client or tool — for example Codex, the OpenAI SDK, or Cherry Studio's OpenAI-compatible config — append /v1 to the API address.

Dedicated config reference tutorial

For dedicated configs like Claude Code and Gemini CLI, you can watch the CC-Switch video tutorial and follow the examples there. If you really can't figure it out, you can ask a human agent for help — assuming the agent has time 😏.