API keys
Make a personal API key, scope it to the organizations it needs, and re-roll or revoke it when it's no longer safe.
2 min read · Updated 31 Oct 2026 · For developers
Before you begin
How keys work
A key is personal. It acts as you, with your normal permissions, in the organizations you choose. Requests send it as a bearer token:
Authorization: Bearer pulse_…Keys start with pulse_. A key scoped to exactly one organization works there without saying which.
A key for several organizations, or for all of them, needs the organization's workspaceId on each
request.
Create API key
Keys inherit your normal permissions in the selected organizations.
Step 1: Open API keys
Press your name at the bottom of the sidebar, then Settings, then API keys. The page lists your keys, with when each was made, when it was last used and when it expires.
Step 2: Name the key
Press Create key. Under Name, say what the key is for, such as "Daily data protection digest", so you know what breaks if you revoke it.
Step 3: Choose its organizations
Leave All organizations off and pick the organizations under Organizations. One organization
is simplest: requests then don't need a workspaceId.
Switching All organizations on covers every organization you belong to now. Every request must then say which one it's for.
Step 4: Choose when it expires
Under Expiry, pick 7 days, 30 days, 90 days, 1 year or Never. 90 days is the default. Press Create.
Step 5: Save the key
Bilby shows the key once, under Save your API key. Press Copy key, store it somewhere safe, and press Done. You can't see it again. If you lose it, re-roll it.
Re-roll or revoke a key
| Action | What happens |
|---|---|
| Re-roll | The key gets a new secret, shown once. The old secret stops working at once. Its name, scope and expiry stay. Expired keys can't be re-rolled |
| Revoke | The key stops working at once, for good |
Re-roll when a secret may have leaked but the job still needs a key. Revoke when the job is gone.
Note
Treat a key like your password. Anyone who has it can ask Bilby as you, read your chats in its organizations and spend your allowance. Keep it out of code you commit, and out of shared notebooks.
Tip
Docs, beside Create key, opens the full reference of every endpoint.
Try it in Bilby
Open Settings › API keys and press Create key.
You'll need to be signed in. It opens in a new tab, so this guide stays here.