Create an API key
An API key lets an agent, script or integration use Scribblespace as you, in one workspace. It can never do more than you can do in the app right now.
- Open Settings (Ctrl,), or choose Settings and backups from the account menu at the bottom of the sidebar.
- Go to the Workspace tab and scroll to API keys.
- Enter a Key name you’ll recognize later, such as “Claude” or “Nightly export”.
- Choose the Workspace the key can reach.
- Under Access, choose Read only or Read and write.
- Under Expires after, choose 7, 30, 90 or 365 days. 90 is the default.
- Select Create API key. In the Copy your new key notice, select Copy key, store the key somewhere safe, then select Done.
Read only or read and write?
| Access | What the key can do |
|---|---|
| Read only | List notebooks, search, read scribbles as Markdown, download their images and follow their links. The right choice for assistants. |
| Read and write | Everything above, plus create and edit scribbles and move them to Trash. |
Only owners, admins and editors can create a read-and-write key. If you’re changed to a viewer later, the key loses write access at once, and if you leave the workspace or are removed from it, the key stops working.
Good to know
- A key reaches only the notebooks you can open in its workspace. Private scribbles stay private.
- Keys start with
ss_. The list shows each key’s name, workspace, first few characters, expiry date and access. - You can have up to 32 keys at a time.
- Owners and admins can see keys being created and revoked on the team’s Activity page.
- While a workspace is read-only, for example after its trial ends, keys can still read but not write.