---
title: "Get a download summary (preview) of a genome data package by genome assembly accession"
method: POST
path: "/genome/download_summary"
tags: ["Genome"]
---

# Get a download summary (preview) of a genome data package by genome assembly accession

`POST /genome/download_summary`

Get a downlaod summary (preview) of a genome data package, including counts and file sizes, in JSON format.

## Request body

- V2AssemblyDatasetRequest
  - `accessions` string[]
  - `chromosomes` string[]
  - `include_annotation_type` V2AnnotationForAssemblyType[]
  - `hydrated` 'FULLY_HYDRATED' | 'DATA_REPORT_ONLY'
  - `include_tsv` boolean

## Response `200`

A successful response

- V2DownloadSummary
  - `record_count` integer
  - `assembly_count` integer
  - `resource_updated_on` string, date-time
  - `hydrated` V2DownloadSummaryHydrated
    - `estimated_file_size_mb` integer
    - `url` string
    - `cli_download_command_line` string
  - `dehydrated` V2DownloadSummaryDehydrated
    - `estimated_file_size_mb` integer
    - `url` string
    - `cli_download_command_line` string
    - `cli_rehydrate_command_line` string
  - `errors` V2reportsError[]
    - `assembly_error_code` 'UNKNOWN_ASSEMBLY_ERROR_CODE' | 'INVALID_BIOPROJECT_IDS' | 'NO_ASSEMBLIES_FOR_BIOPROJECTS' | 'INVALID_TAXON' | 'MISSING_SEARCH_FIELD' | 'INVALID_BIOSAMPLE_IDS' | 'NO_ASSEMBLIES_FOR_BIOSAMPLE_IDS' | 'NO_ASSEMBLIES_FOR_ASSEMBLY_NAMES' | 'INVALID_WGS_ACCESSIONS' | 'NO_ASSEMBLIES_FOR_WGS_ACCESSIONS'
    - `gene_error_code` 'UNKNOWN_GENE_ERROR_CODE' | 'INCOMPLETE_LOOKUP_SYMBOL' | 'INVALID_TAXON_GENE_ARGUMENT'
    - `organelle_error_code` 'UNKNOWN_ORGANELLE_ERROR_CODE' | 'INVALID_ORGANELLE_TAXON' | 'NO_ORGANELLES_FOR_ACCESSION'
    - `virus_error_code` 'UNKNOWN_VIRUS_ERROR_CODE'
    - `taxonomy_error_code` 'UNKNOWN_TAXONOMY_ERROR_CODE' | 'INVALID_TAXONOMY_TAXON'
    - `sequence_error_code` 'UNKNOWN_SEQUENCE_ERROR_CODE' | 'INVALID_SEQUENCE_ACCESSION'
    - `reason` string
    - `message` string
    - `invalid_identifiers` string[]
  - `messages` V2reportsMessage[]
    - `error` V2reportsError
      - `assembly_error_code` 'UNKNOWN_ASSEMBLY_ERROR_CODE' | 'INVALID_BIOPROJECT_IDS' | 'NO_ASSEMBLIES_FOR_BIOPROJECTS' | 'INVALID_TAXON' | 'MISSING_SEARCH_FIELD' | 'INVALID_BIOSAMPLE_IDS' | 'NO_ASSEMBLIES_FOR_BIOSAMPLE_IDS' | 'NO_ASSEMBLIES_FOR_ASSEMBLY_NAMES' | 'INVALID_WGS_ACCESSIONS' | 'NO_ASSEMBLIES_FOR_WGS_ACCESSIONS'
      - `gene_error_code` 'UNKNOWN_GENE_ERROR_CODE' | 'INCOMPLETE_LOOKUP_SYMBOL' | 'INVALID_TAXON_GENE_ARGUMENT'
      - `organelle_error_code` 'UNKNOWN_ORGANELLE_ERROR_CODE' | 'INVALID_ORGANELLE_TAXON' | 'NO_ORGANELLES_FOR_ACCESSION'
      - `virus_error_code` 'UNKNOWN_VIRUS_ERROR_CODE'
      - `taxonomy_error_code` 'UNKNOWN_TAXONOMY_ERROR_CODE' | 'INVALID_TAXONOMY_TAXON'
      - `sequence_error_code` 'UNKNOWN_SEQUENCE_ERROR_CODE' | 'INVALID_SEQUENCE_ACCESSION'
      - `reason` string
      - `message` string
      - `invalid_identifiers` string[]
    - `warning` V2reportsWarning
      - `gene_warning_code` 'UNKNOWN_GENE_WARNING_CODE' | 'ACCESSION_VERSION_MISMATCH' | 'REPLACED_GENE_ID' | 'DISCONTINUED_GENE_ID' | 'UNRECOGNIZED_GENE_ID' | 'UNRECOGNIZED_GENE_SYMBOL' | 'UNRECOGNIZED_ACCESSION' | 'UNRECOGNIZED_TAX_TOKEN' | 'NO_GENE_ANNOTATION_FOUND' | 'ABOVE_SPECIES_TAXON'
      - `reason` string
      - `message` string
      - `replaced_id` V2reportsWarningReplacedId
        - `requested` string
        - `returned` string
      - `unrecognized_identifier` string
  - `available_files` V2DownloadSummaryAvailableFiles
    - `all_genomic_fasta` V2DownloadSummaryFileSummary
      - `file_count` integer
      - `size_mb` number, float
    - `genome_gff` V2DownloadSummaryFileSummary
      - `file_count` integer
      - `size_mb` number, float
    - `genome_gbff` V2DownloadSummaryFileSummary
      - `file_count` integer
      - `size_mb` number, float
    - `rna_fasta` V2DownloadSummaryFileSummary
      - `file_count` integer
      - `size_mb` number, float
    - `prot_fasta` V2DownloadSummaryFileSummary
      - `file_count` integer
      - `size_mb` number, float
    - `genome_gtf` V2DownloadSummaryFileSummary
      - `file_count` integer
      - `size_mb` number, float
    - `cds_fasta` V2DownloadSummaryFileSummary
      - `file_count` integer
      - `size_mb` number, float
    - `sequence_report` V2DownloadSummaryFileSummary
      - `file_count` integer
      - `size_mb` number, float
    - `annotation_report` V2DownloadSummaryFileSummary
      - `file_count` integer
      - `size_mb` number, float

## Other responses

- `default` — An unexpected error response.

---

[API](https://skmtc.net/ncats/apis/ncbi-datasets-api.md) · [All operations](https://skmtc.net/ncats/apis/ncbi-datasets-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/ncats/ncbi-datasets-api/versions/e5d4400c8e5d/schema)
