Skip to main content
Use an API key for server-side requests made on behalf of your account. Use OAuth when people connect their Rainbrand accounts to your product.

API keys

Generate a key in account settings and store it as RAINBRAND_API_KEY in your environment or secret manager. Keep it on the server and rotate it if exposed. Keys start with bloom_sk_.
You can also send the same key as a Bearer token:
If both headers are present, x-api-key takes precedence.

OAuth

Send a Rainbrand OAuth access token as Authorization: Bearer, stored here as RAINBRAND_ACCESS_TOKEN:
Tokens grant access to the connected user’s resources under the same ownership and plan checks as API keys. The scopes describe identity and refresh access: The authorization-server metadata publishes the current endpoints and supported scopes.

Register a public client

Use Authorization Code with PKCE S256. Public clients register without a client secret:
Replace the callback with your product’s URL. Register and send the exact same redirect_uri during authorization; wildcards are not supported.