Check service health
Whether the database, subsurface grids and model workers (spacing, calc, forecast) are ready, and the default model set when one is configured.
Check service health
/healthWhether the database, subsurface grids and model workers (spacing, calc, forecast) are ready, and the default model set when one is configured. status is degraded while anything is loading or down; forecasts need every worker ready.
Versions
app_version is this build and web the web UI release it serves. clients names the Claude Desktop extension (mcpb), Claude skill zip (skill) and hosted MCP endpoint (mcp, where offered) it serves, so a client can tell its user when theirs is out of date.
Legacy Forecasts
fe, on a server that reads them, counts those its background index has yet to read or failed to read, service-wide.
Responses
200 OK
Service health.
statusstringRequiredok when everything is ready, degraded otherwise.
"ok""degraded"versionstringRequiredAPI version.
sample_databooleanRequiredTrue when the API serves synthetic sample data.
datasetstring or nullRequiredDataset name.
uptime_sintegerRequiredSeconds since the server started.
hostobjectRequiredThe machine the server runs on.
ShowHide 2 child fields
cpusintegerRequiredCPUs the server can use.
cpu_modelstring or nullRequiredCPU model name, as the host reports it.
checksobjectRequiredComponent status.
ShowHide 5 child fields
databasestringRequiredWell database.
"ok"subsurfacestringRequiredPacked subsurface grids.
"ready""loading""unavailable"spacing_and_featuresstringRequiredSpacing and spacing feature tables for existing wells.
"ok""missing"workersobjectRequiredModel workers.
ShowHide 3 child fields
spacingstringRequiredThe spacing model worker.
"ready""loading""down"calcstringRequiredThe calc model worker.
"ready""loading""down"forecaststringRequiredThe forecast model worker.
"ready""loading""down"
default_model_setobjectOptionalOnly when the server answers requests without model_set from a published set: that set's load state. While it's loading or unavailable, status is degraded and requests without model_set wait or answer 503.
ShowHide 3 child fields
idstringRequiredThe configured default set id.
statusstringRequiredThe set's load state.
"ready""loading""idle""unavailable"errorstring or nullRequiredWhy the set is unavailable; null otherwise.
webobjectRequiredThe web UI release this server serves from its release channel:
shasays which UI build its users get. It is as of the last channel read that succeeded (checked_at); a read that fails leaves it as it was and setserror.ShowHide 7 child fields
statusstringRequiredWhether the server serves its web channel's newest release.
ok: it does.held: the newest needs a newer API than this server's (newest.requires_api), so the server serves an older release, or its image's UI whenshais null.unavailable: the channel has no release this API serves (none yet, or the served one was withdrawn), or the newest failed to load; the server serves an older release, or its image's UI whenshais null.disabled: no web channel; the server serves its image's UI.
"ok""held""unavailable""disabled"shastring or nullRequiredpattern ^[0-9a-f]{40}$
Commit of the web UI release served (40 lowercase hex); null while the server serves the UI built into its image.
versionstring or nullRequiredVersion of the web UI release served, as 1.0; null when
shais.requires_apistring or nullRequiredOldest API version (MAJOR.MINOR.PATCH) the release served needs; null when
shais.checked_atstring or nullRequiredFormat
date-timeWhen the server last read its web channel (ISO 8601, UTC); null before the first read, and when
disabled. A stale time means polling is failing: seeerror.errorstring or nullRequiredWhy the last poll failed: the channel could not be read, the newest release this API serves did not load, or the assets of another release on the channel could not be checked (tabs still open on it may miss files). Null when the last poll succeeded, and when
disabled. The server keeps serving whatshanames either way.newestobjectOptionalThe channel's newest release, sent only when it isn't the one served.
ShowHide 3 child fields
shastringRequiredpattern ^[0-9a-f]{40}$
Its commit (40 lowercase hex).
versionstringRequiredIts web UI version.
requires_apistringRequiredOldest API version it needs; above this server's
versionwhen status isheld.
storageobjectOptionalOnly with a configured state store.
ShowHide 2 child fields
kindstringRequiredAdapter kind.
"s3""fs""memory"tenantstringRequiredInstance default tenant.
app_versionstringOptionalThis build's version (VERSION, MAJOR.NN), as 0.36, as GET /changelog reports it. Absent, with clients, when the server can't read its VERSION.
clientsobjectOptionalWhat each client of this API should run. Absent, with app_version, when the server can't read its VERSION.
ShowHide 3 child fields
mcpbobjectRequiredThe Claude Desktop extension (.mcpb).
ShowHide 4 child fields
versionstringRequiredThe extension this build serves, as its manifest version (semver, as 0.36.0). An extension older than this is out of date: tell the user to update from
setup.min_supportedstringRequiredThe oldest extension still supported (semver). Older ones may fail to load some tools: tell the user to update before going on.
downloadstringRequiredPath of this build's extension file on this origin, under the server's base path, when it has one.
setupstringRequiredPath on this origin of the API page, whose "Use it in Claude" section explains setup and links the download.
skillobjectRequiredThe Claude skill.
ShowHide 2 child fields
versionstringRequiredThe build the skill zip comes from (VERSION, MAJOR.NN), as
app_version: label the download with it.downloadstringRequiredPath of this build's skill zip on this origin, under the server's base path, when it has one. For Claude Code: unzip it into ~/.claude/skills/, so SKILL.md sits at ~/.claude/skills/novi-forecasts/SKILL.md.
mcpobjectOptionalThe hosted MCP endpoint's path on this origin, only where this server offers one. MCP clients reach it through the edge with a Novi API token as
Authorization: Bearer.ShowHide 1 child field
pathstringRequiredPath of the MCP endpoint on this origin, under the server's base path, when it has one; it answers JSON-RPC sent by POST.
feobjectOptionalOnly on a server that reads Legacy Forecasts: the background index across the service, counts only, as of its last complete scan; each field is null until this server has read the counts of a finished scan. It never changes
status.ShowHide 3 child fields
pendinginteger or nullRequiredLegacy Forecasts not yet read.
failedinteger or nullRequiredLegacy Forecasts whose last read failed.
scanned_atstring or nullRequiredFormat
date-timeWhen the last complete scan ended (ISO 8601, UTC).
Errors
Shared errors500What they mean