Read-only developer reference

Quickstart

Make the first successful request in under 30 minutes. No manual approval is required.

  1. In Data access → API keys, create a viewer key with the default 90-day expiry.
  2. Copy the secret from the one-time reveal panel.
  3. Run:
curl --fail-with-body \
  -H "X-API-Key: <YOUR_API_KEY>" \
  "https://app.gen318.com/api/v1/data/catalog"

A successful response is HTTP 200 and includes catalog_version plus the canonical metric catalogue. The placeholder is literal: replace <YOUR_API_KEY> with the g318_… value shown once in the console.

Sentinel checks

GET /catalog is the deterministic success input; it needs no site data and always contains battery.soc_pct. To test your error path deterministically, call /timeseries with metric_name=gen318.sentinel.invalid; an authenticated request returns HTTP 400 with a remedy pointing back to the catalogue.