families

Create family + sessions from joint VCF (atomic)

Atomically create family + N sessions from joint VCF.

Flow:

  1. Parse VCF header to get actual sample names
  2. Validate user-provided sample_role_mapping against actual samples (Case A/B/C/D per CR NB-6)
  3. Call SO atomic endpoint POST /internal/families/with-sessions
  4. Return family + session IDs

Atomicity guaranteed by SO transaction layer (Jules point 4).

HEL-CR-FAMILY-EPIC-1-001

post/api/v1/families/from-joint-vcf

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-joint-vcf
  • Auth: HTTP bearer

Request body

vcf_file_pathstring required
family_namestring nullable
family_notesstring nullable
inheritance_hypothesisstring nullable
staging_session_idstring uuid 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.