• SongkeeperSongkeeper

Search Documentation

Search for articles and glossary terms

Articles
  • Getting Started
  • Artists
  • Contacts
  • Contract Vault
  • Files
  • Glossary
  • Ideas
  • Keyboard Shortcuts
  • Media Library
  • Playlists
  • Projects
  • Recording Versions
  • Releases
  • Settings
    • Account
    • Developer Access
    • Notifications
    • Security
    • Storage
  • Songs
  1. Docs
  3. settings
  5. developer

API Keys and Developer Access

Create and revoke Songkeeper API keys for CLI workflows, REST API access, and custom integrations.

Developer settings manage API keys. Use an API key when a local tool, script, CLI workflow, or integration needs authenticated access to the Songkeeper API.

Keys are shown once
Songkeeper only shows the full API key at creation time. Copy it before closing the dialog. If you lose it, revoke the old key and create a new one.

Create an API Key

  1. Click Create Key and give the key a descriptive name.
  2. Copy the generated key from the creation dialog.
  3. Store it securely outside Songkeeper.
  4. Send it as a bearer token when calling the API.

Use an API Key

API keys authenticate requests with an Authorization: Bearer <key> header. The REST API is mounted under /api/v1, with API documentation at /api/docs and OpenAPI JSON at /api/openapi.json.

Managing Keys

ActionWhat happens
CreateGenerates a new key and shows the full value once.
ListShows active keys by name, creation date, and last-used date when available.
RevokeMarks the key as revoked so it can no longer authenticate requests.

The full key value is not shown again in the list. Treat the visible key name and timestamps as inventory metadata, not as recoverable secrets.

Related Docs

  • Use contracts with the CLI contract commands when automating contract-vault workflows.
  • Review release publishing before exposing release metadata through integrations.
  • Review security settings when deciding who should create and store API keys.