Annotators query external databases (e.g. UniProt, ChEBI, HGNC, Ensembl, KEGG, GO, PDB, BRENDA, Entrez, TAIR) to attach identifiers and cross-references to map elements.
Each annotator declares which element types it can handle, which existing identifiers it can use as input, and which annotations it can provide in return.
The endpoints are served from /new_api/annotators/, /new_api/annotator_targets/ and
/new_api/annotator_presets/.
1. List annotator types
Returns every annotator available on this instance, with its identifier and name, a description of what it does, the homepage of the database it queries, and the identifiers it can read together with the annotations it can provide in return. The element types an annotator can handle are reported as SBO terms; a base type is reported as the SBO terms of every concrete type below it, so an annotator working on proteins reports the terms of all protein types.
1.1. HTTP request
GET /minerva/new_api/annotators/ HTTP/1.1
1.2. CURL sample
$ curl 'https://minerva-dev.lcsb.uni.lu/minerva/new_api/annotators/' -X GET
1.3. HTTP response
HTTP/1.1 200 OK
1.4. Response Fields
| Path | Type | Description |
|---|---|---|
|
|
annotator identifier, one of: BRENDA, CAZY, CHEBI, COPY_CELL_DESIGNER_ANNOTATIONS, ENSEMBL, ENTREZ, GO, HGNC, KEGG, PDB, TAIR, UNIPROT |
|
|
human readable name of the annotator |
|
|
short description |
|
|
homepage of the database from which data is being taken |
|
|
SBO terms of the element types that can be annotated using this annotator |
|
|
list of input fields/miriam_types that can be used as source information |
|
|
field that can be used as source information |
|
|
annotation that can used as source information |
|
|
what kind of annotations can be provided by this annotator |
|
|
field that can be filled |
|
|
annotation type that can be provided |
|
|
configuration options for this annotator |
|
|
configuration type |
|
|
configuration value |
1.5. Sample Response
[ {
"type" : "BRENDA",
"name" : "BRENDA",
"description" : "",
"url" : "http://www.brenda-enzymes.org",
"validSboTerms" : [ "SBO:0000243", "SBO:0000244", "SBO:0000252", "SBO:0000278", "SBO:0000284", "SBO:0000421" ],
"availableSourceInformation" : [ {
"field" : null,
"miriamType" : "TAIR_LOCUS"
}, {
"field" : null,
"miriamType" : "UNIPROT"
} ],
"availableAnnotationsToProvide" : [ {
"field" : null,
"miriamType" : "BRENDA"
} ],
"availableOptions" : [ ]
}, {
"type" : "CAZY",
"name" : "CAZy",
"description" : "",
"url" : "http://commonchemistry.org",
"validSboTerms" : [ "SBO:0000243", "SBO:0000244", "SBO:0000252", "SBO:0000278", "SBO:0000284", "SBO:0000421" ],
"availableSourceInformation" : [ {
"field" : null,
"miriamType" : "TAIR_LOCUS"
}, {
"field" : null,
"miriamType" : "UNIPROT"
} ],
"availableAnnotationsToProvide" : [ {
"field" : null,
"miriamType" : "CAZY"
} ],
"availableOptions" : [ ]
}, {
"type" : "CHEBI",
"name" : "ChEBI",
"description" : "",
"url" : "http://www.ebi.ac.uk/chebi/",
"validSboTerms" : [ "SBO:0000247", "SBO:0000327" ],
"availableSourceInformation" : [ {
"field" : null,
"miriamType" : "CHEBI"
}, {
"field" : "NAME",
"miriamType" : null
} ],
"availableAnnotationsToProvide" : [ {
"field" : "FULL_NAME",
"miriamType" : null
}, {
"field" : null,
"miriamType" : "INCHI"
}, {
"field" : null,
"miriamType" : "INCHIKEY"
}, {
"field" : null,
"miriamType" : "STITCH"
}, {
"field" : "SMILES",
"miriamType" : null
}, {
"field" : "SYNONYMS",
"miriamType" : null
} ],
"availableOptions" : [ ]
}, {
"type" : "COPY_CELL_DESIGNER_ANNOTATIONS",
"name" : "Annotate CellDesigner complex contents",
"description" : "This annotator copies annotations of diagram elements to their analogues inside complexes, as they have no direct annotations in CellDesigner data model. Recommended for any CellDesigner diagrams and should be added as the first annotator.",
"url" : "https://minerva.pages.uni.lu/doc/",
"validSboTerms" : [ "SBO:0000243", "SBO:0000244", "SBO:0000247", "SBO:0000252", "SBO:0000253", "SBO:0000278", "SBO:0000284", "SBO:0000285", "SBO:0000290", "SBO:0000291", "SBO:0000298", "SBO:0000327", "SBO:0000334", "SBO:0000358", "SBO:0000421" ],
"availableSourceInformation" : [ {
"field" : "NAME",
"miriamType" : null
} ],
"availableAnnotationsToProvide" : [ ],
"availableOptions" : [ ]
}, {
"type" : "ENSEMBL",
"name" : "Ensembl",
"description" : "",
"url" : "https://www.ensembl.org/",
"validSboTerms" : [ "SBO:0000243", "SBO:0000244", "SBO:0000252", "SBO:0000278", "SBO:0000284", "SBO:0000421" ],
"availableSourceInformation" : [ {
"field" : null,
"miriamType" : "ENSEMBL"
} ],
"availableAnnotationsToProvide" : [ {
"field" : null,
"miriamType" : "ENTREZ"
}, {
"field" : null,
"miriamType" : "HGNC"
}, {
"field" : null,
"miriamType" : "HGNC_SYMBOL"
}, {
"field" : "FULL_NAME",
"miriamType" : null
}, {
"field" : "SYMBOL",
"miriamType" : null
}, {
"field" : "SYNONYMS",
"miriamType" : null
} ],
"availableOptions" : [ ]
}, {
"type" : "ENTREZ",
"name" : "Entrez Gene",
"description" : "",
"url" : "http://www.ncbi.nlm.nih.gov/gene",
"validSboTerms" : [ "SBO:0000243", "SBO:0000244", "SBO:0000252", "SBO:0000278", "SBO:0000284", "SBO:0000421" ],
"availableSourceInformation" : [ {
"field" : null,
"miriamType" : "ENTREZ"
} ],
"availableAnnotationsToProvide" : [ {
"field" : null,
"miriamType" : "ENSEMBL"
}, {
"field" : null,
"miriamType" : "HGNC"
}, {
"field" : "FULL_NAME",
"miriamType" : null
}, {
"field" : "DESCRIPTION",
"miriamType" : null
}, {
"field" : "SYMBOL",
"miriamType" : null
}, {
"field" : "SYNONYMS",
"miriamType" : null
} ],
"availableOptions" : [ ]
}, {
"type" : "GO",
"name" : "Gene Ontology",
"description" : "",
"url" : "http://amigo.geneontology.org/amigo",
"validSboTerms" : [ "SBO:0000253", "SBO:0000290", "SBO:0000358" ],
"availableSourceInformation" : [ {
"field" : null,
"miriamType" : "GO"
} ],
"availableAnnotationsToProvide" : [ {
"field" : "FULL_NAME",
"miriamType" : null
}, {
"field" : "DESCRIPTION",
"miriamType" : null
} ],
"availableOptions" : [ ]
}, {
"type" : "HGNC",
"name" : "HGNC",
"description" : "",
"url" : "http://www.genenames.org",
"validSboTerms" : [ "SBO:0000243", "SBO:0000244", "SBO:0000252", "SBO:0000278", "SBO:0000284", "SBO:0000421" ],
"availableSourceInformation" : [ {
"field" : null,
"miriamType" : "HGNC_SYMBOL"
}, {
"field" : null,
"miriamType" : "HGNC"
}, {
"field" : "NAME",
"miriamType" : "HGNC_SYMBOL"
} ],
"availableAnnotationsToProvide" : [ {
"field" : null,
"miriamType" : "ENSEMBL"
}, {
"field" : null,
"miriamType" : "ENTREZ"
}, {
"field" : null,
"miriamType" : "HGNC"
}, {
"field" : null,
"miriamType" : "HGNC_SYMBOL"
}, {
"field" : null,
"miriamType" : "REFSEQ"
}, {
"field" : null,
"miriamType" : "UNIPROT"
}, {
"field" : "SYMBOL",
"miriamType" : null
}, {
"field" : "PREVIOUS_SYMBOLS",
"miriamType" : null
}, {
"field" : "SYNONYMS",
"miriamType" : null
}, {
"field" : "NAME",
"miriamType" : null
}, {
"field" : "FULL_NAME",
"miriamType" : null
} ],
"availableOptions" : [ ]
}, {
"type" : "KEGG",
"name" : "KEGG",
"description" : "Annotations extracted from KEGG ENZYME Database based on species EC numbers. Annotation include relevant publications and homologous genes for given EC numbers.",
"url" : "https://www.genome.jp/kegg/",
"validSboTerms" : [ "SBO:0000243", "SBO:0000244", "SBO:0000252", "SBO:0000278", "SBO:0000284", "SBO:0000421" ],
"availableSourceInformation" : [ {
"field" : null,
"miriamType" : "TAIR_LOCUS"
}, {
"field" : null,
"miriamType" : "UNIPROT"
}, {
"field" : null,
"miriamType" : "EC"
} ],
"availableAnnotationsToProvide" : [ {
"field" : null,
"miriamType" : "PUBMED"
}, {
"field" : null,
"miriamType" : "TAIR_LOCUS"
} ],
"availableOptions" : [ {
"type" : "KEGG_ORGANISM_IDENTIFIER",
"value" : ""
} ]
}, {
"type" : "PDB",
"name" : "Protein Data Bank",
"description" : "",
"url" : "http://www.pdbe.org/",
"validSboTerms" : [ "SBO:0000243", "SBO:0000244", "SBO:0000252", "SBO:0000278", "SBO:0000284", "SBO:0000421" ],
"availableSourceInformation" : [ {
"field" : null,
"miriamType" : "UNIPROT"
} ],
"availableAnnotationsToProvide" : [ {
"field" : null,
"miriamType" : "PDB"
} ],
"availableOptions" : [ ]
}, {
"type" : "TAIR",
"name" : "TAIR",
"description" : "",
"url" : "http://arabidopsis.org/index.jsp",
"validSboTerms" : [ "SBO:0000243", "SBO:0000244", "SBO:0000252", "SBO:0000278", "SBO:0000284", "SBO:0000421" ],
"availableSourceInformation" : [ {
"field" : null,
"miriamType" : "TAIR_LOCUS"
} ],
"availableAnnotationsToProvide" : [ {
"field" : null,
"miriamType" : "UNIPROT"
} ],
"availableOptions" : [ ]
}, {
"type" : "UNIPROT",
"name" : "UniProt",
"description" : "",
"url" : "http://www.uniprot.org/",
"validSboTerms" : [ "SBO:0000243", "SBO:0000244", "SBO:0000252", "SBO:0000278", "SBO:0000284", "SBO:0000421" ],
"availableSourceInformation" : [ {
"field" : null,
"miriamType" : "UNIPROT"
}, {
"field" : "NAME",
"miriamType" : "UNIPROT"
} ],
"availableAnnotationsToProvide" : [ {
"field" : null,
"miriamType" : "HGNC_SYMBOL"
}, {
"field" : null,
"miriamType" : "UNIPROT"
}, {
"field" : null,
"miriamType" : "EC"
}, {
"field" : null,
"miriamType" : "STRING"
}, {
"field" : null,
"miriamType" : "ENTREZ"
} ],
"availableOptions" : [ ]
} ]
2. List annotator target types
Returns the kinds of map element an annotator can be applied to - CHEMICAL, COMPARTMENT, COMPLEX, GENE, OTHER, PATHWAY, PHENOTYPE, PROTEIN, REACTION and RNA.
These are the values to choose from in the targets of a preset annotator; each annotator separately reports the SBO terms of the element types it actually supports.
2.1. HTTP request
GET /minerva/new_api/annotator_targets/ HTTP/1.1
2.2. CURL sample
$ curl 'https://minerva-dev.lcsb.uni.lu/minerva/new_api/annotator_targets/' -X GET
2.3. HTTP response
HTTP/1.1 200 OK
2.4. Response Fields
| Path | Type | Description |
|---|---|---|
|
|
target identifier, one of: CHEMICAL, COMPARTMENT, COMPLEX, GENE, OTHER, PATHWAY, PHENOTYPE, PROTEIN, REACTION, RNA |
|
|
human readable name |
2.5. Sample Response
[ {
"type" : "CHEMICAL",
"name" : "Chemical"
}, {
"type" : "COMPARTMENT",
"name" : "Compartment"
}, {
"type" : "COMPLEX",
"name" : "Complex"
}, {
"type" : "GENE",
"name" : "Gene"
}, {
"type" : "OTHER",
"name" : "Other"
}, {
"type" : "PATHWAY",
"name" : "Pathway"
}, {
"type" : "PHENOTYPE",
"name" : "Phenotype"
}, {
"type" : "PROTEIN",
"name" : "Protein"
}, {
"type" : "REACTION",
"name" : "Reaction"
}, {
"type" : "RNA",
"name" : "RNA"
} ]
3. Annotator presets
A preset is a named, saved annotation configuration: an ordered list of annotators, each with the element types (targets) it should be applied to, the source identifiers it may read, the annotations it should provide, and any annotator-specific options.
Presets let the same annotation pipeline be reused across projects instead of being configured again for every upload.
Creating, updating and deleting a preset requires the administrator or curator role.
3.1. List annotator presets
Returns a page of the presets defined in this instance, each with its name, last update time and configured annotators.
|
Note
|
The result is paged - use the page and size query parameters to
walk through it.
|
3.1.1. HTTP request
GET /minerva/new_api/annotator_presets/ HTTP/1.1
3.1.2. Query Parameters
| Parameter | Description |
|---|---|
|
index of the page to fetch, counted from 0; 0 by default |
|
number of entries on a page; 20 by default, 10000 at most |
3.1.3. CURL sample
$ curl 'https://minerva-dev.lcsb.uni.lu/minerva/new_api/annotator_presets/' -X GET
3.1.4. HTTP response
HTTP/1.1 200 OK
3.1.5. Response Fields
| Path | Type | Description |
|---|---|---|
|
|
list of presets on the page |
|
|
preset name |
|
|
when preset was last updated |
|
|
preset id |
|
|
order in which annotators are being processed |
|
|
element types to annotate, one of: CHEMICAL, COMPARTMENT, COMPLEX, GENE, OTHER, PATHWAY, PHENOTYPE, PROTEIN, REACTION, RNA |
|
|
annotator identifier, one of: BRENDA, CAZY, CHEBI, COPY_CELL_DESIGNER_ANNOTATIONS, ENSEMBL, ENTREZ, GO, HGNC, KEGG, PDB, TAIR, UNIPROT |
|
|
what should be considered as source information |
|
|
order in which source information should be taken into account |
|
|
field type that is used as source information |
|
|
type of annotation that should be used as source information |
|
|
what annotations should be added |
|
|
field that should be filled by annotator |
|
|
annotation that should added by annotator |
|
|
annotator options |
|
|
type of the configuration option |
|
|
value for the configuration option |
|
|
total number of pages |
|
|
total number of elements |
|
|
number of elements on this page |
|
|
page size |
|
|
page number |
3.1.6. Sample Response
{
"content" : [ {
"id" : 1,
"name" : "DEFAULT",
"updatedAt" : "2026-09-23 23:10:03",
"annotators" : [ {
"order" : 0,
"targets" : [ "COMPLEX" ],
"annotator" : "COPY_CELL_DESIGNER_ANNOTATIONS",
"sourceInformation" : [ {
"order" : 0,
"field" : "NAME",
"miriamType" : null
} ],
"annotationsToProvide" : [ ],
"options" : [ ]
}, {
"order" : 1,
"targets" : [ "COMPLEX" ],
"annotator" : "GO",
"sourceInformation" : [ {
"order" : 0,
"field" : null,
"miriamType" : "GO"
} ],
"annotationsToProvide" : [ {
"field" : "FULL_NAME",
"miriamType" : null
}, {
"field" : "DESCRIPTION",
"miriamType" : null
} ],
"options" : [ ]
}, {
"order" : 0,
"targets" : [ "GENE" ],
"annotator" : "COPY_CELL_DESIGNER_ANNOTATIONS",
"sourceInformation" : [ {
"order" : 0,
"field" : "NAME",
"miriamType" : null
} ],
"annotationsToProvide" : [ ],
"options" : [ ]
}, {
"order" : 1,
"targets" : [ "GENE" ],
"annotator" : "HGNC",
"sourceInformation" : [ {
"order" : 0,
"field" : null,
"miriamType" : "HGNC_SYMBOL"
}, {
"order" : 1,
"field" : null,
"miriamType" : "HGNC"
}, {
"order" : 2,
"field" : "NAME",
"miriamType" : "HGNC_SYMBOL"
} ],
"annotationsToProvide" : [ {
"field" : null,
"miriamType" : "ENSEMBL"
}, {
"field" : null,
"miriamType" : "ENTREZ"
}, {
"field" : null,
"miriamType" : "HGNC"
}, {
"field" : null,
"miriamType" : "HGNC_SYMBOL"
}, {
"field" : null,
"miriamType" : "REFSEQ"
}, {
"field" : null,
"miriamType" : "UNIPROT"
}, {
"field" : "SYMBOL",
"miriamType" : null
}, {
"field" : "PREVIOUS_SYMBOLS",
"miriamType" : null
}, {
"field" : "SYNONYMS",
"miriamType" : null
}, {
"field" : "NAME",
"miriamType" : null
}, {
"field" : "FULL_NAME",
"miriamType" : null
} ],
"options" : [ ]
}, {
"order" : 0,
"targets" : [ "PROTEIN" ],
"annotator" : "COPY_CELL_DESIGNER_ANNOTATIONS",
"sourceInformation" : [ {
"order" : 0,
"field" : "NAME",
"miriamType" : null
} ],
"annotationsToProvide" : [ ],
"options" : [ ]
}, {
"order" : 1,
"targets" : [ "PROTEIN" ],
"annotator" : "HGNC",
"sourceInformation" : [ {
"order" : 0,
"field" : null,
"miriamType" : "HGNC_SYMBOL"
}, {
"order" : 1,
"field" : null,
"miriamType" : "HGNC"
}, {
"order" : 2,
"field" : "NAME",
"miriamType" : "HGNC_SYMBOL"
} ],
"annotationsToProvide" : [ {
"field" : null,
"miriamType" : "ENSEMBL"
}, {
"field" : null,
"miriamType" : "ENTREZ"
}, {
"field" : null,
"miriamType" : "HGNC"
}, {
"field" : null,
"miriamType" : "HGNC_SYMBOL"
}, {
"field" : null,
"miriamType" : "REFSEQ"
}, {
"field" : null,
"miriamType" : "UNIPROT"
}, {
"field" : "SYMBOL",
"miriamType" : null
}, {
"field" : "PREVIOUS_SYMBOLS",
"miriamType" : null
}, {
"field" : "SYNONYMS",
"miriamType" : null
}, {
"field" : "NAME",
"miriamType" : null
}, {
"field" : "FULL_NAME",
"miriamType" : null
} ],
"options" : [ ]
}, {
"order" : 0,
"targets" : [ "PATHWAY" ],
"annotator" : "COPY_CELL_DESIGNER_ANNOTATIONS",
"sourceInformation" : [ {
"order" : 0,
"field" : "NAME",
"miriamType" : null
} ],
"annotationsToProvide" : [ ],
"options" : [ ]
}, {
"order" : 1,
"targets" : [ "PATHWAY" ],
"annotator" : "GO",
"sourceInformation" : [ {
"order" : 0,
"field" : null,
"miriamType" : "GO"
} ],
"annotationsToProvide" : [ {
"field" : "FULL_NAME",
"miriamType" : null
}, {
"field" : "DESCRIPTION",
"miriamType" : null
} ],
"options" : [ ]
}, {
"order" : 0,
"targets" : [ "PHENOTYPE" ],
"annotator" : "COPY_CELL_DESIGNER_ANNOTATIONS",
"sourceInformation" : [ {
"order" : 0,
"field" : "NAME",
"miriamType" : null
} ],
"annotationsToProvide" : [ ],
"options" : [ ]
}, {
"order" : 1,
"targets" : [ "PHENOTYPE" ],
"annotator" : "GO",
"sourceInformation" : [ {
"order" : 0,
"field" : null,
"miriamType" : "GO"
} ],
"annotationsToProvide" : [ {
"field" : "FULL_NAME",
"miriamType" : null
}, {
"field" : "DESCRIPTION",
"miriamType" : null
} ],
"options" : [ ]
}, {
"order" : 0,
"targets" : [ "RNA" ],
"annotator" : "COPY_CELL_DESIGNER_ANNOTATIONS",
"sourceInformation" : [ {
"order" : 0,
"field" : "NAME",
"miriamType" : null
} ],
"annotationsToProvide" : [ ],
"options" : [ ]
}, {
"order" : 1,
"targets" : [ "RNA" ],
"annotator" : "HGNC",
"sourceInformation" : [ {
"order" : 0,
"field" : null,
"miriamType" : "HGNC_SYMBOL"
}, {
"order" : 1,
"field" : null,
"miriamType" : "HGNC"
}, {
"order" : 2,
"field" : "NAME",
"miriamType" : "HGNC_SYMBOL"
} ],
"annotationsToProvide" : [ {
"field" : null,
"miriamType" : "ENSEMBL"
}, {
"field" : null,
"miriamType" : "ENTREZ"
}, {
"field" : null,
"miriamType" : "HGNC"
}, {
"field" : null,
"miriamType" : "HGNC_SYMBOL"
}, {
"field" : null,
"miriamType" : "REFSEQ"
}, {
"field" : null,
"miriamType" : "UNIPROT"
}, {
"field" : "SYMBOL",
"miriamType" : null
}, {
"field" : "PREVIOUS_SYMBOLS",
"miriamType" : null
}, {
"field" : "SYNONYMS",
"miriamType" : null
}, {
"field" : "NAME",
"miriamType" : null
}, {
"field" : "FULL_NAME",
"miriamType" : null
} ],
"options" : [ ]
}, {
"order" : 0,
"targets" : [ "CHEMICAL" ],
"annotator" : "CHEBI",
"sourceInformation" : [ {
"order" : 0,
"field" : null,
"miriamType" : "CHEBI"
}, {
"order" : 1,
"field" : "NAME",
"miriamType" : null
} ],
"annotationsToProvide" : [ {
"field" : "FULL_NAME",
"miriamType" : null
}, {
"field" : null,
"miriamType" : "INCHI"
}, {
"field" : null,
"miriamType" : "INCHIKEY"
}, {
"field" : null,
"miriamType" : "STITCH"
}, {
"field" : "SMILES",
"miriamType" : null
}, {
"field" : "SYNONYMS",
"miriamType" : null
} ],
"options" : [ ]
}, {
"order" : 1,
"targets" : [ "CHEMICAL" ],
"annotator" : "COPY_CELL_DESIGNER_ANNOTATIONS",
"sourceInformation" : [ {
"order" : 0,
"field" : "NAME",
"miriamType" : null
} ],
"annotationsToProvide" : [ ],
"options" : [ ]
}, {
"order" : 0,
"targets" : [ "COMPARTMENT" ],
"annotator" : "COPY_CELL_DESIGNER_ANNOTATIONS",
"sourceInformation" : [ {
"order" : 0,
"field" : "NAME",
"miriamType" : null
} ],
"annotationsToProvide" : [ ],
"options" : [ ]
}, {
"order" : 1,
"targets" : [ "COMPARTMENT" ],
"annotator" : "GO",
"sourceInformation" : [ {
"order" : 0,
"field" : null,
"miriamType" : "GO"
} ],
"annotationsToProvide" : [ {
"field" : "FULL_NAME",
"miriamType" : null
}, {
"field" : "DESCRIPTION",
"miriamType" : null
} ],
"options" : [ ]
}, {
"order" : 0,
"targets" : [ "OTHER" ],
"annotator" : "COPY_CELL_DESIGNER_ANNOTATIONS",
"sourceInformation" : [ {
"order" : 0,
"field" : "NAME",
"miriamType" : null
} ],
"annotationsToProvide" : [ ],
"options" : [ ]
} ]
} ],
"totalPages" : 1,
"totalElements" : 1,
"numberOfElements" : 1,
"size" : 20,
"number" : 0
}
3.2. Get annotator preset
Returns a single preset by its numeric id, with its full list of configured annotators.
3.2.1. HTTP request
GET /minerva/new_api/annotator_presets/1 HTTP/1.1
3.2.2. CURL sample
$ curl 'https://minerva-dev.lcsb.uni.lu/minerva/new_api/annotator_presets/1' -X GET
3.2.3. HTTP response
HTTP/1.1 200 OK
3.2.4. Response Fields
| Path | Type | Description |
|---|---|---|
|
|
preset name |
|
|
when preset was last updated |
|
|
preset id |
|
|
order in which annotators are being processed |
|
|
element types to annotate, one of: CHEMICAL, COMPARTMENT, COMPLEX, GENE, OTHER, PATHWAY, PHENOTYPE, PROTEIN, REACTION, RNA |
|
|
annotator identifier, one of: BRENDA, CAZY, CHEBI, COPY_CELL_DESIGNER_ANNOTATIONS, ENSEMBL, ENTREZ, GO, HGNC, KEGG, PDB, TAIR, UNIPROT |
|
|
what should be considered as source information |
|
|
order in which source information should be taken into account |
|
|
field type that is used as source information |
|
|
type of annotation that should be used as source information |
|
|
what annotations should be added |
|
|
field that should be filled by annotator |
|
|
annotation that should added by annotator |
|
|
annotator options |
|
|
type of the configuration option |
|
|
value for the configuration option |
3.2.5. Sample Response
{
"id" : 1,
"name" : "DEFAULT",
"updatedAt" : "2026-09-23 23:10:03",
"annotators" : [ {
"order" : 0,
"targets" : [ "COMPLEX" ],
"annotator" : "COPY_CELL_DESIGNER_ANNOTATIONS",
"sourceInformation" : [ {
"order" : 0,
"field" : "NAME",
"miriamType" : null
} ],
"annotationsToProvide" : [ ],
"options" : [ ]
}, {
"order" : 1,
"targets" : [ "COMPLEX" ],
"annotator" : "GO",
"sourceInformation" : [ {
"order" : 0,
"field" : null,
"miriamType" : "GO"
} ],
"annotationsToProvide" : [ {
"field" : "FULL_NAME",
"miriamType" : null
}, {
"field" : "DESCRIPTION",
"miriamType" : null
} ],
"options" : [ ]
}, {
"order" : 0,
"targets" : [ "GENE" ],
"annotator" : "COPY_CELL_DESIGNER_ANNOTATIONS",
"sourceInformation" : [ {
"order" : 0,
"field" : "NAME",
"miriamType" : null
} ],
"annotationsToProvide" : [ ],
"options" : [ ]
}, {
"order" : 1,
"targets" : [ "GENE" ],
"annotator" : "HGNC",
"sourceInformation" : [ {
"order" : 0,
"field" : null,
"miriamType" : "HGNC_SYMBOL"
}, {
"order" : 1,
"field" : null,
"miriamType" : "HGNC"
}, {
"order" : 2,
"field" : "NAME",
"miriamType" : "HGNC_SYMBOL"
} ],
"annotationsToProvide" : [ {
"field" : null,
"miriamType" : "ENSEMBL"
}, {
"field" : null,
"miriamType" : "ENTREZ"
}, {
"field" : null,
"miriamType" : "HGNC"
}, {
"field" : null,
"miriamType" : "HGNC_SYMBOL"
}, {
"field" : null,
"miriamType" : "REFSEQ"
}, {
"field" : null,
"miriamType" : "UNIPROT"
}, {
"field" : "SYMBOL",
"miriamType" : null
}, {
"field" : "PREVIOUS_SYMBOLS",
"miriamType" : null
}, {
"field" : "SYNONYMS",
"miriamType" : null
}, {
"field" : "NAME",
"miriamType" : null
}, {
"field" : "FULL_NAME",
"miriamType" : null
} ],
"options" : [ ]
}, {
"order" : 0,
"targets" : [ "PROTEIN" ],
"annotator" : "COPY_CELL_DESIGNER_ANNOTATIONS",
"sourceInformation" : [ {
"order" : 0,
"field" : "NAME",
"miriamType" : null
} ],
"annotationsToProvide" : [ ],
"options" : [ ]
}, {
"order" : 1,
"targets" : [ "PROTEIN" ],
"annotator" : "HGNC",
"sourceInformation" : [ {
"order" : 0,
"field" : null,
"miriamType" : "HGNC_SYMBOL"
}, {
"order" : 1,
"field" : null,
"miriamType" : "HGNC"
}, {
"order" : 2,
"field" : "NAME",
"miriamType" : "HGNC_SYMBOL"
} ],
"annotationsToProvide" : [ {
"field" : null,
"miriamType" : "ENSEMBL"
}, {
"field" : null,
"miriamType" : "ENTREZ"
}, {
"field" : null,
"miriamType" : "HGNC"
}, {
"field" : null,
"miriamType" : "HGNC_SYMBOL"
}, {
"field" : null,
"miriamType" : "REFSEQ"
}, {
"field" : null,
"miriamType" : "UNIPROT"
}, {
"field" : "SYMBOL",
"miriamType" : null
}, {
"field" : "PREVIOUS_SYMBOLS",
"miriamType" : null
}, {
"field" : "SYNONYMS",
"miriamType" : null
}, {
"field" : "NAME",
"miriamType" : null
}, {
"field" : "FULL_NAME",
"miriamType" : null
} ],
"options" : [ ]
}, {
"order" : 0,
"targets" : [ "PATHWAY" ],
"annotator" : "COPY_CELL_DESIGNER_ANNOTATIONS",
"sourceInformation" : [ {
"order" : 0,
"field" : "NAME",
"miriamType" : null
} ],
"annotationsToProvide" : [ ],
"options" : [ ]
}, {
"order" : 1,
"targets" : [ "PATHWAY" ],
"annotator" : "GO",
"sourceInformation" : [ {
"order" : 0,
"field" : null,
"miriamType" : "GO"
} ],
"annotationsToProvide" : [ {
"field" : "FULL_NAME",
"miriamType" : null
}, {
"field" : "DESCRIPTION",
"miriamType" : null
} ],
"options" : [ ]
}, {
"order" : 0,
"targets" : [ "PHENOTYPE" ],
"annotator" : "COPY_CELL_DESIGNER_ANNOTATIONS",
"sourceInformation" : [ {
"order" : 0,
"field" : "NAME",
"miriamType" : null
} ],
"annotationsToProvide" : [ ],
"options" : [ ]
}, {
"order" : 1,
"targets" : [ "PHENOTYPE" ],
"annotator" : "GO",
"sourceInformation" : [ {
"order" : 0,
"field" : null,
"miriamType" : "GO"
} ],
"annotationsToProvide" : [ {
"field" : "FULL_NAME",
"miriamType" : null
}, {
"field" : "DESCRIPTION",
"miriamType" : null
} ],
"options" : [ ]
}, {
"order" : 0,
"targets" : [ "RNA" ],
"annotator" : "COPY_CELL_DESIGNER_ANNOTATIONS",
"sourceInformation" : [ {
"order" : 0,
"field" : "NAME",
"miriamType" : null
} ],
"annotationsToProvide" : [ ],
"options" : [ ]
}, {
"order" : 1,
"targets" : [ "RNA" ],
"annotator" : "HGNC",
"sourceInformation" : [ {
"order" : 0,
"field" : null,
"miriamType" : "HGNC_SYMBOL"
}, {
"order" : 1,
"field" : null,
"miriamType" : "HGNC"
}, {
"order" : 2,
"field" : "NAME",
"miriamType" : "HGNC_SYMBOL"
} ],
"annotationsToProvide" : [ {
"field" : null,
"miriamType" : "ENSEMBL"
}, {
"field" : null,
"miriamType" : "ENTREZ"
}, {
"field" : null,
"miriamType" : "HGNC"
}, {
"field" : null,
"miriamType" : "HGNC_SYMBOL"
}, {
"field" : null,
"miriamType" : "REFSEQ"
}, {
"field" : null,
"miriamType" : "UNIPROT"
}, {
"field" : "SYMBOL",
"miriamType" : null
}, {
"field" : "PREVIOUS_SYMBOLS",
"miriamType" : null
}, {
"field" : "SYNONYMS",
"miriamType" : null
}, {
"field" : "NAME",
"miriamType" : null
}, {
"field" : "FULL_NAME",
"miriamType" : null
} ],
"options" : [ ]
}, {
"order" : 0,
"targets" : [ "CHEMICAL" ],
"annotator" : "CHEBI",
"sourceInformation" : [ {
"order" : 0,
"field" : null,
"miriamType" : "CHEBI"
}, {
"order" : 1,
"field" : "NAME",
"miriamType" : null
} ],
"annotationsToProvide" : [ {
"field" : "FULL_NAME",
"miriamType" : null
}, {
"field" : null,
"miriamType" : "INCHI"
}, {
"field" : null,
"miriamType" : "INCHIKEY"
}, {
"field" : null,
"miriamType" : "STITCH"
}, {
"field" : "SMILES",
"miriamType" : null
}, {
"field" : "SYNONYMS",
"miriamType" : null
} ],
"options" : [ ]
}, {
"order" : 1,
"targets" : [ "CHEMICAL" ],
"annotator" : "COPY_CELL_DESIGNER_ANNOTATIONS",
"sourceInformation" : [ {
"order" : 0,
"field" : "NAME",
"miriamType" : null
} ],
"annotationsToProvide" : [ ],
"options" : [ ]
}, {
"order" : 0,
"targets" : [ "COMPARTMENT" ],
"annotator" : "COPY_CELL_DESIGNER_ANNOTATIONS",
"sourceInformation" : [ {
"order" : 0,
"field" : "NAME",
"miriamType" : null
} ],
"annotationsToProvide" : [ ],
"options" : [ ]
}, {
"order" : 1,
"targets" : [ "COMPARTMENT" ],
"annotator" : "GO",
"sourceInformation" : [ {
"order" : 0,
"field" : null,
"miriamType" : "GO"
} ],
"annotationsToProvide" : [ {
"field" : "FULL_NAME",
"miriamType" : null
}, {
"field" : "DESCRIPTION",
"miriamType" : null
} ],
"options" : [ ]
}, {
"order" : 0,
"targets" : [ "OTHER" ],
"annotator" : "COPY_CELL_DESIGNER_ANNOTATIONS",
"sourceInformation" : [ {
"order" : 0,
"field" : "NAME",
"miriamType" : null
} ],
"annotationsToProvide" : [ ],
"options" : [ ]
} ]
}
3.3. Add annotator preset
Saves a new preset from the given name and list of annotator configurations; the created preset, including its assigned id, is returned.
3.3.1. HTTP request
POST /minerva/new_api/annotator_presets/ HTTP/1.1
3.3.2. CURL sample
$ curl 'https://minerva-dev.lcsb.uni.lu/minerva/new_api/annotator_presets/' -X POST \
-H 'Authorization: Bearer xxxxxxxx' \
-d '{"name":"Casey Bradtke","annotators":[{"annotator":"COPY_CELL_DESIGNER_ANNOTATIONS","order":3,"targets":["RNA"],"annotationsToProvide":[{"field":"DESCRIPTION","miriamType":null}],"sourceInformation":[{"field":"CHARGE","miriamType":null,"order":4}],"options":[{"type":"KEGG_ORGANISM_IDENTIFIER","value":"ovsbe"}]}]}' \
-H 'Content-Type: application/json'
3.3.3. HTTP response
HTTP/1.1 201 Created
3.3.4. Response Fields
| Path | Type | Description |
|---|---|---|
|
|
preset name |
|
|
when preset was last updated |
|
|
preset id |
|
|
order in which annotators are being processed |
|
|
element types to annotate, one of: CHEMICAL, COMPARTMENT, COMPLEX, GENE, OTHER, PATHWAY, PHENOTYPE, PROTEIN, REACTION, RNA |
|
|
annotator identifier, one of: BRENDA, CAZY, CHEBI, COPY_CELL_DESIGNER_ANNOTATIONS, ENSEMBL, ENTREZ, GO, HGNC, KEGG, PDB, TAIR, UNIPROT |
|
|
what should be considered as source information |
|
|
order in which source information should be taken into account |
|
|
field type that is used as source information |
|
|
type of annotation that should be used as source information |
|
|
what annotations should be added |
|
|
field that should be filled by annotator |
|
|
annotation that should added by annotator |
|
|
annotator options |
|
|
type of the configuration option |
|
|
value for the configuration option |
3.3.5. Sample Response
{
"id" : 2,
"name" : "Casey Bradtke",
"updatedAt" : "2026-09-23 23:10:46",
"annotators" : [ {
"order" : 0,
"targets" : [ "RNA" ],
"annotator" : "COPY_CELL_DESIGNER_ANNOTATIONS",
"sourceInformation" : [ {
"order" : 1,
"field" : "CHARGE",
"miriamType" : null
} ],
"annotationsToProvide" : [ {
"field" : "DESCRIPTION",
"miriamType" : null
} ],
"options" : [ {
"type" : "KEGG_ORGANISM_IDENTIFIER",
"value" : "ovsbe"
} ]
} ]
}
3.4. Update annotator preset
Replaces the name and the annotator configuration of an existing preset; the request body has the same structure as when creating one.
3.4.1. HTTP request
PUT /minerva/new_api/annotator_presets/1 HTTP/1.1
3.4.2. Path Parameters
| Parameter | Description |
|---|---|
|
preset identifier |
3.4.3. CURL sample
$ curl 'https://minerva-dev.lcsb.uni.lu/minerva/new_api/annotator_presets/1' -X PUT \
-H 'Authorization: Bearer xxxxxxxx' \
-d '{"name":"Venita Shanahan","annotators":[{"annotator":"COPY_CELL_DESIGNER_ANNOTATIONS","order":8,"targets":["RNA"],"annotationsToProvide":[{"field":"SMILES","miriamType":null}],"sourceInformation":[{"field":null,"miriamType":"ECO","order":2}],"options":[{"type":"KEGG_ORGANISM_IDENTIFIER","value":"tjhoz"}]}]}' \
-H 'Content-Type: application/json'
3.4.4. HTTP response
HTTP/1.1 200 OK
3.4.5. Response Fields
| Path | Type | Description |
|---|---|---|
|
|
preset name |
|
|
when preset was last updated |
|
|
preset id |
|
|
order in which annotators are being processed |
|
|
element types to annotate, one of: CHEMICAL, COMPARTMENT, COMPLEX, GENE, OTHER, PATHWAY, PHENOTYPE, PROTEIN, REACTION, RNA |
|
|
annotator identifier, one of: BRENDA, CAZY, CHEBI, COPY_CELL_DESIGNER_ANNOTATIONS, ENSEMBL, ENTREZ, GO, HGNC, KEGG, PDB, TAIR, UNIPROT |
|
|
what should be considered as source information |
|
|
order in which source information should be taken into account |
|
|
field type that is used as source information |
|
|
type of annotation that should be used as source information |
|
|
what annotations should be added |
|
|
field that should be filled by annotator |
|
|
annotation that should added by annotator |
|
|
annotator options |
|
|
type of the configuration option |
|
|
value for the configuration option |
3.4.6. Sample Response
{
"id" : 1,
"name" : "DEFAULT",
"updatedAt" : "2026-09-23 23:10:03",
"annotators" : [ {
"order" : 0,
"targets" : [ "COMPLEX" ],
"annotator" : "COPY_CELL_DESIGNER_ANNOTATIONS",
"sourceInformation" : [ {
"order" : 0,
"field" : "NAME",
"miriamType" : null
} ],
"annotationsToProvide" : [ ],
"options" : [ ]
}, {
"order" : 1,
"targets" : [ "COMPLEX" ],
"annotator" : "GO",
"sourceInformation" : [ {
"order" : 0,
"field" : null,
"miriamType" : "GO"
} ],
"annotationsToProvide" : [ {
"field" : "FULL_NAME",
"miriamType" : null
}, {
"field" : "DESCRIPTION",
"miriamType" : null
} ],
"options" : [ ]
}, {
"order" : 0,
"targets" : [ "GENE" ],
"annotator" : "COPY_CELL_DESIGNER_ANNOTATIONS",
"sourceInformation" : [ {
"order" : 0,
"field" : "NAME",
"miriamType" : null
} ],
"annotationsToProvide" : [ ],
"options" : [ ]
}, {
"order" : 1,
"targets" : [ "GENE" ],
"annotator" : "HGNC",
"sourceInformation" : [ {
"order" : 0,
"field" : null,
"miriamType" : "HGNC_SYMBOL"
}, {
"order" : 1,
"field" : null,
"miriamType" : "HGNC"
}, {
"order" : 2,
"field" : "NAME",
"miriamType" : "HGNC_SYMBOL"
} ],
"annotationsToProvide" : [ {
"field" : null,
"miriamType" : "ENSEMBL"
}, {
"field" : null,
"miriamType" : "ENTREZ"
}, {
"field" : null,
"miriamType" : "HGNC"
}, {
"field" : null,
"miriamType" : "HGNC_SYMBOL"
}, {
"field" : null,
"miriamType" : "REFSEQ"
}, {
"field" : null,
"miriamType" : "UNIPROT"
}, {
"field" : "SYMBOL",
"miriamType" : null
}, {
"field" : "PREVIOUS_SYMBOLS",
"miriamType" : null
}, {
"field" : "SYNONYMS",
"miriamType" : null
}, {
"field" : "NAME",
"miriamType" : null
}, {
"field" : "FULL_NAME",
"miriamType" : null
} ],
"options" : [ ]
}, {
"order" : 0,
"targets" : [ "PROTEIN" ],
"annotator" : "COPY_CELL_DESIGNER_ANNOTATIONS",
"sourceInformation" : [ {
"order" : 0,
"field" : "NAME",
"miriamType" : null
} ],
"annotationsToProvide" : [ ],
"options" : [ ]
}, {
"order" : 1,
"targets" : [ "PROTEIN" ],
"annotator" : "HGNC",
"sourceInformation" : [ {
"order" : 0,
"field" : null,
"miriamType" : "HGNC_SYMBOL"
}, {
"order" : 1,
"field" : null,
"miriamType" : "HGNC"
}, {
"order" : 2,
"field" : "NAME",
"miriamType" : "HGNC_SYMBOL"
} ],
"annotationsToProvide" : [ {
"field" : null,
"miriamType" : "ENSEMBL"
}, {
"field" : null,
"miriamType" : "ENTREZ"
}, {
"field" : null,
"miriamType" : "HGNC"
}, {
"field" : null,
"miriamType" : "HGNC_SYMBOL"
}, {
"field" : null,
"miriamType" : "REFSEQ"
}, {
"field" : null,
"miriamType" : "UNIPROT"
}, {
"field" : "SYMBOL",
"miriamType" : null
}, {
"field" : "PREVIOUS_SYMBOLS",
"miriamType" : null
}, {
"field" : "SYNONYMS",
"miriamType" : null
}, {
"field" : "NAME",
"miriamType" : null
}, {
"field" : "FULL_NAME",
"miriamType" : null
} ],
"options" : [ ]
}, {
"order" : 0,
"targets" : [ "PATHWAY" ],
"annotator" : "COPY_CELL_DESIGNER_ANNOTATIONS",
"sourceInformation" : [ {
"order" : 0,
"field" : "NAME",
"miriamType" : null
} ],
"annotationsToProvide" : [ ],
"options" : [ ]
}, {
"order" : 1,
"targets" : [ "PATHWAY" ],
"annotator" : "GO",
"sourceInformation" : [ {
"order" : 0,
"field" : null,
"miriamType" : "GO"
} ],
"annotationsToProvide" : [ {
"field" : "FULL_NAME",
"miriamType" : null
}, {
"field" : "DESCRIPTION",
"miriamType" : null
} ],
"options" : [ ]
}, {
"order" : 0,
"targets" : [ "PHENOTYPE" ],
"annotator" : "COPY_CELL_DESIGNER_ANNOTATIONS",
"sourceInformation" : [ {
"order" : 0,
"field" : "NAME",
"miriamType" : null
} ],
"annotationsToProvide" : [ ],
"options" : [ ]
}, {
"order" : 1,
"targets" : [ "PHENOTYPE" ],
"annotator" : "GO",
"sourceInformation" : [ {
"order" : 0,
"field" : null,
"miriamType" : "GO"
} ],
"annotationsToProvide" : [ {
"field" : "FULL_NAME",
"miriamType" : null
}, {
"field" : "DESCRIPTION",
"miriamType" : null
} ],
"options" : [ ]
}, {
"order" : 0,
"targets" : [ "RNA" ],
"annotator" : "COPY_CELL_DESIGNER_ANNOTATIONS",
"sourceInformation" : [ {
"order" : 0,
"field" : "NAME",
"miriamType" : null
} ],
"annotationsToProvide" : [ ],
"options" : [ ]
}, {
"order" : 1,
"targets" : [ "RNA" ],
"annotator" : "HGNC",
"sourceInformation" : [ {
"order" : 0,
"field" : null,
"miriamType" : "HGNC_SYMBOL"
}, {
"order" : 1,
"field" : null,
"miriamType" : "HGNC"
}, {
"order" : 2,
"field" : "NAME",
"miriamType" : "HGNC_SYMBOL"
} ],
"annotationsToProvide" : [ {
"field" : null,
"miriamType" : "ENSEMBL"
}, {
"field" : null,
"miriamType" : "ENTREZ"
}, {
"field" : null,
"miriamType" : "HGNC"
}, {
"field" : null,
"miriamType" : "HGNC_SYMBOL"
}, {
"field" : null,
"miriamType" : "REFSEQ"
}, {
"field" : null,
"miriamType" : "UNIPROT"
}, {
"field" : "SYMBOL",
"miriamType" : null
}, {
"field" : "PREVIOUS_SYMBOLS",
"miriamType" : null
}, {
"field" : "SYNONYMS",
"miriamType" : null
}, {
"field" : "NAME",
"miriamType" : null
}, {
"field" : "FULL_NAME",
"miriamType" : null
} ],
"options" : [ ]
}, {
"order" : 0,
"targets" : [ "CHEMICAL" ],
"annotator" : "CHEBI",
"sourceInformation" : [ {
"order" : 0,
"field" : null,
"miriamType" : "CHEBI"
}, {
"order" : 1,
"field" : "NAME",
"miriamType" : null
} ],
"annotationsToProvide" : [ {
"field" : "FULL_NAME",
"miriamType" : null
}, {
"field" : null,
"miriamType" : "INCHI"
}, {
"field" : null,
"miriamType" : "INCHIKEY"
}, {
"field" : null,
"miriamType" : "STITCH"
}, {
"field" : "SMILES",
"miriamType" : null
}, {
"field" : "SYNONYMS",
"miriamType" : null
} ],
"options" : [ ]
}, {
"order" : 1,
"targets" : [ "CHEMICAL" ],
"annotator" : "COPY_CELL_DESIGNER_ANNOTATIONS",
"sourceInformation" : [ {
"order" : 0,
"field" : "NAME",
"miriamType" : null
} ],
"annotationsToProvide" : [ ],
"options" : [ ]
}, {
"order" : 0,
"targets" : [ "COMPARTMENT" ],
"annotator" : "COPY_CELL_DESIGNER_ANNOTATIONS",
"sourceInformation" : [ {
"order" : 0,
"field" : "NAME",
"miriamType" : null
} ],
"annotationsToProvide" : [ ],
"options" : [ ]
}, {
"order" : 1,
"targets" : [ "COMPARTMENT" ],
"annotator" : "GO",
"sourceInformation" : [ {
"order" : 0,
"field" : null,
"miriamType" : "GO"
} ],
"annotationsToProvide" : [ {
"field" : "FULL_NAME",
"miriamType" : null
}, {
"field" : "DESCRIPTION",
"miriamType" : null
} ],
"options" : [ ]
}, {
"order" : 0,
"targets" : [ "OTHER" ],
"annotator" : "COPY_CELL_DESIGNER_ANNOTATIONS",
"sourceInformation" : [ {
"order" : 0,
"field" : "NAME",
"miriamType" : null
} ],
"annotationsToProvide" : [ ],
"options" : [ ]
} ]
}
3.5. Delete annotator preset
Removes a preset permanently. Projects already annotated with it are not affected.
3.5.1. HTTP request
DELETE /minerva/new_api/annotator_presets/3 HTTP/1.1
3.5.2. Path Parameters
| Parameter | Description |
|---|---|
|
preset identifier |
3.5.3. CURL sample
$ curl 'https://minerva-dev.lcsb.uni.lu/minerva/new_api/annotator_presets/3' -X DELETE \
-H 'Authorization: Bearer xxxxxxxx'
3.5.4. HTTP response
HTTP/1.1 200 OK