Authentication

All API requests require authentication using an API key. This guide covers how to generate, use, and manage your API keys.

Generating API Keys

1. Go to Settings → "API Keys" in your dashboard.
2. Click "Generate New Key".
3. Give the key a name (e.g., "Production", "Development").
4. Copy the key immediately — it won't be shown again.

Using Your API Key

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

Authorization: Bearer YOUR_API_KEY

Example with cURL:

curl -X GET https://api.bhomy.ai/v1/agents \
  -H "Authorization: Bearer bhy_abc123def456" \
  -H "Content-Type: application/json"

Example with JavaScript:

const response = await fetch('https://api.bhomy.ai/v1/agents', {
  headers: {
    'Authorization': 'Bearer bhy_abc123def456',
    'Content-Type': 'application/json'
  }
});
const agents = await response.json();

Example with Python:

import requests

headers = {
    'Authorization': 'Bearer bhy_abc123def456',
    'Content-Type': 'application/json'
}

response = requests.get('https://api.bhomy.ai/v1/agents', headers=headers)
agents = response.json()

Rate Limits

Rate limit information is included in response headers: X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset.

Key Management

You can have multiple API keys for different environments. Rotate keys regularly by generating a new one and revoking the old one. Revoked keys stop working immediately.