API Docs

FlashVCF API traffic is exposed at /fv/api/v1 and protected by API key auth. Auth0 paths stay outside /fv (for example /auth/auth0/callback).

Manage API Key

1 — Submit the analysis

The --progress-bar flag shows upload progress — useful for large VCF files. The response arrives only after the file is fully uploaded and the annotation job is enqueued.

2 — Poll until annotation finishes

The submission response includes a case_id. Replace <CASE_ID> with that value and GET /fv/api/v1/analyses/<CASE_ID> every 30 seconds until annotation_status is done.

Example response

{
  "status":            "completed",
  "upload_status":     "indexed",
  "annotation_status": "done",
  "has_annotated":     true,
  "queue_depth":       0
}

Field	Values	Meaning
status	pending · uploaded · running · completed	Overall case lifecycle.
upload_status	pending · uploaded · indexed · failed	VCF file processing stage.
annotation_status	pending · scoring · running · done · failed	done means the annotated VCF is ready and results are available.
has_annotated	true / false	Annotated VCF file exists on disk — confirms pipeline output is present.
queue_depth	integer	Current job queue depth (informational).

If annotation_status is failed, open the case in the UI to see the error detail.

3 — Download annotated VCF

Once annotation_status is done, download the annotated VCF file — the same file used to render the explore and results views. Replace <CASE_ID> with the case_id from the submission response.

Returns a text/plain file attachment. Returns 404 if annotation has not finished yet.