Preparation: Accounts, Keys, Groups, and Credit
{baseUrl} is your platform API root, without a trailing / or /v1. Replace it before using the examples. Available models, prices, and settings depend on your current console and client version.
Register and sign in
- Open the home page and select Sign in / Register.
- Register with an email address, or use an enabled third-party provider such as GitHub, Google, Microsoft, LinuxDO, or WeChat.
- Open the console.
Create an API key (token)
Open Console → Tokens → Add Token.
| Field | Recommendation |
|---|---|
| Name | Use a tool name such as cherry-studio, claude-code, or codex to track usage. |
| Quota | Leave blank for no token-specific limit, subject to the account balance, or set a cap to isolate costs. |
| Expiration | Leave blank for no expiration. A 90-day expiration is recommended for production. |
| Group | Determines which models the key can access. The groups shown in your token settings are available to your account. |
| Model restrictions | Leave blank to allow all available models, or select an allowlist. |
Use a separate key for each tool. This makes usage easier to track and lets you revoke a compromised key without interrupting other tools. Claude Code and Codex may require a particular group.
If your deployment supports automatic grouping, leaving the group blank lets the platform select an available group for the requested model. This is convenient but makes cost attribution less precise.
Two different credentials: model requests use a model API key beginning with sk-. Management endpoints under /api/... use an access token generated after signing in. They are not interchangeable.
Add credit
Open Console → Wallet / Top Up. Depending on the deployment, you can pay online or redeem a code. Charges are deducted from your balance on a pay-as-you-go basis.