Skip to content

API reference

The OpenDeco API is not intended for real-time decompression control, dive planning or other safety-critical operation.

Read operations

  • registry.sources.list
  • registry.sources.get
  • registry.datasets.list
  • registry.datasets.get
  • registry.models.list
  • registry.models.get

Fields on every list result

  • rows
  • total_count
  • generated_at
  • data_origin

Verification levels

Each model record carries a verification level. The API returns the stored value and does not compute it from the model.

LevelNameMeaningExternal evidenceIndependent review
V0UnverifiedRuns, but output has not been independently checked.NoNo
V1Sanity checkedBasic known profiles and invariants pass.NoNo
V2Cross-checkedOutputs match an authoritative implementation, published examples or verified device or software outputs over a defined test suite.YesNo
V3Independently reviewedThe implementation and its verification evidence have been reviewed by someone who did not build the model.YesYes

Error codes

Serialisation

  • cycle
  • depth_exceeded
  • duplicate_key
  • duplicate_set_element
  • lone_surrogate
  • non_finite_number
  • null_value
  • unsupported_type

Run manifests

  • recorded_identity_absent
  • recorded_identity_mismatch
  • short_id_length_out_of_range
  • unlabelled_array
  • unsupported_run_id

Validation

  • charset
  • empty
  • forbidden_character
  • length_out_of_range
  • non_finite
  • not_normalised
  • out_of_range
  • unsupported_conversion_input

Release resolution

resolved
The identifier names a published release.
malformed
The identifier fails its format check before any lookup starts.
unknown
No release carries this identifier. An identifier that was allocated but never published also resolves to unknown.
refused
Working or frozen material sits behind the address.