API Tokens.

  • API tokens allow programmatic access to the Jelu REST API without exposing your password
  • This is useful for automation scripts, third-party integrations, CI/CD pipelines and tools like jelu-importer
  • Tokens use the standard Authorization: Bearer header and work alongside existing session-based authentication
  • Each token has fine-grained scopes so you can limit what it can access

Creating a token

  • Navigate to the settings menu (accessible from the left sidebar) and click API Tokens
  • Click the + Create Token button
  • Enter a name for your token (eg: “Backup Script”, “Importer”)
  • Select the scopes you need (see table below)
  • Optionally set an expiration date, or leave it as “Never expires”

Danger

  • The full token is shown only once after creation. Copy it immediately and store it securely.
  • If you lose the token you will need to create a new one.

Available scopes

ScopeDescription
books:readView books, authors, tags, series, publishers
books:writeCreate, modify and delete books and metadata
reading:readView reading events and statistics
reading:writeCreate, modify and delete reading events
reviews:readView reviews
reviews:writeCreate, modify and delete reviews
lists:readView custom lists, shelves and quotes
lists:writeCreate, modify and delete lists, shelves and quotes
import:writeImport and export data
metadata:readFetch external metadata from providers

Tip

  • Only grant the scopes your integration actually needs. For example a backup script might only need the :read scopes.

Using a token

Once you have a token, pass it in the Authorization header :

curl -H "Authorization: Bearer jelu_a1b2c3d4..." http://localhost:11111/api/v1/books
  • This works with any endpoint available through the REST API

Managing tokens

  • On the API Tokens page you can see all your tokens with their name, scopes, creation date, last used date and usage count
  • Click the delete button to immediately revoke a token
  • Admins can view and revoke tokens for all users
Jelu, site template from spacebook