changedInput schema / properties / id / description
Previous value: -"Ensembl stable gene ID (e.g. ENSG00000139618 or ENSG00000139618.7 with version). Species is not required for ID lookup."New value: +"Ensembl stable gene ID (e.g. ENSG00000139618). A version suffix on an ENS… ID (ENSG00000139618.19) is dropped before the lookup, which returns the current version. Species is not required for ID lookup."
changedInput schema / properties / ids / description
Previous value: -"Batch lookup: up to 20 Ensembl stable IDs (ENSG…, ENST…). Returns a succeeded/failed split. Provide exactly one of symbol, id, ids, or symbols."New value: +"Batch lookup: up to 20 Ensembl stable IDs (ENSG…, ENST…). A version suffix on an ENS… ID is dropped before the lookup. Returns a succeeded/failed split; each item carries its query — the ID as submitted, version included — and each failed item a reason and recovery. Provide exactly one of symbol, id, ids, or symbols."
changedInput schema / properties / species / description
Previous value: -"Species in Ensembl internal format: lowercase scientific name with underscores (e.g. homo_sapiens, mus_musculus, danio_rerio). Optional for symbol lookups — defaults to homo_sapiens; set it for other organisms. Use ensembl_list_species to discover valid values."New value: +"Species in Ensembl internal format: lowercase scientific name with underscores (e.g. homo_sapiens, mus_musculus, danio_rerio). Optional for symbol lookups — defaults to homo_sapiens; set it for other organisms. Use ensembl_list_species with nameContains (a genus or common name) to find valid values."
changedInput schema / properties / symbol / description
Previous value: -"Gene symbol to look up (e.g. BRCA2, TP53, EGFR). Species defaults to homo_sapiens; set species for other organisms. Case-insensitive in most species."New value: +"Gene symbol to look up (e.g. BRCA2, TP53, EGFR). Species defaults to homo_sapiens; set species for other organisms. Case-insensitive in most species. A synonym or former symbol (HER2, TB1) resolves too; one shared by several genes returns ambiguous with the candidates instead of gene."
changedInput schema / properties / symbols / description
Previous value: -"Batch lookup: up to 20 gene symbols. Species defaults to homo_sapiens; set species for other organisms. Returns a succeeded/failed split. Provide exactly one of symbol, id, ids, or symbols."New value: +"Batch lookup: up to 20 gene symbols. Species defaults to homo_sapiens; set species for other organisms. Returns a succeeded/failed split; each item carries its submitted query. Synonyms and former symbols resolve with matchedAlias; one shared by several genes fails with reason ambiguous and its candidates. Provide exactly one of symbol, id, ids, or symbols."
addedOutput schema / properties / ambiguous
Added value: +{
+ "additionalProperties": false,
+ "description": "Present instead of gene when a symbol is not a current gene name and is a synonym or former symbol of several genes.",
+ "properties": {
+ "candidates": {
+ "description": "Every gene the symbol maps to. Retry with id set to the intended one.",
+ "items": {
+ "additionalProperties": false,
+ "description": "A gene the symbol is a synonym or former symbol of.",
+ "properties": {
+ "assemblyName": {
+ "description": "Genome assembly name (e.g. GRCh38). All coordinates are relative to this assembly.",
+ "type": "string"
+ },
+ "biotype": {
+ "description": "Gene biotype (e.g. protein_coding, lncRNA, pseudogene).",
+ "type": "string"
+ },
+ "chromosome": {
+ "description": "Chromosome or sequence region name.",
+ "type": "string"
+ },
+ "description": {
+ "description": "Brief gene description from Ensembl.",
+ "type": "string"
+ },
+ "displayName": {
+ "description": "Gene symbol or display name (e.g. BRCA2, TP53).",
+ "type": "string"
+ },
+ "end": {
+ "description": "Gene end position on the chromosome (1-based).",
+ "type": "number"
+ },
+ "id": {
+ "description": "Ensembl gene stable ID (ENSG…). Use this as input to other Ensembl tools.",
+ "type": "string"
+ },
+ "species": {
+ "description": "Species in Ensembl internal format (e.g. homo_sapiens). Echoed from lookup.",
+ "type": "string"
+ },
+ "start": {
+ "description": "Gene start position on the chromosome (1-based).",
+ "type": "number"
+ },
+ "strand": {
+ "description": "Strand: 1 for forward, -1 for reverse.",
+ "type": "number"
+ },
+ "transcripts": {
+ "description": "Transcript list. Present only when expand_transcripts is true.",
+ "items": {
+ "additionalProperties": false,
+ "description": "A single transcript summary entry.",
+ "properties": {
+ "biotype": {
+ "description": "Transcript biotype (e.g. protein_coding, lncRNA, retained_intron).",
+ "type": "string"
+ },
+ "displayName": {
+ "description": "Transcript display name.",
+ "type": "string"
+ },
+ "end": {
+ "description": "Transcript end position on the chromosome (1-based).",
+ "type": "number"
+ },
+ "id": {
+ "description": "Ensembl transcript stable ID (ENST…).",
+ "type": "string"
+ },
+ "isCanonical": {
+ "description": "True when this is the canonical transcript for the gene.",
+ "type": "boolean"
+ },
+ "lengthInBp": {
+ "description": "Transcript length in base pairs.",
+ "type": "number"
+ },
+ "start": {
+ "description": "Transcript start position on the chromosome (1-based).",
+ "type": "number"
+ },
+ "strand": {
+ "description": "Strand: 1 for forward, -1 for reverse.",
+ "type": "number"
+ }
+ },
+ "required": [
+ "id",
+ "isCanonical"
+ ],
+ "type": "object"
+ },
+ "type": "array"
+ }
+ },
+ "required": [
+ "id"
+ ],
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "guidance": {
+ "description": "How to pick a candidate and retry by id.",
+ "type": "string"
+ },
+ "query": {
+ "description": "The submitted symbol.",
+ "type": "string"
+ }
+ },
+ "required": [
+ "query",
+ "candidates",
+ "guidance"
+ ],
+ "type": "object"
+}
changedOutput schema / properties / batch / properties / failed / description
Previous value: -"IDs/symbols that could not be resolved, with per-item query and error fields."New value: +"IDs/symbols that did not resolve to one gene, in input order."
changedOutput schema / properties / batch / properties / failed / items / additionalProperties
Previous value: -{}New value: +false
changedOutput schema / properties / batch / properties / failed / items / description
Previous value: -"A failed lookup entry with query (the submitted ID or symbol) and error (reason string) fields."New value: +"One unresolved ID or symbol."
addedOutput schema / properties / batch / properties / failed / items / properties / candidates
Added value: +{
+ "description": "Every gene the symbol maps to. Present only when reason is ambiguous.",
+ "items": {
+ "additionalProperties": false,
+ "description": "A gene the symbol is a synonym or former symbol of.",
+ "properties": {
+ "assemblyName": {
+ "description": "Genome assembly name (e.g. GRCh38). All coordinates are relative to this assembly.",
+ "type": "string"
+ },
+ "biotype": {
+ "description": "Gene biotype (e.g. protein_coding, lncRNA, pseudogene).",
+ "type": "string"
+ },
+ "chromosome": {
+ "description": "Chromosome or sequence region name.",
+ "type": "string"
+ },
+ "description": {
+ "description": "Brief gene description from Ensembl.",
+ "type": "string"
+ },
+ "displayName": {
+ "description": "Gene symbol or display name (e.g. BRCA2, TP53).",
+ "type": "string"
+ },
+ "end": {
+ "description": "Gene end position on the chromosome (1-based).",
+ "type": "number"
+ },
+ "id": {
+ "description": "Ensembl gene stable ID (ENSG…). Use this as input to other Ensembl tools.",
+ "type": "string"
+ },
+ "species": {
+ "description": "Species in Ensembl internal format (e.g. homo_sapiens). Echoed from lookup.",
+ "type": "string"
+ },
+ "start": {
+ "description": "Gene start position on the chromosome (1-based).",
+ "type": "number"
+ },
+ "strand": {
+ "description": "Strand: 1 for forward, -1 for reverse.",
+ "type": "number"
+ },
+ "transcripts": {
+ "description": "Transcript list. Present only when expand_transcripts is true.",
+ "items": {
+ "additionalProperties": false,
+ "description": "A single transcript summary entry.",
+ "properties": {
+ "biotype": {
+ "description": "Transcript biotype (e.g. protein_coding, lncRNA, retained_intron).",
+ "type": "string"
+ },
+ "displayName": {
+ "description": "Transcript display name.",
+ "type": "string"
+ },
+ "end": {
+ "description": "Transcript end position on the chromosome (1-based).",
+ "type": "number"
+ },
+ "id": {
+ "description": "Ensembl transcript stable ID (ENST…).",
+ "type": "string"
+ },
+ "isCanonical": {
+ "description": "True when this is the canonical transcript for the gene.",
+ "type": "boolean"
+ },
+ "lengthInBp": {
+ "description": "Transcript length in base pairs.",
+ "type": "number"
+ },
+ "start": {
+ "description": "Transcript start position on the chromosome (1-based).",
+ "type": "number"
+ },
+ "strand": {
+ "description": "Strand: 1 for forward, -1 for reverse.",
+ "type": "number"
+ }
+ },
+ "required": [
+ "id",
+ "isCanonical"
+ ],
+ "type": "object"
+ },
+ "type": "array"
+ }
+ },
+ "required": [
+ "id"
+ ],
+ "type": "object"
+ },
+ "type": "array"
+}
addedOutput schema / properties / batch / properties / failed / items / properties / error
Added value: +{
+ "description": "What went wrong for this item.",
+ "type": "string"
+}
addedOutput schema / properties / batch / properties / failed / items / properties / query
Added value: +{
+ "description": "The submitted ID or symbol.",
+ "type": "string"
+}
addedOutput schema / properties / batch / properties / failed / items / properties / reason
Added value: +{
+ "description": "not_found: nothing matched. ambiguous: the symbol is a synonym of several genes, listed in candidates. unavailable: Ensembl did not answer the synonym lookup for this symbol after retries, so whether it matches is unknown — retry it.",
+ "enum": [
+ "not_found",
+ "ambiguous",
+ "unavailable"
+ ],
+ "type": "string"
+}
addedOutput schema / properties / batch / properties / failed / items / properties / recovery
Added value: +{
+ "description": "The next step for this item.",
+ "type": "string"
+}
addedOutput schema / properties / batch / properties / failed / items / required
Added value: +[
+ "query",
+ "reason",
+ "error",
+ "recovery"
+]
changedOutput schema / properties / batch / properties / succeeded / description
Previous value: -"Gene records for IDs/symbols that resolved successfully. Same shape as gene."New value: +"Records for IDs/symbols that resolved to one gene, in input order."
changedOutput schema / properties / batch / properties / succeeded / items / additionalProperties
Previous value: -{}New value: +false
changedOutput schema / properties / batch / properties / succeeded / items / description
Previous value: -"A resolved gene record with the same shape as the gene output field."New value: +"A resolved gene record carrying its submitted query."
addedOutput schema / properties / batch / properties / succeeded / items / properties / assemblyName
Added value: +{
+ "description": "Genome assembly name (e.g. GRCh38). All coordinates are relative to this assembly.",
+ "type": "string"
+}
addedOutput schema / properties / batch / properties / succeeded / items / properties / biotype
Added value: +{
+ "description": "Gene biotype (e.g. protein_coding, lncRNA, pseudogene).",
+ "type": "string"
+}
addedOutput schema / properties / batch / properties / succeeded / items / properties / chromosome
Added value: +{
+ "description": "Chromosome or sequence region name.",
+ "type": "string"
+}
addedOutput schema / properties / batch / properties / succeeded / items / properties / description
Added value: +{
+ "description": "Brief gene description from Ensembl.",
+ "type": "string"
+}
addedOutput schema / properties / batch / properties / succeeded / items / properties / displayName
Added value: +{
+ "description": "Gene symbol or display name (e.g. BRCA2, TP53).",
+ "type": "string"
+}
addedOutput schema / properties / batch / properties / succeeded / items / properties / end
Added value: +{
+ "description": "Gene end position on the chromosome (1-based).",
+ "type": "number"
+}
addedOutput schema / properties / batch / properties / succeeded / items / properties / id
Added value: +{
+ "description": "Ensembl gene stable ID (ENSG…). Use this as input to other Ensembl tools.",
+ "type": "string"
+}
addedOutput schema / properties / batch / properties / succeeded / items / properties / matchedAlias
Added value: +{
+ "description": "The submitted symbol, present when it matched a synonym or former symbol rather than the current gene name; displayName holds the current name.",
+ "type": "string"
+}
addedOutput schema / properties / batch / properties / succeeded / items / properties / query
Added value: +{
+ "description": "The submitted ID or symbol this record resolved from.",
+ "type": "string"
+}
addedOutput schema / properties / batch / properties / succeeded / items / properties / species
Added value: +{
+ "description": "Species in Ensembl internal format (e.g. homo_sapiens). Echoed from lookup.",
+ "type": "string"
+}
addedOutput schema / properties / batch / properties / succeeded / items / properties / start
Added value: +{
+ "description": "Gene start position on the chromosome (1-based).",
+ "type": "number"
+}
addedOutput schema / properties / batch / properties / succeeded / items / properties / strand
Added value: +{
+ "description": "Strand: 1 for forward, -1 for reverse.",
+ "type": "number"
+}
addedOutput schema / properties / batch / properties / succeeded / items / properties / transcripts
Added value: +{
+ "description": "Transcript list. Present only when expand_transcripts is true.",
+ "items": {
+ "additionalProperties": false,
+ "description": "A single transcript summary entry.",
+ "properties": {
+ "biotype": {
+ "description": "Transcript biotype (e.g. protein_coding, lncRNA, retained_intron).",
+ "type": "string"
+ },
+ "displayName": {
+ "description": "Transcript display name.",
+ "type": "string"
+ },
+ "end": {
+ "description": "Transcript end position on the chromosome (1-based).",
+ "type": "number"
+ },
+ "id": {
+ "description": "Ensembl transcript stable ID (ENST…).",
+ "type": "string"
+ },
+ "isCanonical": {
+ "description": "True when this is the canonical transcript for the gene.",
+ "type": "boolean"
+ },
+ "lengthInBp": {
+ "description": "Transcript length in base pairs.",
+ "type": "number"
+ },
+ "start": {
+ "description": "Transcript start position on the chromosome (1-based).",
+ "type": "number"
+ },
+ "strand": {
+ "description": "Strand: 1 for forward, -1 for reverse.",
+ "type": "number"
+ }
+ },
+ "required": [
+ "id",
+ "isCanonical"
+ ],
+ "type": "object"
+ },
+ "type": "array"
+}
addedOutput schema / properties / batch / properties / succeeded / items / required
Added value: +[
+ "id",
+ "query"
+]
changedOutput schema / properties / gene / description
Previous value: -"Single gene record. Present for symbol or id lookups."New value: +"Single gene record. Present for an id lookup, or a symbol lookup that resolved to one gene."
addedOutput schema / properties / gene / properties / matchedAlias
Added value: +{
+ "description": "The submitted symbol, present when it matched a synonym or former symbol rather than the current gene name; displayName holds the current name.",
+ "type": "string"
+}