API referencehttps://staging.api.genome.computerhttps://api.genome.computer
Endpoint reference.
Methods, paths, request fields, and response shapes for the genome.computer API. Endpoints are shared by staging and production unless marked as staging-only.
Authentication
Send the API key in the Authorization header. Staging keys start with gc_test_. Production keys start with gc_live_.
Header
HTTP header
Authorization: Bearer $GC_API_KEY
OpenAPI
The API also exposes machine-readable OpenAPI JSON and Swagger UI for internal testing.
Creates a 30x whole-genome sequencing order and returns activation details. Send an Idempotency-Key header (required in production) so retries are safe.
Parameter
In
Type
Required
Description
idempotency-key
header
string
No
Idempotency key. Required in production; retries with the same key+body are deduplicated.
type
body
string
Yes
Assay type. Only 30x whole-genome sequencing is offered. Allowed: wgs_30x.
client_name
body
string
No
Label for the end customer shown on internal dashboards.
user_reference
body
string
No
Your own identifier for this order; echoed back on reads and webhooks.
retention
body
string
No
How long sequencing artifacts are retained. Allowed: delete_after_30_days, hosted_runtime. Default: "delete_after_30_days".
deliverables
body
string[]
No
Which artifacts to deliver for the order. Default: ["genome_bundle","vcf","fastq"].
Level of structured detail. Allowed: brief, standard, deep. Default: "standard".
Response status codes: 201, 400, 404, 409.
Webhooks
GET/v1/webhooks
List registered webhook endpoints.
Scope: webhooks:read
No request parameters.
Response status codes: 200.
POST/v1/webhooks
Register a lifecycle webhook endpoint.
Scope: webhooks:write
Endpoints may not target private or local hosts; production endpoints must be HTTPS. Supported event types: order.created, order.payment_pending, order.paid, order.kit_preparing, order.kit_shipped, order.kit_delivered, order.sample_registered, order.sample_returned, order.sample_received, order.lab_processing, order.sequencing, order.bioinformatics_processing, order.genome_bundle_generating, order.completed, order.failed, order.cancelled, conversion.completed, genome.created, interpretation.updated, context.generated, panel.generated.
Parameter
In
Type
Required
Description
url
body
string
Yes
HTTPS endpoint that will receive events.
description
body
string
No
Human-readable label.
event_types
body
string[]
No
Event types to subscribe to. Defaults to all. Default: ["order.created","order.payment_pending","order.paid","order.kit_preparing","order.kit_shipped","order.kit_delivered","order.sample_registered","order.sample_returned","order.sample_received","order.lab_processing","order.sequencing","order.bioinformatics_processing","order.genome_bundle_generating","order.completed","order.failed","order.cancelled","conversion.completed","genome.created","interpretation.updated","context.generated","panel.generated"].
Response status codes: 201, 400.
DELETE/v1/webhooks/{webhookId}
Disable a webhook endpoint.
Scope: webhooks:write
Parameter
In
Type
Required
Description
webhookId
path
string
Yes
Public webhook id (wh_...).
Response status codes: 200, 404.
Usage
GET/v1/usage
List metered usage events.
Scope: usage:read
Parameter
In
Type
Required
Description
limit
query
integer
No
Maximum events to return. Default: 100.
event_type
query
string
No
Filter by usage event type.
Response status codes: 200.
GET/v1/usage/rollups
List daily usage rollups (up to 90 days).
Scope: usage:read
No request parameters.
Response status codes: 200.
Billing
GET/v1/billing/account
Read the billing account.
Scope: billing:read or usage:read
No request parameters.
Response status codes: 200.
PATCH/v1/billing/account
Update the billing account.
Scope: billing:write
Parameter
In
Type
Required
Description
mode
body
string
Yes
Billing mode for the account. Allowed: card_on_file, enterprise_prepaid, invoice_arrears.
stripe_customer_id
body
string
No
stripe_payment_method_id
body
string
No
invoice_terms_days
body
integer
No
monthly_minimum_cents
body
integer
No
enterprise_upfront_credit_cents
body
integer
No
auto_charge
body
boolean
No
metadata
body
object
No
Response status codes: 200, 400.
GET/v1/billing/balance-transactions
List billing balance transactions.
Scope: billing:read or usage:read
No request parameters.
Response status codes: 200.
GET/v1/billing/periods
List billing periods.
Scope: billing:read or usage:read
No request parameters.
Response status codes: 200.
GET/v1/billing/periods/{yearMonth}/charges
Read charges for a billing period.
Scope: billing:read or usage:read
Parameter
In
Type
Required
Description
yearMonth
path
string
Yes
Billing period as YYYY-MM.
Response status codes: 200, 404.
POST/v1/billing/periods/{yearMonth}/finalize
Finalize a billing period into an invoice.
Scope: billing:write
Parameter
In
Type
Required
Description
yearMonth
path
string
Yes
Billing period as YYYY-MM.
Response status codes: 200, 400.
POST/v1/billing/periods/{yearMonth}/generate
Generate charges for a billing period.
Scope: billing:write
Parameter
In
Type
Required
Description
yearMonth
path
string
Yes
Billing period as YYYY-MM.
Response status codes: 200, 400.
API keys
GET/v1/api-keys
List API keys for the organisation.
Scope: api-keys:read
No request parameters.
Response status codes: 200.
DELETE/v1/api-keys/{apiKeyId}
Revoke an API key.
Scope: api-keys:write
Parameter
In
Type
Required
Description
apiKeyId
path
string
Yes
API key id (UUID).
Response status codes: 200, 404.
Staging
GET/v1/test/genomes
Seed and list the sandbox genome (staging keys only).
Scope: genomes:read
No request parameters.
Response status codes: 200, 403.
POST/v1/test/genomes/seed
Seed the sandbox genome (staging keys only).
Scope: genomes:write
No request parameters.
Response status codes: 201, 403.
POST/v1/test/orders/{orderId}/advance
Advance a sandbox order to a new status (staging keys only).
Scope: orders:write
Parameter
In
Type
Required
Description
orderId
path
string
Yes
Public order id (ord_...).
status
body
string
Yes
Target order status to transition the sandbox order to.
Response status codes: 200, 400, 404.
Common Responses
These examples show the fields most clients build on directly.
{"panel_result_id":"pan_9y2m1q","panel_id":"nutrition_diet_response","title":"Nutrition & Diet Response","genome_id":"gen_test_nutrition_001","interpretation_version":"2026.05.1","summary":"Inherited tendencies in how this user processes foods and drinks, with high-to-moderate evidence. Suitable for an evidence summary card, not diagnosis or treatment.","sections":[{"section_id":"food_drink_metabolism","title":"Food & Drink Metabolism","evidence_level":"high","findings":[{"id":"rs4988235","type":"variant","title":"MCM6 rs4988235","gene":"MCM6","variant_id":"rs4988235","result":{"genotype":"GA","alleles":["G","A"]},"result_label":"One copy of G and one copy of A","meaning":"The main lactase-persistence variant in European-ancestry populations; the persistence allele is associated with digesting dairy into adulthood. Separate persistence variants in African and Middle Eastern populations are not captured by this SNP, so a non-persistence call here does not rule out persistence in those ancestries.","evidence_level":"high","evidence":{"basis":"GWAS Catalog","clinical_review":"Review food & drink metabolism context alongside labs, history, medications, and clinician oversight.","validated_populations":["European"]}},{"id":"rs762551","type":"variant","title":"CYP1A2 rs762551","gene":"CYP1A2","variant_id":"rs762551","result":{"genotype":"AC","alleles":["A","C"]},"result_label":"One copy of A and one copy of C","meaning":"Associated with CYP1A2 inducibility and caffeine-metabolism rate; the *1F allele links to higher inducible activity in some studies. Smoking and other inducers also strongly affect CYP1A2, so genotype is only part of the picture.","evidence_level":"moderate","evidence":{"basis":"PharmGKB, GWAS Catalog","clinical_review":"Review food & drink metabolism context alongside labs, history, medications, and clinician oversight.","validated_populations":["broad"]}}]},{"section_id":"diet_composition","title":"Diet Composition Response","evidence_level":"moderate","findings":[{"id":"rs174537","type":"variant","title":"FADS1 rs174537","gene":"FADS1","variant_id":"rs174537","result":{"genotype":"GT","alleles":["G","T"]},"result_label":"One copy of G and one copy of T","meaning":"FADS1 is associated with the efficiency of converting plant ALA into long-chain omega-3 (EPA/DHA); some versions are associated with lower conversion in studies. Diet decisions should weigh intake, labs, and clinician guidance, not genotype alone.","evidence_level":"moderate","evidence":{"basis":"GWAS Catalog, gnomAD","clinical_review":"Review diet composition response context alongside labs, history, medications, and clinician oversight.","validated_populations":["broad"]}}]}],"citations":[{"source":"GWAS Catalog","url":"https://www.ebi.ac.uk/gwas/","accessed_at":"2026-05-20"},{"source":"gnomAD","url":"https://gnomad.broadinstitute.org/","accessed_at":"2026-05-20"}],"limitations":["DNA does not measure current folate, B12, homocysteine, or other nutrient levels.","This panel does not diagnose a deficiency or recommend a diet, dose, or supplement.","Genetic tendencies describe inherited likelihood, not current diet or symptoms."],"clinical_boundary":"Use as inherited context for education and clinician review. Do not present as diagnosis, treatment, or dosing guidance.","model_name":"deterministic-genetic-insight-panel-v1","created_at":"2026-05-21T10:24:13.000Z"}
Natural-language answer
Q&A response
{"answer_id":"ans_4az91r","genome_id":"gen_test_nutrition_001","question":"What does my DNA say about how I process caffeine?","response_length":"medium","answer":"For caffeine, the relevant finding is CYP1A2 rs762551, where you have one copy of A and one copy of C. That genotype is associated with CYP1A2 inducibility and caffeine-metabolism rate — the *1F allele is linked to higher inducible activity in some studies, leaning toward a faster-metabolizer pattern — but smoking and other inducers also strongly affect CYP1A2, so genotype is only part of the picture. Treat this as inherited context established mainly in broad populations, not a measurement of how you process caffeine today, and not medical advice. (Evidence: GWAS Catalog, PharmGKB.)","structured_findings":[{"id":"rs762551","title":"CYP1A2 rs762551","domain":"general","evidence_level":"moderate","summary":"Has one copy of A and one copy of C. Associated with CYP1A2 inducibility and caffeine-metabolism rate; the *1F allele links to higher inducible activity in some studies. Smoking and other inducers also strongly affect CYP1A2, so genotype is only part of the picture.","result":{"genotype":"AC","alleles":["A","C"]},"result_label":"One copy of A and one copy of C","meaning":"Associated with CYP1A2 inducibility and caffeine-metabolism rate; the *1F allele links to higher inducible activity in some studies. Smoking and other inducers also strongly affect CYP1A2, so genotype is only part of the picture.","validated_populations":["broad"]}],"citations":[{"source":"gwas_catalog","version":"2026.05-sandbox"},{"source":"pharmgkb","version":"2026.05-sandbox"}],"interpretation_version":"2026.05.1","safety":{"clinical_advice":false,"requires_clinician_review":true},"cost_cents":5,"currency":"usd","created_at":"2026-05-21T10:25:41.000Z"}
Advanced context
Context response
{"context_id":"ctx_7v1a9k","genome_id":"gen_test_nutrition_001","domain":"nutrition_diet_response","detail_level":"standard","summary":"Genome gen_test_nutrition_001 context for nutrition_diet_response. Bounded structured findings are included, each with the user's result and what it means. This is biological context for software use, not clinical diagnosis.","structured_findings":[{"id":"rs4988235","title":"MCM6 rs4988235","domain":"nutrition_diet_response","evidence_level":"high","summary":"Has one copy of G and one copy of A. The main lactase-persistence variant in European-ancestry populations; the persistence allele is associated with digesting dairy into adulthood.","result":{"genotype":"GA","alleles":["G","A"]},"result_label":"One copy of G and one copy of A","meaning":"The main lactase-persistence variant in European-ancestry populations; the persistence allele is associated with digesting dairy into adulthood. Other persistence variants in African and Middle Eastern populations are not captured by this SNP.","validated_populations":["European"]}],"citations":[{"source":"gwas_catalog","version":"2026.05-sandbox"}],"interpretation_version":"2026.05.1","cost_cents":5,"currency":"usd"}
Use the interpretation record for quick status and version display. Use panel results for structured product UI, Q&A for plain-English explanation, and the full interpretation artifact or context response only when you need lower-level provenance or deterministic grounding.