Skip to content
Documentation

API Key Management

Distribute and manage API Key credentials for users to call integrated model capabilities via the built-in API gateway.

Create and Manage Keys

  1. In the user list, click the Keys button in the Actions column for the target user.
  2. View and configure settings in the Key Settings panel:
Key settings modal

Configuration details

FieldDescriptionExample/Action
KeySystem-generated high-strength random string starting with sk-.Click the copy icon on the right.
DescriptionNote the purpose of this key for audit.Example: Dev Environment CI/CD
Expiration timeSet the key lifetime. Requests will be rejected after expiration.Select date and time.
Enabled statusControl activation or suspension.Toggle on/off.
  1. Click Save to apply.

Verification and Troubleshooting

After configuration, the user can call Cherry Studio APIs with this key.

  • How to verify? Send a standard Chat Completion request with the key. If you receive a streaming response, the setup is successful.
  • Common errors 401 Unauthorized or Key Expired:
    1. Check whether Expiration time has passed.
    2. Check if Enabled status is off.
    3. Check whether the user's Group has valid model channels configured.

If you want to call Enterprise Express models from third-party clients, IDE plugins, or self-built services, continue to External App Access (Express Models).

Note: An API key represents the user's identity and billing permissions. Remind users to keep it safe and never expose it in public code repositories.