Getting StartedAPI keys
// Docs
API keys
Create an API key, choose scopes, and keep it secret.
The public API authenticates with a bearer key. Keys start with shl_live_ and are shown once at creation. Shoulu stores only a hash, so a lost key cannot be recovered; create a new one instead.
Create a key
- Sign in and open Settings → API keys.
- Choose Create API key, give it a name, and confirm.
- Copy the key immediately. The full value is never shown again.
Scopes
Every key carries both scopes:
| Scope | Allows |
|---|---|
urls:write | POST /api/v1/urls |
tasks:read | GET /api/v1/tasks/{id} |
A request missing the required scope returns 403 scope denied.
Send the key
Pass the key in the Authorization header:
curl https://shoulu.co/api/v1/tasks/<task-id> \
-H "Authorization: Bearer shl_live_<key>"Keep keys in a secrets manager or an environment variable. Do not commit them to a repository or send them from a browser.
Revoke a key
To revoke a key, open Settings → API keys and choose Revoke on the row. Revocation takes effect on the next request.