Skip to content

Document personal API keys - #10

Merged
KodeStar merged 2 commits into
mainfrom
feat/api-keys
Jul 9, 2026
Merged

Document personal API keys#10
KodeStar merged 2 commits into
mainfrom
feat/api-keys

Conversation

@KodeStar

@KodeStar KodeStar commented Jul 9, 2026

Copy link
Copy Markdown
Owner

What

Docs for the new user-minted API keys feature (server KodeStar/audiosilo-server#35, frontend KodeStar/audiosilo-frontend#55).

  • User Guide: new listening/api-keys.md - what a key is, creating one in Settings, the shown-once secret, a curl Bearer example, last-used, revoking, demo-account restriction, and the "a key inherits your permissions - mint from an appropriately-scoped account" advice. Added to sidebars-users.ts plus a pointer from the account page.
  • Developer Docs: the three /auth/tokens endpoints in the API reference (shapes, status codes, owner-scoping), api_keys in every capability-flag enumeration, the api token kind in auth-and-security (session-or-api bearer resolution, pairing still excluded), and the cross-repo contract / frontend overview pages.

All claims verified against the implementation source. No new screenshots (text-only pages).

npm run build green (link/anchor checks pass).

Merge order

Merging to main deploys GitHub Pages - land this after the server and frontend PRs so the docs never describe an unreleased surface.

- User Guide: listening/api-keys.md (creating a key, the shown-once
  secret, using it as a Bearer token, last-used, revoking, and that a
  key inherits the account's permissions) + sidebar entry + a pointer
  from the account page
- Developer Docs: /auth/tokens endpoints in the API reference, the
  api_keys capability flag, token kinds in auth-and-security, and the
  cross-repo contract/frontend overview pages
The server bars an API-key caller (403, denyAPIKey) from the four
credential-minting routes (POST /auth/{tokens,recovery,pair,password}),
so a leaked key can't spawn a fresh durable credential. The docs claimed
a key works anywhere a session token does; document the carve-out in the
API reference, conventions, and trust-model pages, and soften the user
guide's can-do-anything wording. Also propagate the new tokens.kind='api'
value to data-model.md and overview.md, which still listed only session
and pairing kinds.
@KodeStar
KodeStar merged commit 3604622 into main Jul 9, 2026
1 check passed
@KodeStar
KodeStar deleted the feat/api-keys branch July 9, 2026 15:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant