Skip to main content

DeCIFR REST server and API

DeCIFR provides a REST server that can retrieve tree and placement information from MEP files and expose them via HTTP.

REST server​

  • Purpose: share placement-derived information programmatically via the web.
  • Implementation: Python (Flask) running in a Python 3 environment.
  • Source: released on GitHub under a BSD 3-Clause license (see your DeCIFR REST repo).

REST API service​

The REST API can be used via:

  • a browser
  • programmatically (HTTP requests)
  • the command line (e.g., curl)
tip

Treat the REST API as the stable “integration surface” for external tools (dashboards, portals, pipelines).

Docker users: basic navigation pattern​

When the REST service is running:

/list​

  • returns a list of run IDs for the MEP/XML files in the configured folder

REST /list example

Drill-down into a run​

Click a run ID to explore components without opening the full tree:

  • leaves: list of sample names present in the tree
  • queries: query sequences and placement information
  • otus: OTU groupings and their metadata/placement summaries

Example view:

REST drill-down example