Skip to content
Developers
Get an API token

Download an inventory template

Download one CSV header line, in GET /inventories/columns catalog order, to fill with one well per row and upload with POST /inventories/read.

Download an inventory template

GET/inventories/template

Download one CSV header line, in GET /inventories/columns catalog order, to fill with one well per row and upload with POST /inventories/read. Stage Length, Clusters per Stage and Frac Rate appear only where the model set's models read them.

Send a Novi API token as a bearer token on every request. Authentication
Units

units=imperial (the default) writes ft, bbl/ft, lb/ft and bbl/min headers, as inventory-template.csv; units=metric writes m, m3/m, t/m and m3/min headers, as inventory-template-metric.csv. Any other or repeated value is a 400 on units. POST /inventories/read says how it reads headers and units.

Filling it

Delete both Top Hole columns when no well has a surface hole: a row with blank Top Hole cells reads with an issue, taking the heel as shl. The read needs eur_water: true, til_from_dates and designs_from_rows: true for the water decline columns, the drill and completion dates and the completion names.

Parameters

Query parameters

  • unitsstringOptional

    Default "imperial"

    The header units: units=imperial or units=metric; send once.

    "imperial""metric"
  • model_setstringOptional

    pattern ^[a-z0-9][a-z0-9-]{0,62}$

    The model set to answer from, an id from GET /model-sets. Absent: the set GET /model-sets names as default, the base dataset unless the server answers from a published set.

    • model_set=default reaches 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 once default is 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's plan.id, or a comparison's a.plan and b.plan, also under source.comparison) reaches it without model_set.
    • An explicit model_set wins; naming resources of two sets in one request is a 400.

Responses

200 OK

One CSV header line.

Returns text/csv.

Errors

Shared errors400401403500503What they mean