Skip to content

API

Note

This page contains the draft API specification and documentation for web access to the echoSMs anatomical data store. It is a work in progress.

The anatomical data store API is implemented as a RESTful web API with calls to:

  1. Query dataset metadata
  2. Obtain specimen information and model definitions and parameters.
  3. Access the full dataset associated with a model (this includes the raw data, processing scripts, intermediate data, etc).

API endpoints to modify the data store have not yet been created as the data store can be manually loaded given the relatively low rate of expected model uploading.

A testing server has been setup with some sample data at https://echosms-data-store-app-ogogm.ondigitalocean.app.

Live API documentation is available from the test server and a cached version stored on github is included at the end of this page.

Some example API calls are:

  • A list of all dataset ids in the testing server
  • A dataset
  • Shape data from a specimen in a dataset, and an image of that specimen
  • The API call to provide the raw dataset is there, but currently doesn't return any raw data

An example Python program that uses the API is available here.