FalconryScale
Developers

API keys

Creating, viewing and revoking keys from Settings → Developer.

An API key is the simplest way to connect a script or an AI assistant to your FalconryScale data. It's tied to your account, and it does exactly what you tell it to when you create it, nothing more.

Creating a key

Open Settings → Developer and tap Create key:

  • Name. Something that reminds you what's using it, for example "Claude Desktop" or "Weigh-in sync script".
  • Access. Read can view raptors, weights and activity. Read and write can also log weights, feedings and activity on your behalf. Pick the narrower one unless you actually need the tool to write data.
  • Expires. In 30 days, 90 days, 1 year, or never.

FalconryScale shows the new key's secret once, right after you create it, with a copy button.

Copy it now

You won't be able to see this secret again. If you lose it, revoke the key and create a new one.

Your keys list

Settings → Developer lists every key you've created: its name, access level, when it was created, when it was last used, and when it expires. A key you haven't used yet shows as Never used; one with no expiry shows Never.

A revoked or expired key stays in the list, greyed out, so you can see it existed, but it no longer works.

Revoking a key

Tap Revoke next to a key you no longer want active. This takes effect immediately, any tool still using it loses access right away, and it can't be undone. Revoke a key as soon as you stop using it, or the moment you suspect it leaked.

The 10-key limit

You can have up to 10 active keys at once. Revoked and expired keys don't count against this limit. If you're at the cap, revoke one you no longer need before creating another.

Keeping a key safe

  • Treat it like a password. Anyone with the key can act as you, up to whatever access you gave it.
  • Prefer read-only for anything that only needs to look at your data. Only grant read and write to a tool you trust to log things correctly on your behalf.
  • Give each tool its own key rather than sharing one key across several scripts or assistants, so you can revoke one without breaking the others.
  • Rotate keys you've had for a while, especially ones with write access: create a new one, switch the tool over, then revoke the old one.
  • Revoke immediately if a key is ever exposed, committed to a repository, pasted somewhere public, or a tool using it stops being one you trust.

See OAuth for connecting an AI assistant without handing it a raw key at all.

On this page