Authentication

All API endpoints require authentication via an API key.

API key header

Include your API key in the X-API-Key header with every request:

X-API-Key: YOUR_API_KEY

Example

curl -H "X-API-Key: YOUR_API_KEY" \
  "https://api.example.com/v1/perils"

import httpx

headers = {"X-API-Key": "YOUR_API_KEY"}
response = httpx.get(
    "https://api.example.com/v1/perils",
    headers=headers,
)

Permissions

Each API key has specific peril permissions. Use the /v1/perils endpoint to check which perils are available for your key.

API key lifecycle

Production API keys automatically expire one year after creation. If a key is compromised, revoke it internally and contact admin@birdseyeview.ai so we can revoke it on our services as well. To request a new key, please contact admin@birdseyeview.ai.