DocsHome AssistantOpen the appDE

spooly.eu/docs/authentication

Keys and sign-in

A program of your own signs in with a key. Claude, ChatGPT, Claude Code and Home Assistant sign in with a click, so you never copy a key.

Open as text
On this page

Create a key

  1. Open Spooly in the browser: Settings, Devices & keys, “Create key”. In the apps you see your connections. You create new ones in the browser.
  2. Give it a name so you recognize it in the list, and pick the type.
  3. Turn on “May also change” if your program should write.
  4. Copy the key. It starts with spk_, and Spooly shows it only once. The list afterwards shows only the first eight characters.
TypeUsed for
Home AssistantFor the integration, if you do not sign in there with a click
AI assistantFor AIs that cannot sign in themselves
SpreadsheetOnly for the spreadsheet link. It can only read and does not work for the rest of the API.
Klipper printerOnly for the Spoolman address of a Klipper printer. It reads spools and reports usage and does not work for the rest of the API. Klipper
OtherFor your own program

Sending the key

Every request carries the key in its header. Only this header opens the API. A session from the app does not count here, and a key does not open any page of the app.

Header
Authorization: Bearer spk_dein_schluessel
Base URL
https://spooly.eu/api/v1

Reading and changing

Without “May also change” a key can only read. Every request that changes something then answers 403 insufficient_scope. You set the permission when you create the key. If you need it later, create a new key and revoke the old one.

Signing in with a click

Well-known apps sign in through OAuth. You land on a Spooly page, see what the app may read, and use the “Also allow changes” switch to decide whether it may also write. Other AI assistants can sign in the same way. Spooly calls them “AI assistant” there and shows the address the sign-in returns to.

App“Also allow changes”
ClaudePreselected
ChatGPTPreselected
Home AssistantPreselected
Claude CodeOff, because on your computer another program can pose as Claude Code
Other AI assistantsOff. Allow it only if you started the sign-in yourself just now.

A program of your own uses a key.

Revoking and expiry

  • You can revoke any connection under Settings, Devices & keys. It takes effect immediately and cannot be undone.
  • If you change or reset your password, Spooly revokes all connections and keys of your account.
  • When Pro expires, the API answers 403 pro_expired. The key stays and works again as soon as Pro is active.
  • New keys: at most 30 per hour per account. The total number you can have is not limited.