Your API key
Where your API key lives, what it represents, and how to keep it safe.
Your API key lives in Settings at chat.bereach.ai. Copy it when you first see it and store it somewhere safe, because afterwards it is displayed masked.
| Detail | What to expect |
|---|---|
| Where it lives | Settings at chat.bereach.ai |
| How it is displayed | Masked, showing only the last few characters |
| How it authenticates | As a bearer token |
| What it acts as | Your workspace |
Keep it safe
The key carries your workspace's permissions. Anything you can do in the app, it can do, including work that runs through your connected account. Treat it like a password.
- Keep it server side. It does not belong in client-side code or anything that ships to a browser.
- Keep it out of version control. Read it from an environment variable instead.
- Rotate it if it leaks. Generate a new key in Settings and replace the old one.
One key, one workspace
Whoever holds the key holds your workspace. If a teammate needs the same contacts and chats, invite them to the workspace instead of sharing your key.
Calling BeReach from somewhere else
The connector is the supported path. Add it from the connector page and it handles authentication over OAuth, so no key changes hands.