Create an API key
An API key lets a client or program call Guangji API. First sign in to the console.
Create a key
- Open API keys; some versions call this Tokens.
- Choose Create API key or Add token.
- Enter a recognizable name, such as
Cherry Studio - laptop. - Select an available group, spending limit and expiry date.
- Save, then copy the complete key from the list. Complete any additional security verification requested.
Settings for your first key
| Setting | Suggested approach |
|---|---|
| Name | Identify the application or device |
| Group | Choose a group whose availability and prices you have checked |
| Limit | Start with a reasonable test budget; adjust it later |
| Expiry | Use a short period for temporary testing and review long-lived keys regularly |
| Model restrictions | Allow only the models needed when restricting a key's purpose |
| IP restrictions | Set these only when you know the actual outbound IP |
Home networks, mobile connections and proxies can change outbound IPs. An incorrect allowlist can reject legitimate requests.
Copy the complete value
Use the copy button. Do not copy a masked value such as sk-****, or add quotation marks, spaces or newlines.
Keep it private
Anyone with the key may be able to spend your account balance. Do not share it in group chats, support conversations or screenshots.
Next, connect a client or send an API request.