Skip to main content
GET
GET classifications results
Results are only served gzip-compressed. Requests must include an Accept-Encoding: gzip header (e.g., curl --compressed); otherwise the API returns 406 Not Acceptable. Most HTTP clients, including the One Codex Python library, send this header by default.
Return the results of a classification as JSON. The returned JSON has the following top-level structure: The table object has the results for all taxa in the sample and the following fields:
Note on future changes: We do likely plan to add additional top-level fields to the returned JSON, e.g., whether the analysis contains abundance estimates or other similar metrics and descriptive features. We do not anticipate removing any top-level fields or fields in the table of results provided.

Authorizations

X-API-Key
string
header
required

Path Parameters

id
string
required

Response

200 - application/json

OK

host_tax_ids
string[]
required
n_reads
integer
required
Required range: x >= 1
table
_TaxonomicResults · object[]
required