API keys
With an API key, automations and your own programs control your ShortBoost, for example n8n, Make, your own script or Claude Code: create and change short links, fetch QR codes, query click counts and sort links into projects. You copy the key into the program once.
Claude or ChatGPT in the browser, in the app or on your phone? You don't need a key for that. Use "Connect AI", it is simpler: connect once, then just say what ShortBoost should do.
Plan: API keys are available on the Pro and Lifetime plans and for BusinessBoost One accounts.
Create a key
- Open settings. In the dashboard, click the gear icon (Settings) at the top right, then "API keys" on the left.
- New key. Enter a name (e.g. "Claude, create links") and a short description.
- Choose permissions. "Read only" is enough for analysis. "Read and write" allows creating and changing. With "Custom selection" you choose permissions individually; this is the only option that includes deleting. Permissions and expiry date cannot be changed after creation.
- Copy. The key starts with
sbo_live_and is shown only once. Store it safely, e.g. in a password manager.
How to give it to your AI
In the "API keys" area there is a ready-made text to copy. It tells the AI the API address, the authentication and this documentation. Example:
You can control my link shortener ShortBoost through its API.
API address: https://api.shortboost.one/api/v1
Authentication: header "Authorization: Bearer sbo_live_…"
Documentation: https://shortboost.one/help/api-dokumentation
First call GET https://api.shortboost.one/api/v1/key-info to see what you are allowed to do.Permissions at a glance
| Area | read | write | delete |
|---|---|---|---|
| Links (incl. QR codes) | list, view, QR code | create, change, move | delete |
| Statistics | Clicks, countries, devices, UTM | – | – |
| Projects and categories | list | create, change | delete |
"Write" includes "Read" for the same area. Domains, pixels, billing and settings are not available through the API.
Security
- Give a key only the permissions it needs.
- If a key has fallen into the wrong hands: click "Revoke" in the list. It stops working immediately.
- The list shows when a key was last used. It is best to revoke unused keys.
- For BusinessBoost One accounts, only admins of the sub-account may manage keys.