User GuideAPI ReferenceAI Applications

🔑 API Keys

API keys are the core credentials for calling APIs. Create and manage each key's quota, models, groups, and security source restrictions.

Click API Keys in the left navigation, or directly visit /keys. The page clearly displays key names, masked keys, status, quota usage progress, and bound groups, while supporting keyword search, copying, editing, enabling/disabling, and batch management. In the row action menu, you can also directly copy connection configurations or send credentials to supported desktop chat clients with one click.

Create API Key

  1. Open the "API Keys" management page and click the "Create API Key" button.
  2. Enter an easily identifiable key name (e.g., "Cursor Dev Environment", "Production Service").
  3. Configure call quota, expiration time, model whitelist restrictions, IP whitelist, and group as needed.
  4. Click Submit, and the system will generate the complete API key for you to copy and save.

Configuration Details

Configuration OptionDescription
NameCustom name. It is recommended to name it according to usage scenarios or applications for easy billing distinction and statistics.
GroupSpecify the channel group accessed by this key (e.g., Default Group, High-Speed Group, or specific subscription group).
Auto Group OrderOnly takes effect when the group is set to auto; it can inherit the system default routing order or customize a dedicated priority for this key.
Cross-Group Retry ToggleWhen enabled, if a channel in the preferred group fails or is rate-limited, it automatically and seamlessly retries with the next candidate group to ensure high availability.
Expiration TimeSet the key expiration time. Subsequent requests will be automatically rejected after expiration. Leave blank for never expire.
QuantitySupports batch creating multiple keys at once (the system will automatically append random suffixes).
QuotaAllocate an independent consumption limit for this key to prevent a single key from overconsuming the main account balance.
Unlimited Quota ToggleWhen enabled, it is not subject to the independent quota limit (but still constrained by the overall account balance).
Model RestrictionsRestrict this key to only call specified whitelisted models, preventing accidental calls to expensive models.
IP WhitelistEnter allowed IPv4/IPv6 addresses or CIDR blocks line by line. Leave blank for no source IP restrictions.

API keys are equivalent to your account credentials. Never commit plaintext keys to public GitHub repositories, frontend client code, or public chat tools; if you suspect a leak, delete the key immediately and generate a new one.

View and Copy API Keys

Click the masked key in the API key list and complete the security verification as prompted to copy the full key.

Click "Copy Connection Info" to combine the Base URL and API Key into a standard client connection string with one click; you can also click the target chat client icon to launch the local client via browser protocol and automatically fill in the configuration.

Edit API Key

Locate the target key in the list and click the "Edit" button to adjust its quota limit, model whitelist, expiration time, or IP restrictions at any time (modifying configurations does not change the API Key itself).

Enable, Disable, and Delete

  • Enable / Disable: Temporarily suspend call permissions while preserving configurations. Calling permissions can be restored upon re-enabling.
  • Delete: Permanently destroy the key credential. Deletion is irreversible; please ensure no active services depend on it before deleting.

Was this page helpful?

🔑 API Keys | OpenRely Docs