Skip to content
Developers
Get an API token

Versioning

Novi's API version policy, and how Novi UDM Data, the Forecasts API, the EVA API and the MCP servers version today.

View MarkdownOpen in Claude(opens in a new tab)

Novi supports up to three API versions at a time.

Novi's API version lifecycleNovi supports up to three API versions at a time. Future: a beta that customers may use early. Primary: the actively maintained, fully supported version, with ongoing updates and enhancements; attributes may change but are not removed. Deprecated: the previous version once a newer one is published. It is available for one year and still gets updated data, with no enhancements and no guaranteed bug fixes.Up to three versions at a timeFutureBetaCustomers may use itearly.PrimaryActively maintainedFully supported, withongoing updates andenhancements. Attributesmay change but are notremoved.DeprecatedThe previous versionOnce a newer one ispublished. Still getsupdated data. Noenhancements; bug fixesare not guaranteed.Available for one yearNovi's API version lifecycleNovi supports up to three API versions at a time. Future: a beta that customers may use early. Primary: the actively maintained, fully supported version, with ongoing updates and enhancements; attributes may change but are not removed. Deprecated: the previous version once a newer one is published. It is available for one year and still gets updated data, with no enhancements and no guaranteed bug fixes.Up to three versions at a timeFutureBetaCustomers may use it early.PrimaryActively maintainedFully supported, with ongoing updates andenhancements. Attributes may change but arenot removed.DeprecatedThe previous versionOnce a newer one is published. Still getsupdated data. No enhancements; bug fixes arenot guaranteed.Available for one year
Status Meaning
Primary The actively maintained, fully supported version, including the API and the bulk export. It gets ongoing updates and enhancements. Existing attributes may change through bug fixes, improved logic or deprecation, but are not removed
Deprecated The previous version once a newer one is published. Available for one year and still receives updated data. Bug fixes are not guaranteed and no enhancements are made
Future A beta version that customers may use early

Today only Novi’s well data has more than one API version, v3 and v4: see Releases and versioning.

Product Versions How changes ship How to see your version
Novi UDM Data (v4) v4, in Snowflake. v3, the REST API at /api/v3 and its bulk export Novi release numbers, such as 26.4.3. Columns change through fixes, improved logic or deprecation. A deprecated column stays in its view and says what to use instead The data dictionary and Releases and versioning
Novi Forecasts API /api/v1 Semver API version. Changes are additive and opt-in; some releases tighten validation. A breaking change would be a new major version under a new path; none is planned GET /health: version and app_version
Novi EVA API /v1 Not published yet Not published yet
MCP servers Preview One version per server Hosted tools update for you. The Forecasts Desktop extension says when a newer version is out EVA data results carry schema_version
  • /api/v1 only grows: additions are opt-in. Fixes that tighten validation can turn a loosely accepted request into an invalid-input error.
  • The API version is semver: a minor step when the OpenAPI document changes, at least a patch step for any other contract change. One API version can span several platform releases.
  • A breaking change would be a new major version under a new path; none is planned.
  • Your host serves the OpenAPI 3.1 document it runs at GET /openapi.json.
Item Status
Deprecation and Sunset response headers on deprecated versions and endpoints Planned