Skip to content

Web APIยดs#

This section describes the web APIs provided by the oeplatform: HTTP interfaces that take a JSON request body and answer with a JSON one.

There is one API, api/v0, and it covers two kinds of thing: the OEDB โ€” the data tables users upload and the datasets that group them โ€” and the OEKG, the knowledge graph of scenario bundles.

One page describes every endpoint of it. The API Reference is generated from the code and checked against it by the test suite, so it is the page to trust about what exists, what a call takes and what it can answer.

The guides beside it do the other job โ€” what the endpoints are for, which one to reach for, and the handful of things that catch people out. They link into the reference rather than repeating it: