Getting Started
How to Create Your First API Key
Generate an sk-... API key in the API Keys section, assign the Auto-A group, and configure quota limits.
Every external client, IDE extension, or script connects to Nyxos API using a bearer key starting with sk-.... Keys are created in the panel's API Keys section.
Creating a Key in the Dashboard
1. Open the API Keys Section
- Log in to https://api.nyxos.shop.
- In the left sidebar, open API Keys under Console (direct URL:
https://api.nyxos.shop/keys).
2. Create a New Key
Click + Add Token to open the key configuration form.
3. Configure the Key
| Field | Recommended Value | Explanation |
|---|---|---|
| Name | e.g. Claude-Code-Agent, Cline-VSCode | A clear label describing where the key is deployed. |
| Group | Auto-A (recommended) | The automatic routing group — gives the key access to the gateway's models with automatic channel routing. See Groups & Multipliers. |
| Quota | Unlimited, or a safety cap | Per-key spending limit that protects you against runaway agent loops. |
| Expired Time | Never expire (or a custom date) | Useful for temporary test environments. |
4. Copy and Store Your Secret Key
- Once created, copy the key: it follows the format
sk-xxxxxxxxxxxxxxxx. - The full key is only shown once — store it immediately.
- Security notice: keep keys in environment variables (
.env, system env vars). Never commit raw keys to public repositories.
Key Management & Monitoring
From the API Keys table you can at any time:
- Monitor consumption and remaining quota per key.
- Temporarily disable or re-enable a key, or delete a compromised one.
- Edit a key's quota, expiration and group without changing the key string.
Using the Key
Send it as a standard bearer credential:
curl https://api.nyxos.shop/v1/chat/completions \
-H "Authorization: Bearer sk-YOUR_NYXOS_KEY" \
-H "Content-Type: application/json" \
-d '{
"model": "<exact-model-id-from-/pricing>",
"messages": [{"role": "user", "content": "Hello"}]
}'See Base URL Rules to pick the right endpoint for your client.