get_reads
Retrieve alignments overlapping a genomic interval from indexed BAM/CRAM files, applying flag and mapping-quality filters; provide a matching reference for CRAM unless self-contained.
Instructions
Alignments overlapping an interval from indexed BAM/CRAM. Flag filters follow samtools -f/-F. CRAM needs a matching reference unless self-contained. Available for: bam, cram.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| file | Yes | ||
| interval | Yes | ||
| reference | No | ||
| max_records | No | Lower the record limit. | |
| exclude_flags | No | ||
| require_flags | No | ||
| include_sequence | No | ||
| min_mapping_quality | No |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| data | No | ||
| error | No | Set when status is error. | |
| errors | No | Per-source failures in partial results. | |
| limits | No | ||
| status | Yes | ||
| warnings | No | ||
| operation | Yes | ||
| provenance | No | ||
| truncation | No | ||
| source_status | No | ||
| schema_version | No | 1 | |
| metadata_omitted | No | Entries dropped from provenance/source_status/errors/warnings (or text shortened) to fit max_response_bytes. Absent when metadata is complete. |