API keys
Create, scope, rate-limit, expire, rotate and revoke clsk_ keys for the Agent API, Model API and Code Buckets.
- Can Clatter Labs support see or recover my API key?No. Only a keyed hash is stored, so nobody can see or recover a key. Never send a key to anyone, including support.FAQ
- Can I undo revoking a key?No. Revoking is permanent. Create a new key with the same permissions and rate limit instead.FAQ
- Can I use the same API key on several servers?Yes, it works, but they share one rate limit and you can't revoke one server alone. Separate keys are usually better.FAQ
- Can one API key work for the Agent API, the Model API and Code Buckets?Yes, if you give it the permissions for each. Separate keys per product are safer and make Logs easier to read.FAQ
- How can my code tell how close it is to a key's rate limit?Responses include X-RateLimit-Limit and X-RateLimit-Remaining; a 429 adds Retry-After with seconds to wait.Reference
- How do I clean up old API keys?Review the keys list, check Last used and Access, and revoke keys you no longer need. Revoked keys stay listed under All.How-to
- How do I create a key for Code Buckets?Choose the Code Buckets preset (buckets:read, buckets:write, backups:write), or customize for read-only access.How-to
- How do I create a key for the Agent API?The default Agent API preset gives runs:write and runs:read. Add account:read if your code checks the balance.How-to
- How do I create a key for the Model API?Choose the Model API preset, which gives the key models:invoke. Then use it with the base URL and your Account ID.How-to
- How do I create an API key?In the Console go to API keys › Create API key, name it, pick permissions, a rate limit and an expiry, then copy the key once.How-to
- How do I give a key a custom set of permissions?In Create API key, select Customize and tick individual permissions under Agent API, Model API and Code Buckets.How-to
- How do I revoke an API key?In API keys, select Revoke on the key and confirm. It stops working immediately everywhere and can't be undone.How-to
- How do I rotate an API key without downtime?Create a new key, deploy it, confirm traffic moved using Last used, then revoke the old key. There's no one-click rotate.How-to
- How should I name my API keys?Use names that say where and why a key is used, like "Backend (prod)" or "CI uploads". Names can be up to 64 characters.FAQ
- How should I set up keys for development, staging and production?Create a separate key per environment with matching permissions, shorter expiry for dev, and names that show the environment.How-to
- I can't create another API key. Is there a limit?An account can have up to 25 active keys. Revoke keys you don't need to make room. The Playground's key doesn't count.Troubleshooting
- I created a key but can't see it in the list. Where is it?Check the Active/All filter, that you're in the same account, and reload. Expired and revoked keys show only under All.Troubleshooting
- I lost my API key. Can I get it back?No. Keys are shown only once and can't be recovered. Create a new key, update your app, and revoke the old one.Troubleshooting
- I'm sharing a script with others. How do I handle the key?Never include your key. Have each person create their own key, or run the script on your server.FAQ
- My API key suddenly stopped working. What changed?The key may have expired, been revoked, lost its team access, or your account may be paused. The error code tells you which.Troubleshooting
- What do the API key permission presets include?The five presets in Create API key: Agent API, Model API, Code Buckets, Read only and Full access, and the scopes in each.Reference
- What does "Last used" mean in the API keys list?Last used shows when a key last made a request, or "Never". Use it to find unused keys and check rotations.FAQ
- What does each API key permission allow?Every Console key permission explained: runs:write, runs:read, account:read, models:invoke, buckets:read, buckets:write, backups:write.Reference
- What happens when I revoke an API key?Requests with a revoked key fail at once with 401 invalid_api_key, open event streams end, and the key can't be restored.FAQ
- What if I need more than 120 requests per minute?120 per minute is the highest per-key choice. Use separate keys per service, stream instead of polling, or ask support.FAQ
- What is an API key?An API key is a secret starting with clsk_ that lets your code use the Agent API, Model API or Code Buckets on your account.Explainer
- What is the "Console Playground" key in my list?It's a key the Console manages for you so the Playground can call the APIs. It doesn't count toward your 25 keys.FAQ
- When do API keys expire?You choose when you create the key: 30 days, 90 days (default), 1 year or Never. Expired keys stop working.FAQ
- Which key should a monitoring dashboard use?A Read only key (runs:read, account:read, buckets:read) can show runs, balance and storage without being able to spend.How-to
- Which rate limit should I pick for an API key?Keys allow 10, 30, 60 or 120 requests per minute. 30 is the default; pick higher for busy services, lower for small scripts.FAQ
- Why do Clatter Labs keys start with clsk_?clsk_ marks a Clatter Labs secret key, so you and secret scanners can recognise one and keep it out of code and logs.FAQ
- Why does the keys list only show part of my key?The list shows a short hint so you can tell keys apart. The full secret is never stored or shown after creation.FAQ
- Why is my API key shown only once?Clatter Labs stores only a keyed hash of your key, so the full key can't be displayed again. Copy it when it's created.FAQ
Still need help?
Tried the steps above and still stuck? Email us. We usually reply within the first hour, and always within 24 hours. A full support team is with you.
Infrastructure questions, or permanent deletion of your data
infrastructure@clatterlabs.xyzFor deleting your whole account or the data of one service.