Skip to content

Authentication

Every request is authenticated with an API key in the X-API-Key header.

curl -H "X-API-Key: YOUR_API_KEY" \
  "https://prod-external-weather-api.birdseyeviewtechnologies.com/v1/perils"

import httpx
headers = {"X-API-Key": "YOUR_API_KEY"}
r = httpx.get("https://prod-external-weather-api.birdseyeviewtechnologies.com/v1/perils", headers=headers)

Key scoping

Keys are scoped to endpoints and perils. Call GET /v1/perils at any time to see exactly which perils your key can access, separated by endpoint type. A 403 means the endpoint is outside your key's licence; a 401 means the key itself is missing or invalid.

Key lifecycle

Event What happens
Issue Request a key from admin@birdseyeview.ai.
Expiry Production keys expire automatically after one year.
Compromise If a key may have been exposed, report it to admin@birdseyeview.ai immediately and we will revoke and re-issue.

Keep keys server-side

Keep your API key confidential. Do not embed it in client-side code, mobile apps or public repositories. Route browser traffic through your own backend.