Skip to content
Developers
Get an API token

Exports

Write a done plan's tables to a zip as CSV and Parquet, or as ARIES, ComboCurve and Val Nav import files.

View MarkdownOpen in Claude(opens in a new tab)

Exports run as queued jobs. To read curves straight into code, see Forecasts and curves.

GET /export-formats?plan=<id> lists every table, column, option and preset, and which the plan can take, with the reason when it can’t.

Preset What the zip holds
engineer (default) Monthly volumes to EUR, EUR per well, wells and designs
monthly Monthly volumes to EUR, EUR per well and wells
plan_tables Wells, designs, neighbors, model inputs, subsurface values and cumulative volumes by day
arps Arps segments per well, design and stream, with EUR per well
eur EUR per well and design
drivers Each model input’s contribution to each forecast (SHAP values)
economics NPV, capex, IRR and payback per well, pad and plan
aries One ARIES import file: 12 monthly volumes per well and design, then declines. No Parquet
combocurve Well header and forecast parameters CSVs, plus eur_check.csv
valnav A decline CSV by well, reserves category and product, in imperial units, plus eur_check.csv

Send preset or tables (with each table’s options), not both. wells, designs and streams narrow every table.

Terminal window
curl -sS --fail-with-body -X POST \
-H "Authorization: Bearer $NOVI_API_TOKEN" \
-H "Content-Type: application/json" \
-d "{\"source\": {\"plan\": \"$PLAN_ID\"}, \"preset\": \"combocurve\", \"identity\": {\"well_id\": \"uid\"}}" \
"$NOVI_API_BASE/exports"
# The answer has the export's id.
EXPORT_ID="<the id from the response>"
# Wait for it: each call returns when the status changes, or after 25 s.
curl -sS --fail-with-body \
-H "Authorization: Bearer $NOVI_API_TOKEN" \
"$NOVI_API_BASE/exports/$EXPORT_ID?wait=25"
# Download, resuming a partial file with -C -. -L follows a redirect to the signed copy.
curl -sS --fail-with-body -L -C - -o export.zip \
-H "Authorization: Bearer $NOVI_API_TOKEN" \
"$NOVI_API_BASE/exports/$EXPORT_ID/file"
  • POST /exports returns the export and its Location at once. The same request for the same plan returns the existing export, with reused: true.
  • status: queued, running, then done, error or cancelled; expired once the file is removed. progress gives the step, share done, rows and bytes.
  • When done, file has name, bytes, sha256, url (a path on your host) and expires_at.
  • Downloads resume with Range and If-Range. One may redirect to a signed copy that works for 15 minutes: follow it without your token, as curl 7.58 and later and Python requests do.
  • Files are kept for limits.ttl_hours (Limits); then run the export again.
  • DELETE /exports/{id} cancels a queued or running export, or removes a finished one.
  • One CSV per table. By default, fixed-schema tables also come as Parquet under parquet/, with Snowflake and Databricks load scripts. GET /export-formats says which; parquet: false leaves it out.
  • manifest.json (the request and settings) and README.txt (every table and column).
  • On a plan made with bands, p_levels: ["P50", "P10", "P90"] adds Low (P10) and High (P90) rows after each Mid (P50) row. Otherwise the export is Mid only.
The Export dialog with the ComboCurve preset selected: a well header CSV and a forecast parameters CSV, and an Export ComboCurve button.The Export dialog with the ComboCurve preset selected: a well header CSV and a forecast parameters CSV, and an Export ComboCurve button.
The zip also holds eur_check.csv, manifest.json and README.txt.
  • ComboCurve: eur_check.csv gives each curve’s EUR as ComboCurve will sum it, beside Novi’s. ComboCurve names P-series by exceedance, so Low (P10) is written as series P90 and High (P90) as P10.
  • Val Nav: reserves_categories sets the reserves category each P-level writes.
  • ARIES: don’t send parquet: true.
  • identity sets each well’s Well ID and start date. identity.well_id: "uid" writes the well_uid that GET /plans/{id}/curves gives, so plans with the same well names don’t collide.
  • These files carry no scenario: a plan with two or more needs scenario to pick one.
  • source.wells forecasts and exports wells you send in one job, up to limits.max_source_wells forecasts (500 by default).
  • source.comparison exports a comparison of two plans, or of a plan and a booked forecast source.
  • A Legacy Forecast1 exports like a plan, without neighbors, model inputs, subsurface, SHAP, economics, the presets that need them, or ARIES. GET /export-formats?plan=<id> gives each reason.
Limit Default Past it
Exports queued or running, per model set 20 Start more once one finishes
Exports queued or running, per plan 3 Start more once one finishes
How long a file is kept (limits.ttl_hours) 24 hours, less when export storage (limits.max_bytes) fills; the oldest go first Run the export again
Request body 10 MB Send less

GET /export-formats limits reports your host’s values. Error codes: Errors and limits.

Notices to your own https receiver when an export or plan finishes are not available yet: GET /export-formats callbacks.enabled is false and callback_url is not accepted. Use wait=25.

  1. Legacy Forecasts are dynamic imports from Forecast Engine v1. ↩