PublicVariantUnavailableResponse

BioinformaticsGenomicsClinicalHealthcareData Science

Properties

Name Type Description
contract_version string
status string
identity object
display object
error object
provenance object
warnings array
limitations object
View JSON Schema on GitHub

JSON Schema

helena-bio-public-variant-unavailable-response-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/helena-bio/json-schema/helena-bio-public-variant-unavailable-response-schema.json",
  "title": "PublicVariantUnavailableResponse",
  "x-generated": "2026-11-10",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/helena-bio-public-variants-api-openapi.yml#/components/schemas/PublicVariantUnavailableResponse",
  "properties": {
    "contract_version": {
      "type": "string",
      "const": "1.0",
      "title": "Contract Version",
      "default": "1.0"
    },
    "status": {
      "type": "string",
      "const": "unavailable",
      "title": "Status",
      "default": "unavailable"
    },
    "identity": {
      "$ref": "#/$defs/PublicVariantIdentity"
    },
    "display": {
      "$ref": "#/$defs/PublicVariantDisplay"
    },
    "error": {
      "$ref": "#/$defs/PublicVariantUnavailableError"
    },
    "provenance": {
      "$ref": "#/$defs/PublicVariantProvenance"
    },
    "warnings": {
      "items": {
        "type": "string",
        "enum": [
          "hgvs_display_incomplete",
          "clinvar_evidence_not_available",
          "expert_evidence_not_available",
          "external_link_unavailable",
          "evidence_truncated"
        ]
      },
      "type": "array",
      "title": "Warnings"
    },
    "limitations": {
      "$ref": "#/$defs/PublicVariantLimitations"
    }
  },
  "additionalProperties": false,
  "type": "object",
  "required": [
    "identity",
    "display",
    "error",
    "provenance",
    "warnings",
    "limitations"
  ],
  "$defs": {
    "PublicReferenceVersion": {
      "properties": {
        "name": {
          "type": "string",
          "minLength": 1,
          "title": "Name"
        },
        "version": {
          "type": "string",
          "minLength": 1,
          "title": "Version"
        }
      },
      "additionalProperties": false,
      "type": "object",
      "required": [
        "name",
        "version"
      ],
      "title": "PublicReferenceVersion"
    },
    "PublicVariantDisplay": {
      "properties": {
        "label": {
          "type": "string",
          "minLength": 1,
          "title": "Label"
        },
        "hgvs_genomic": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "title": "Hgvs Genomic"
        },
        "hgvs_cdna": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "title": "Hgvs Cdna"
        },
        "hgvs_protein": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "title": "Hgvs Protein"
        }
      },
      "additionalProperties": false,
      "type": "object",
      "required": [
        "label",
        "hgvs_genomic",
        "hgvs_cdna",
        "hgvs_protein"
      ],
      "title": "PublicVariantDisplay"
    },
    "PublicVariantIdentity": {
      "properties": {
        "assembly": {
          "type": "string",
          "const": "GRCh38",
          "title": "Assembly"
        },
        "chromosome": {
          "type": "string",
          "minLength": 1,
          "title": "Chromosome"
        },
        "position": {
          "type": "integer",
          "minimum": 1.0,
          "title": "Position"
        },
        "reference": {
          "type": "string",
          "minLength": 1,
          "title": "Reference"
        },
        "alternate": {
          "type": "string",
          "minLength": 1,
          "title": "Alternate"
        },
        "variant_type": {
          "type": "string",
          "enum": [
            "SNV",
            "INS",
            "DEL",
            "DELINS"
          ],
          "title": "Variant Type"
        },
        "canonical_key": {
          "type": "string",
          "minLength": 1,
          "title": "Canonical Key"
        }
      },
      "additionalProperties": false,
      "type": "object",
      "required": [
        "assembly",
        "chromosome",
        "position",
        "reference",
        "alternate",
        "variant_type",
        "canonical_key"
      ],
      "title": "PublicVariantIdentity"
    },
    "PublicVariantLimitations": {
      "properties": {
        "scope": {
          "type": "string",
          "const": "Automated variant-level ACMG/AMP decision support for one GRCh38 nuclear SNV, simple indel, or delins smaller than 50 bp.",
          "title": "Scope",
          "default": "Automated variant-level ACMG/AMP decision support for one GRCh38 nuclear SNV, simple indel, or delins smaller than 50 bp."
        },
        "unavailable_context": {
          "type": "string",
          "const": "Patient phenotype, genotype, family, segregation, de novo, case-specific, and private override evidence were not evaluated.",
          "title": "Unavailable Context",
          "default": "Patient phenotype, genotype, family, segregation, de novo, case-specific, and private override evidence were not evaluated."
        },
        "diagnostic_use": {
          "type": "string",
          "const": "This result is not a patient diagnosis and must not be used as a substitute for qualified clinical interpretation.",
          "title": "Diagnostic Use",
          "default": "This result is not a patient diagnosis and must not be used as a substitute for qualified clinical interpretation."
        }
      },
      "additionalProperties": false,
      "type": "object",
      "title": "PublicVariantLimitations"
    },
    "PublicVariantProvenance": {
      "properties": {
        "annotation_source": {
          "anyOf": [
            {
              "type": "string",
              "enum": [
                "vep_cache",
                "vep_live"
              ]
            },
            {
              "type": "null"
            }
          ],
          "title": "Annotation Source"
        },
        "vep_version": {
          "type": "string",
          "title": "Vep Version"
        },
        "vep_cache_version": {
          "type": "string",
          "title": "Vep Cache Version"
        },
        "reference_assembly": {
          "type": "string",
          "title": "Reference Assembly"
        },
        "classifier_version": {
          "type": "string",
          "title": "Classifier Version"
        },
        "classifier_version_label": {
          "type": "string",
          "title": "Classifier Version Label"
        },
        "reference_versions": {
          "items": {
            "$ref": "#/$defs/PublicReferenceVersion"
          },
          "type": "array",
          "title": "Reference Versions"
        },
        "annotation_resolved": {
          "type": "boolean",
          "title": "Annotation Resolved"
        },
        "classification_completed": {
          "type": "boolean",
          "title": "Classification Completed"
        }
      },
      "additionalProperties": false,
      "type": "object",
      "required": [
        "annotation_source",
        "vep_version",
        "vep_cache_version",
        "reference_assembly",
        "classifier_version",
        "classifier_version_label",
        "reference_versions",
        "annotation_resolved",
        "classification_completed"
      ],
      "title": "PublicVariantProvenance"
    },
    "PublicVariantUnavailableError": {
      "properties": {
        "code": {
          "type": "string",
          "enum": [
            "annotation_unavailable",
            "reference_data_unavailable",
            "classification_unavailable"
          ],
          "title": "Code"
        },
        "message": {
          "type": "string",
          "minLength": 1,
          "title": "Message"
        },
        "retryable": {
          "type": "boolean",
          "const": true,
          "title": "Retryable",
          "default": true
        }
      },
      "additionalProperties": false,
      "type": "object",
      "required": [
        "code",
        "message"
      ],
      "title": "PublicVariantUnavailableError"
    }
  }
}

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/helena-bio-public-variant-unavailable-response"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.