families

Create family + sessions from individual single-sample VCFs (atomic)

Atomically create family + N sessions from individual single-sample VCFs.

Flow:

  1. Validate inheritance_hypothesis, family_role, affected_status per member.
  2. For each member: parse VCF header to confirm single-sample (reject multi-sample VCFs with 400 + redirect to /families/from-joint-vcf).
  3. Build session_specs with vcf_sample_name extracted from each VCF (single sample per file). vcf_mode set to "separate" via metadata.
  4. Call SO atomic endpoint POST /internal/families/with-sessions.
  5. Return family + session_ids.

Atomicity guaranteed by SO transaction layer.

HELIX-CR-2026-FAMILY-FRONTEND-001 Phase 3-B.

post/api/v1/families/from-separate-vcfs

Request

  • Base URL: https://api.helena.bio (the document declares no server; this is the origin it was published from)
  • URL: https://api.helena.bio/api/v1/families/from-separate-vcfs
  • Auth: HTTP bearer

Request body

family_namestring nullable
family_notesstring nullable
inheritance_hypothesisstring nullable
filtering_presetstring

Quality filtering preset. Controls which low-quality variants are removed before annotation. Options: strict (default, quality>=30/depth>=20/GQ>=30), balanced (20/15/20), permissive (10/10/10), custom.

Response

Successful Response

session_idsstring[] required

Changes

No recorded changes to this operation across all 1 revision of this API.