Skip to main content
Builder endpoints require API Key authentication. Public endpoints can be accessed without authentication but are rate limited by IP.

​
Getting an API Key

1

Login to Bloom Protocol

Go to bloomprotocol.ai and connect your wallet
2

Navigate to API Keys

Go to Builder > API Keys
3

Create a new key

Click + New Key and give it a name (e.g., “Production Key”)
4

Copy your key

Copy your API key immediately! You won’t be able to see it again.

​
Using Your API Key

Include your API key in the x-api-key header:
The header name is lowercase: x-api-key (not X-API-Key)

​
API Key Format

API keys follow this format:
  • Prefix: bp_live_
  • Length: 44 characters total

​
Key Management

​
Limits

  • Maximum 3 active keys per builder (configurable)
  • Revoked keys don’t count toward the limit

​
Revoking Keys

If your key is compromised:
  1. Go to API Keys page
  2. Click Revoke on the compromised key
  3. Create a new key
Revoked keys are soft-deleted and automatically cleaned up after 30 days.

​
Error Responses

​
Example Error Response

​
Security Best Practices

Store API keys in environment variables, never in code
Use different keys for development and production
Rotate keys periodically
Revoke unused or compromised keys immediately