The HeyeBeam API

Authentication

Every request carries your org key. Keys are shown once at creation and revocable any time from /account.

Authorization: Bearer hb_live_…

Try it — right here, no terminal

Paste a key, type a SKU, run it. Exactly the request your ERP or spreadsheet would make; your key stays in this form and is sent only to the API.

GET /api/v1/cross

Resolve a SKU to its cross-references. sku is required; add manufacturer to narrow an ambiguous SKU (ambiguous lookups return the candidate list).

curl "https://heyebeam.com/api/v1/cross?sku=24CZ2" \
  -H "Authorization: Bearer hb_live_YOUR_KEY"

{
  "product": { "id": "…", "manufacturer": "Metalux", "sku": "24CZ2", "description": "…" },
  "equivalents": [
    {
      "manufacturer": "Lithonia", "sku": "CPX", "description": "…",
      "confidence": "exact", "source": "rep-verified", "verified": true,
      "reasons": ["manufacturer_stated", "…"]
    }
  ]
}
// verified: true = a human or the manufacturer stands behind the edge.
// verified: false = machine candidate — facets matched, nobody checked.

GET /api/v1/products

Full detail for one product — specs, spec-sheet link, equivalents — by the id values returned from /cross.

curl "https://heyebeam.com/api/v1/products?id=<productId>" \
  -H "Authorization: Bearer hb_live_YOUR_KEY"

Errors & limits

• 401 invalid_key — missing, malformed, or revoked key.
• 402 subscription_required — the org’s trial or subscription lapsed.
• 404 not_found — no product for that SKU or id.
• 429 rate_limited — 120 requests/minute per key.