Describe the dataset
The dataset's name, build and as-of date, basin, well count and extent; its forecast models per stream, with their features and ip_days; the request limits; and which streams have EUR and P10/P90 bands.
Describe the dataset
/datasetThe dataset's name, build and as-of date, basin, well count and extent; its forecast models per stream, with their features and ip_days; the request limits; and which streams have EUR and P10/P90 bands.
Options
include adds the oil or gas stream with the larger share of first-12-month BOE, or the count of wells without a location, which GET /wells leaves out.
Parameters
Query parameters
includestringOptionalprimary_streamadds the stream, oil or gas, with the larger share of the dataset's first-12-month BOE, andunlocated_well_countthe number of wells inwell_countwithout a location (no longitude), which GET /wells and the map leave out; send either or both, comma-separated or repeated, each once, and any other value is a 400 with details.field include."primary_stream""unlocated_well_count""primary_stream,unlocated_well_count""unlocated_well_count,primary_stream"model_setstringOptionalpattern ^[a-z0-9][a-z0-9-]{0,62}$
The model set to answer from, an
idfrom GET /model-sets. Absent: the set GET /model-sets names asdefault, the base dataset unless the server answers from a published set.model_set=defaultreaches the base dataset; once the server retires it, a 400 naming the set answering instead.- An unknown id, or a set scoped to other tenants, is a 400 listing the ids the caller may use in
details.allowed(published sets only oncedefaultis retired); a set that can't load, a 503 with the reason. - Plans and exports stay in their set: a call naming them (by path,
plan,ids,source.plan, a scenario'splan.id, or a comparison'sa.planandb.plan, also undersource.comparison) reaches it withoutmodel_set. - An explicit
model_setwins; naming resources of two sets in one request is a 400.
Responses
200 OK
The dataset.
namestring or nullRequiredDataset name.
buildstring or nullRequiredDataset build.
sample_databooleanRequiredTrue when the data is synthetic.
basinstring or nullRequiredBasin, as Midland.
regionstring or nullRequiredRegion, as Permian.
well_countintegerRequiredWells in the dataset.
formation_countintegerRequiredFormations with wells or grids.
as_ofstring or nullRequiredFormat
dateLatest production date.
first_productionstring or nullRequiredFormat
dateEarliest first production.
bboxarray of numbersRequired4 items
Extent of the wells: west, south, east, north.
modelsarray of objectsRequiredForecast model per stream.
ShowHide 5 child fields in each item
streamstringRequiredStream.
"oil""gas""water"model_numstringRequiredModel number.
targetstringRequiredTarget column.
featuresarray of stringsRequiredModel input features.
ip_daysarray of integersRequiredip_days the model predicts.
ip_daysarray of integersRequiredip_days forecasts are reported at.
Show all 20 fields
spacingobjectRequiredSpacing config.
ShowHide 1 child field
search_radius_ftnumberRequiredRadius the spacing step searches for neighbors, ft.
subsurfaceobject or nullRequiredSubsurface config.
ShowHide 4 child fields
methodstring or nullRequiredInterpolation method.
gridsintegerRequiredGrids.
distance_from_gridsnumberRequiredA point the set reads (its
subsurface_samplingin GET /model-sets) farther than this from a grid is left out of that grid's value.distance_from_grids_unitsstringRequiredUnits of distance_from_grids.
limitsobjectRequiredRequest limits.
ShowHide 3 child fields
forecast_wellsintegerRequiredMost wells per POST /forecasts.
plan_wellsintegerRequiredMost forecasts (wells × designs) per POST /plans: the most wells with one design.
plan_unfinished_forecastsintegerRequiredMost forecasts (wells × designs) one caller may have in queued or running plans once one is unfinished; POST /plans answers 429 past it.
eurobjectRequiredEUR on this server.
ShowHide 6 child fields
availablebooleanRequiredWhether this server fits EUR (the forecast worker can run Novi's decline fit); eur: true answers 503 when false.
methodstring or nullRequiredNovi's type-curve decline fit; null when unavailable.
defaultsobjectRequiredDecline fit settings used. oil and gas, when present, are the settings each stream was fit with; without them, both were fit with these. water, when present, is the echo of eur_water.
ShowHide 8 child fields
eur_yearsintegerRequired≥ 10, ≤ 50
Years to EUR: the extension runs to the last 30-day step within eur_years × 365 days.
terminal_declinenumberRequired≥ 0.01, ≤ 0.2
Terminal decline, a fraction per year: the hyperbolic switches to exponential at this rate.
b_minnumberRequired≥ 0, ≤ 2.5
Lowest hyperbolic b the fit may use; below b_max.
b_maxnumberRequired≥ 0, ≤ 2.5
Highest hyperbolic b the fit may use; above b_min.
oilobjectOptionalWith per-stream settings, the settings oil was fit with.
ShowHide 3 child fields
terminal_declinenumberRequired≥ 0.01, ≤ 0.2
Terminal decline, a fraction per year: the hyperbolic switches to exponential at this rate.
b_minnumberRequired≥ 0, ≤ 2.5
Lowest hyperbolic b the fit may use; below b_max.
b_maxnumberRequired≥ 0, ≤ 2.5
Highest hyperbolic b the fit may use; above b_min.
gasobjectOptionalWith per-stream settings, the settings gas was fit with.
Same fields as StreamDecline.
waterobjectOptionalOnly with eur_water: true: the settings water was fit with. Its presence is the echo of the flag.
Same fields as StreamDecline.
per_wellbooleanOptionalOnly when a well has its own settings: these are the request's or plan's, not every well's;
inputs.resolved.declinegives each well's.true
boundsobjectRequiredAllowed ranges, inclusive; b_min must also be below b_max.
ShowHide 4 child fields
eur_yearsobjectRequiredeur_years range.
ShowHide 2 child fields
minnumberRequiredLowest allowed.
maxnumberRequiredHighest allowed.
terminal_declineobjectRequiredterminal_decline range.
ShowHide 2 child fields
minnumberRequiredLowest allowed.
maxnumberRequiredHighest allowed.
b_minobjectRequiredb_min range.
ShowHide 2 child fields
minnumberRequiredLowest allowed.
maxnumberRequiredHighest allowed.
b_maxobjectRequiredb_max range.
ShowHide 2 child fields
minnumberRequiredLowest allowed.
maxnumberRequiredHighest allowed.
streamsarray of stringsRequiredStreams that get an EUR.
"oil""gas"versionsobject or nullRequiredLibrary versions the forecast worker fits with, by package name; null on the sample stack.
bandsobjectRequiredP10/P90 bands on this server.
ShowHide 5 child fields
availablebooleanRequiredWhether any stream has bands here (its model has a stored bands fit); bands: true answers 503 when false.
methodstring or nullRequiredNovi's predrill bands (split conformal, safe variant); null when unavailable.
percentiles[integer, integer]RequiredBands' percentiles: p10 is the low curve and p90 the high one (Novi's convention).
streamsarray of stringsRequiredStreams whose model has bands, among those the set serves; the others answer each forecast with a bands error.
"oil""gas""water"reasonstring or nullRequiredWhy bands are unavailable, or which streams have none and why; null when every stream has them.
depletion_chainobjectRequiredThe depletion chain on this server.
ShowHide 3 child fields
availablebooleanRequiredWhether a served model reads neighbors' production, so the depletion chain changes forecasts. When true, POST /plans chains a dated plan unless it sends depletion_chain: false; when false, every plan runs without it, also one sent with depletion_chain: true.
featuresarray of stringsRequiredThe models' features that read neighbors' production: the spacing features novi_spacing_sum_prior_* and novi_spacing_delgados_p*.
neighbor_productionstringRequiredWhere existing (PDP) parents' production comes from, for every forecast and plan on this set:
historyis their production to the dataset's as_of, held flat after;extendedcontinues it with Novi's production forecast for each existing well past its history."history""extended"
primary_streamstring or nullOptionalWith include=primary_stream: oil or gas, whichever has the larger share of this model set's first-12-month BOE, summed over every well with a 12-month oil or gas volume, a missing stream counting as 0; null when the dataset has none at all; ties oil. Oil bbl is compared with gas mcf / 6 (GET /conventions boe); water is never primary.
"oil""gas"unlocated_well_countintegerOptional≥ 0
With include=unlocated_well_count: how many of
well_countwells have no location (no longitude). GET /wells lists only wells with a location, so it leaves these out, and no map or spatial filter places them. 0 when every well has one.
304 Unchanged since the ETag in If-None-Match.Errors
Shared errors400401403500503What they mean