Authentication

All BrightShot API endpoints require authentication using an API key.

Getting an API Key

1. Log in to your BrightShot dashboard
2. Navigate to API Keys in the sidebar
3. Click Create New API Key
4. Give your key a name (e.g., "Production", "Development")
5. Copy the key immediately - you won't be able to see it again!

Using Your API Key

Include your API key in the Authorization header of every request:

Authorization: Bearer bs_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

Example Request

curl -X GET https://api.bright-shot.com/api/v1/me \
  -H "Authorization: Bearer bs_live_your_api_key_here"

Example Response

{
  "user_id": "550e8400-e29b-41d4-a716-446655440000",
  "email": "user@example.com",
  "subscription": "pro",
  "credits_remaining": 150
}

API Key Security

Best practices:

• Store API keys in environment variables
• Use different keys for development and production
• Rotate keys periodically
• Revoke keys that may have been compromised

Rate Limits & Credits

• Each image generation consumes 1 credit from your subscription
• Check your remaining credits with GET /api/v1/me
• Credits reset monthly based on your subscription plan