CreateFamilyFromSeparateVcfsRequest

POST /api/v1/families/from-separate-vcfs request body. Use case: lab uploads 3 individual single-sample VCFs (proband, father, mother), each with one sample. Less common clinically than joint VCF (CellGenetics primarily uses joint), but supported.

BioinformaticsGenomicsClinicalHealthcareData Science

Properties

Name Type Description
family_name object
family_notes object
inheritance_hypothesis object
members array Exactly 3 member specs: proband, father, mother. HELIX-CR-2026-TRIO-GVCF-WIRING-001 / Jules review cycle 2 B4b -- a trio is exactly three members. Quad / extended-pedigree analysis is a separate futur
filtering_preset string 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
View JSON Schema on GitHub

JSON Schema

helena-bio-create-family-from-separate-vcfs-request-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/helena-bio/json-schema/helena-bio-create-family-from-separate-vcfs-request-schema.json",
  "title": "CreateFamilyFromSeparateVcfsRequest",
  "description": "POST /api/v1/families/from-separate-vcfs request body.\n\nUse case: lab uploads 3 individual single-sample VCFs (proband, father,\nmother), each with one sample. Less common clinically than joint VCF\n(CellGenetics primarily uses joint), but supported.",
  "x-generated": "2026-11-10",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/helena-bio-families-api-openapi.yml#/components/schemas/CreateFamilyFromSeparateVcfsRequest",
  "properties": {
    "family_name": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Family Name"
    },
    "family_notes": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Family Notes"
    },
    "inheritance_hypothesis": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Inheritance Hypothesis"
    },
    "members": {
      "items": {
        "$ref": "#/$defs/SeparateVcfMemberSpec"
      },
      "type": "array",
      "maxItems": 3,
      "minItems": 3,
      "title": "Members",
      "description": "Exactly 3 member specs: proband, father, mother. HELIX-CR-2026-TRIO-GVCF-WIRING-001 / Jules review cycle 2 B4b -- a trio is exactly three members. Quad / extended-pedigree analysis is a separate future CR with its own orchestrator and its own de novo mathematics; it is not an N-range widening of this endpoint."
    },
    "filtering_preset": {
      "type": "string",
      "title": "Filtering Preset",
      "description": "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.",
      "default": "strict"
    }
  },
  "type": "object",
  "required": [
    "members"
  ],
  "$defs": {
    "SeparateVcfMemberSpec": {
      "properties": {
        "vcf_file_path": {
          "type": "string",
          "title": "Vcf File Path"
        },
        "family_role": {
          "type": "string",
          "title": "Family Role"
        },
        "affected_status": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "title": "Affected Status"
        },
        "case_label": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "title": "Case Label"
        },
        "sex": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "title": "Sex"
        },
        "staging_session_id": {
          "anyOf": [
            {
              "type": "string",
              "format": "uuid"
            },
            {
              "type": "null"
            }
          ],
          "title": "Staging Session Id"
        },
        "clinical_profile": {
          "anyOf": [
            {
              "additionalProperties": true,
              "type": "object"
            },
            {
              "type": "null"
            }
          ],
          "title": "Clinical Profile"
        }
      },
      "type": "object",
      "required": [
        "vcf_file_path",
        "family_role"
      ],
      "title": "SeparateVcfMemberSpec",
      "description": "Single member spec for separate-mode trio upload.\n\nEach member is a single-sample VCF (1 sample per file). Distinct from\nJointVcfSampleMapping which references a sample WITHIN a multi-sample VCF.\n\nPhase 3-B: sex field added (Jules N1 review 2026-05-08) for inheritance\nanalysis. Optional with WARN log on emit if NULL (architectural lock).\n\nHELIX-CR-2026-FAMILY-CLINICAL-PIPELINE-ARCHITECTURE-001: added\nclinical_profile for proband HPO transport from /create/trio flow.\nFrontend supplies a non-None dict only on the proband member;\nparent members carry None. SO writes NDJSON before dispatch."
    }
  }
}

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-create-family-from-separate-vcfs-request"
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.