An API key lets a tool act as your workspace without a browser sign-in: the
CLI, a local MCP server (unstuck mcp, unstuck.mcpb), scripts, Postman.
Assistants that connect to the remote MCP server sign in with your account
instead and need no key.
Create
In the app: Settings → API keys → Create key. Name it after where it will
live ("laptop CLI", "Claude Desktop", "n8n prod"), pick an expiry (default 3
months, maximum 1 year), create. The key is shown once — copy it now. Keys
start with unstk_. Creating keys requires an admin role in the workspace.
Put it where the tool reads it
| Tool | Where the key goes |
|---|---|
unstuck CLI |
unstuck auth login (prompt) — or UNSTUCK_API_KEY in the environment for scripts/CI |
unstuck.mcpb (Claude Desktop) |
The API key field when installing; later: Settings → Extensions → Unstuck Engine → Configure |
npx @unstuckengine/cli mcp in a client config |
"env": { "UNSTUCK_API_KEY": "unstk_…" } |
| Remote MCP with a key (Claude Code, Cursor, Gemini CLI headers) | Authorization: Bearer unstk_… header |
| REST / Postman | Authorization: Bearer unstk_… |
Never paste a key into a chat message, a shared document, or a command-line
flag (shell history). The CLI deliberately has no --key flag.
Rotate
Settings → API keys → ⋯ → Rotate replaces the secret and keeps the name, scopes and expiry. The old value stops working immediately; update every place from the table above with the new value. Rotation only works on an active key — an expired or revoked key cannot be rotated; create a new one instead.
Expiry and revocation
Every key expires (you chose the date). A tool using an expired key gets
api_key_expired; the fix is a new key, not a rotation. Revoke (⋯ →
Revoke) when a key leaks or a tool is decommissioned: instant, permanent, and
the log keeps the key's history. Deactivating a team member revokes their keys; so does
removing a member, a member leaving, or a demotion below admin (in that workspace).
Check what a key can do
unstuck auth status # CLI: which key is in effect, where it came from, who you are
curl -H "Authorization: Bearer unstk_…" https://<api-url>/functions/v1/whoami
whoami returns the workspace and the key's name, prefix, scopes and expiry —
read-only, no credits. Every key today carries the * scope (every operation
the workspace may perform); per-key scopes are a later data change, not a new
API.
Where the key does NOT reach
Key lifecycle itself (create / rotate / revoke), billing and checkout, and credential-bearing destination connections are sign-in-only actions in the app. A leaked key can never mint or protect keys.