Authentication
Send your secret key as a bearer token on every request:
Authorization: Bearer brd_sk_live_...Scopes
Section titled “Scopes”Each key is scoped along two axes:
- Access — read, or read-write.
- Reach — a whole workspace, or a single project.
A request that exceeds the key’s scope is rejected with 403 permission_error (insufficient_scope). A project-scoped key only ever sees its own project.
Who a key acts as
Section titled “Who a key acts as”A key acts as the workspace member who created it: everything it writes is attributed to that person, and it can do what that person can do.
If that member is removed from the workspace, the key stops working and returns 403 permission_error with the code key_owner_inactive. It is not transferred to anyone else — a key never gains access its creator did not have. Add the member back and the same key works again; otherwise have another member issue a new key.
Key safety
Section titled “Key safety”Errors
Section titled “Errors”| HTTP | type | code | Meaning |
|---|---|---|---|
| 401 | authentication_error |
unauthorized, expired |
Missing, invalid, revoked or expired key. |
| 403 | permission_error |
insufficient_scope |
The key lacks the required access, or the resource is outside its scope. |
| 403 | permission_error |
key_owner_inactive |
The member who created the key is no longer in the workspace. |
See Errors for the full catalog.