Skip to content
Changelog

API keys

Use an API key for agents that run on a server or can’t open a browser, like OpenClaw, Hermes and scripts. A key acts as you and can never see more than you can.

  1. In Nysa, open Settings → Keys and choose Create API key.
  2. Fill in the dialog:
    • Name: name it after the agent, like “OpenClaw”.
    • Permission: Read only (default) or Read and write.
    • Scopes: All scopes (default) or Only some scopes.
    • Projects: All projects (default) or Only some projects.
    • Expires after: 30 days, 90 days (default) or 1 year.
  3. Choose Create key. Nysa shows the key once: copy it now.
  4. Store it as the environment variable NYSA_API_KEY on the machine where your agent runs.

Keys start with nysa_. Your agent sends it as a header:

Authorization: Bearer nysa_...
  • Read only is enough for searching, briefings and reading meetings. Write tools answer “This API key is read-only.”
  • Read and write lets the agent save notes, correct facts, save skills and import a brain.
  • Only some scopes or projects limits what the agent sees. You can only pick scopes and projects you can see yourself. Knowledge shared with the whole workspace is always included.

Some tools need the key to include your Personal scope (or all scopes):

Feature Needs
Search and briefings Any key
Your notes, calendar and agent memory Personal
Saving notes, correcting or removing facts Read and write + Personal
Changing meetings on your calendar Read and write + Personal
Importing a brain Read and write + Personal
Searching original emails (search_sources) All scopes
Saving skills Read and write

When a key can’t use a tool, your agent gets a message like “Brain import is not available for this API key.”

  • You can change a key’s name, permission and scopes later. Changes apply on the key’s next use.
  • Revoke key stops it immediately: anything using it stops working. Expired keys show Delete key instead.
  • Each member can have up to 25 active keys per workspace.
  • You only see and manage your own keys, admins included.
  • A key stops working when it expires, when it’s revoked, or when its owner leaves the workspace.

Owners, admins and members can create keys. Viewers can’t. If Keys is missing from Settings, API keys aren’t turned on for your workspace: use OAuth or email hello@usenysa.com.