API Overview
This page is its own backend. All API calls are handled by the same index.php
via the ?api= query parameter.
Responses are JSON with Access-Control-Allow-Origin: * so the dashboard
(or any other client) can fetch them cross-origin.
Endpoints
GET
https://platform.hexaf.io/suvi-ai/?api=health
Health check. Returns {"status":"ok"} when the PHP backend is reachable.
The dashboard's 🔍 Ping button calls this endpoint.
GET
https://platform.hexaf.io/suvi-ai/?api=features
Fetch GOES-18 SUVI L2 Thematic Map feature metrics for a given date.
The PHP backend downloads FITS files from NOAA, parses the binary pixel arrays,
and returns per-class area fractions.
datestringYYYY-MM-DD (UTC). Required.
cadenceintMinutes between files. Default 4 (native). Min 4, max 60.
limitintMax files to fetch. Default 24. Max 360. For testing use 6.
filestringSpecific FITS filename from the NOAA browser. Returns 1 record.
Example response
{
"source": "goes18",
"date": "2026-08-20",
"cadence_min": 4,
"storm_class": "moderate",
"phase": "main",
"n_records": 24,
"errors": [],
"records": [
{
"t": "2026-08-20T00:00:00+00:00",
"file": "dn_suvi-l2-thmap_g18_s20260820T000000Z_e20260820T000400Z_v1-0-3.fits",
"qflag": 0,
"br": 0.2341, // bright_region class 3
"ch": 0.0876, // coronal_hole class 6
"fl": 0.0012, // flare class 9
"qs": 0.6541, // quiet_sun class 7
"fm": 0.0231, // filament class 4
"pr": 0.0112, // prominence class 5
"lm": 0.0112, // limb class 8
"fc1": 0.2341, // 1h Codex forecast (persistence placeholder)
"fc3": 0.2341, // 3h forecast
"fc6": 0.2341 // 6h forecast
}
]
}
Caching
Parsed FITS records are cached to disk for 10 minutes (/tmp/suvi_cache).
This means a second request for the same file is instant — only the first fetch hits NOAA.
Plugging in your Codex model
In process_file() near the bottom of the PHP section, replace the three
placeholder lines with your model's inference:
// Replace these three lines:
'fc1' => $fracs['br'],
'fc3' => $fracs['br'],
'fc6' => $fracs['br'],
// With your Codex model output:
'fc1' => codex_predict($fracs, lead_h: 1),
'fc3' => codex_predict($fracs, lead_h: 3),
'fc6' => codex_predict($fracs, lead_h: 6),
FITS class IDs
SUVI L2 Thematic Map pixel values and their solar features:
0 → unlabeled 3 → bright_region (br) 6 → coronal_hole (ch)
1 → outer_space 4 → filament (fm) 7 → quiet_sun (qs)
5 → prominence (pr) 8 → limb (lm)
9 → flare (fl)