API keys (for automation programs)

For admins

Available to organizations on Starter or higher.

When you need an API key

You need an API key when a program that can't sign in as a person uses ARC. For example:

  • A script that posts work records to Synapse after each development task
  • A nightly job that organizes orders into a sheet

People don't need keys. When someone connects Claude, ChatGPT or Claude Code to ARC, they sign in to ARC to do it. See Connect ARC to Claude, ChatGPT and Claude Code. Whether that's allowed is set in API controls.

Issue a key

In Admin console › Security › API keys, enter a name, choose an owner and click Issue key. The key value appears right after you issue it. Copy it and store it safely. After closing the window you can still bring it back with View in the list.

The program sends the key in a request header: x-synapse-key for the Synapse ingest API, and Authorization: Bearer for ARC MCP (Synapse ingest API).

Columns in the list

ColumnMeaning
KeyThe first part of the key value.
NameThe name you gave it and its scope (View · log or View · create · edit).
OwnerWhose permissions the key acts with. It only reaches what the owner can see. If the owner's access shrinks, so does the key's.
Ingest locationWhich shared drive and folder Synapse work records posted with this key go to. If not set, the workspace default (Synapse ingest location in Admin console › Integrations) is used.
StatusActive or stopped.
Last usedThe last day the key was used.

What a key can do

  • By default: view everything its owner can see, and add work records to Synapse.
  • If you check Allow create and edit when issuing: tools to create and edit documents, sheets, events and tasks are added.

Even if a key allows it, API controls cap it from above. For example, if the owner's organizational unit is view-only, a key that allows create and edit still only views. Hard-to-undo actions such as moving to trash or deleting events aren't possible with any key.

Revoke a key

Click Revoke in the list and the program using that key loses access immediately. To let the program work again, issue a new key.

Use keys safely

  • Treat the key value like a password. Don't post it in chat, email or a code repository.
  • Use one key per program and name it for its purpose (for example "orders-nightly"). Then you can revoke just that key if something goes wrong.
  • Revoke keys whose Last used is months ago or empty.
  • If the owner leaves, revoke the key and reissue it under a new owner.

Issuing, viewing and revoking keys are recorded in the admin log. Users can see keys issued in their name in My Account › Security and sign-in › Connected apps and services.

Frequently asked questions

Does an employee need an API key to use Claude?
No. They connect by signing in to ARC. API keys are for programs such as scripts and automated jobs.
What if a key is lost?
Click View in the list to see the key value again. Keys issued the old way can not be viewed, so issue a new one.
Was this helpful?

Need more help?

ARC AI can find the answer in Help. If that doesn’t solve it, contact us.

Contact us

Related help