API Keys

Anything that talks to the API outside the browser uses an API key. User keys authenticate as a user, and station keys authenticate the bench. Both are bearer tokens passed in the Authorization header. Any member can create keys for their own account.

User keys

User keys inherit the role and access group scope of their owner, so a Developer's key writes runs while a Viewer's key reads only. You control what a key can do by adjusting the owning user's role.

Create a user key

The key is shown once. After you close the dialog, it cannot be retrieved again.

Use a user key

Send the key as a bearer token:

curl https://tofupilot.app/api/v2/runs \
  -H "Authorization: Bearer $TOFUPILOT_API_KEY"

Every SDK reads TOFUPILOT_API_KEY from the environment, so you do not need to pass the key in code.

from tofupilot.v2 import TofuPilot

client = TofuPilot()  # reads TOFUPILOT_API_KEY

Revoke a user key

Revocation is immediate, and requests with the revoked key return 401 Unauthorized.

Station keys

A station key acts only on the station it was issued for. It writes runs for the station's procedures, reads its own configuration, and reports health. It cannot read other stations' data, invite members, or change roles.

Create a station key

Station keys are issued when you register a station, so you do not create them by hand. The install command embeds a one-hour setup token, and the CLI exchanges it for a long-lived station key on first boot. For the full registration flow, see stations.

Rotate a station key

The old key is revoked. The CLI detects the revocation on its next request and re-runs setup with a new token.

Permissions

Keys inherit the permissions of their owner, so you do not configure permissions on the key itself.

• A user key carries the user's role, access group assignments, and 2FA-enforcement status.
• A station key is scoped to the station's procedures and read-only access to its configuration.

Assign the right role and access group, and keys are scoped automatically.

Audit and rotation

Every key carries created_at, last_used_at, and expires_at. Sort by last_used_at to find stale keys, or by expires_at for keys nearing expiration.