API Overview

The Beacon API allows you to integrate AI visibility data into your applications.

Base URL

All API requests should be made to:

https://api.hellobeacon.ai/v1

Authentication

All requests require an API key passed in the Authorization header:

Authorization: Bearer YOUR_API_KEY

See [Authentication](/docs/api/auth) for details on obtaining and managing API keys.

Rate Limits

Response Format

All responses are JSON formatted:

{
  "success": true,
  "data": { ... },
  "meta": {
    "request_id": "req_123",
    "timestamp": "2024-01-15T10:30:00Z"
  }
}

Error Handling

Errors follow a consistent format:

{
  "success": false,
  "error": {
    "code": "RATE_LIMIT_EXCEEDED",
    "message": "You have exceeded your rate limit",
    "details": { ... }
  }
}

Common Error Codes

SDKs

Official SDKs are available for:

• JavaScript/TypeScript (npm)
• Python (pip)
• Coming soon: Ruby, PHP, Go