Create an API key

API keys authenticate every request. Each key is scoped to either an organization or a single workspace, and carries a role (agent < manager < admin).

Create a key

Create keys from the Beep dashboard under Settings → API keys (organization or workspace admins only). When you create a key:

• Choose a scope — an organization key can act on any workspace in the organization (and must send an X-Workspace-Id header on each request); a workspace key is pinned to one workspace.
• Choose a role — manager or admin to send messages and manage resources; agent for read-only access.

The plaintext key is shown once at creation — copy and store it securely. You won't be able to view it again.

Key format

Keys are prefixed beep_live_ (production) or beep_test_. Use a beep_test_ key while integrating: test-keyed sends are processed in test mode and are not delivered to real recipients.

Next steps

• Authentication & workspace scoping