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.

Endpoints

The table below is the daily working reference for partner engineers.

Orders and delivery files

POST/v1/orders

Create a 30x sequencing order.

Request
Idempotency-Key header plus type, client_name, user_reference, retention, deliverables, customer, shipping_address.
Returns
order_id, status, activation_id, activation_url, selected deliverables, price snapshot.
GET/v1/orders

List recent orders.

Request
Optional limit query param, 1 to 100.
Returns
data array of order summaries.
GET/v1/orders/{order_id}

Read order status and activation details.

Request
Path parameter order_id.
Returns
Order status, status label, shipment, activation details, retention, deliverables.
GET/v1/orders/{order_id}/events

Read order lifecycle events.

Request
Path parameter order_id.
Returns
data array of event_id, event_type, status, payload, created_at.
GET/v1/orders/{order_id}/shipment

Read shipment carrier and tracking data.

Request
Path parameter order_id.
Returns
carrier, tracking_number, tracking_url, current status when available.
GET/v1/orders/{order_id}/files

Return signed links for completed deliverables.

Request
Path parameter order_id.
Returns
Signed URLs for requested .genome, VCF, and/or FASTQ files.

Uploads, conversions, and genomes

POST/v1/uploads/vcf

Upload an existing VCF.

Request
Multipart file upload.
Returns
upload_id, filename, status.
POST/v1/conversions

Convert an uploaded VCF into a .genome bundle.

Request
source_type=vcf and upload_id.
Returns
conversion_id, status, estimated completion metadata.
GET/v1/genomes

List hosted genomes.

Request
Optional limit query param, 1 to 100.
Returns
data array of genome runtime metadata.
GET/v1/genomes/{genome_id}

Read hosted genome runtime metadata.

Request
Path parameter genome_id.
Returns
genome_id, source, bundle_version, interpretation_version, retention, hosted status, timestamps.
GET/v1/genomes/{genome_id}/bundle

Download a signed .genome bundle link.

Request
Path parameter genome_id.
Returns
Signed download URL and expiry.
PATCH/v1/genomes/{genome_id}/retention

Change whether the genome is hosted or deleted.

Request
retention=hosted_runtime or delete_after_30_days.
Returns
Updated retention metadata.

Interpretations, panels, Q&A, and advanced context

GET/v1/genomes/{genome_id}/interpretations/latest

Read the latest interpretation record.

Request
Path parameter genome_id.
Returns
interpretation_id, version, status, summary, created_at.
GET/v1/genomes/{genome_id}/interpretations/latest/artifact

Read the full underlying interpretation artifact.

Request
Path parameter genome_id.
Returns
Structured variant, score, PGx, citation, provenance, and limitation data.
GET/v1/panels

List genetic insight panel definitions.

Request
No request body.
Returns
Panel IDs, descriptions, covered domains, evidence boundaries, and limitations.
POST/v1/genomes/{genome_id}/panels/{panel_id}/build

Build a curated genetic insight panel.

Request
Path parameters genome_id and panel_id.
Returns
panel_result_id, summary, sections with user_findings, evidence levels, citations, limitations, and clinical boundary.
POST/v1/genomes/{genome_id}/ask

Ask a bounded natural-language genome question.

Request
question and response_length=low, medium, or high.
Returns
Natural-language answer, citations, safety metadata, token/cost metadata.
POST/v1/context/build

Advanced: build deterministic structured context.

Request
genome_id, domain, detail_level.
Returns
context_id, summary, structured_findings, citations, interpretation_version.

Webhooks, usage, and staging controls

POST/v1/webhooks

Register lifecycle webhook endpoints.

Request
url and event_types.
Returns
webhook_id, event_types, secret_preview. Secret is shown once.
GET/v1/webhooks

List webhook endpoints.

Request
No request body.
Returns
data array of registered webhook endpoints.
DELETE/v1/webhooks/{webhook_id}

Disable a webhook endpoint.

Request
Path parameter webhook_id.
Returns
Disabled webhook endpoint record.
GET/v1/usage

Inspect metered events.

Request
Optional limit and event_type query params.
Returns
data array of usage events and metadata.
POST/v1/test/orders/{order_id}/advance

Advance a staging-only sandbox order.

Request
status.
Returns
Updated order. Staging only.
POST/v1/test/genomes/seed

Seed the synthetic staging genome fixture.

Request
No request body.
Returns
Synthetic genome, interpretation, and file fixture status. Staging only.
GET/v1/test/genomes

List seeded synthetic staging genomes.

Request
No request body.
Returns
Synthetic genome IDs and fixture metadata. Staging only.

Common Responses

These examples show the fields most clients build on directly.

Order

Order response
{
  "order_id": "ord_01JZ8N8A4P2Y",
  "type": "wgs_30x",
  "client_name": "Acme Health",
  "user_reference": "user_123",
  "status": "created",
  "status_label": "Order created",
  "activation_id": "ACT-7HD2-9QK4",
  "activation_url": "https://sample.bio/activate/ACT-7HD2-9QK4",
  "deliverables": ["genome_bundle", "vcf", "fastq"],
  "retention": "hosted_runtime",
  "price_cents": 69900,
  "currency": "usd"
}

Panel

Panel response
{
  "panel_result_id": "pan_9y2m1q",
  "panel_id": "nutrition_micronutrients",
  "genome_id": "gen_test_nutrition_001",
  "interpretation_version": "2026.05.1",
  "summary": "This panel found user-specific nutrition and metabolic context with moderate evidence. It is suitable for an evidence summary card, not diagnosis or treatment advice.",
  "sections": [
    {
      "title": "Metabolic Context",
      "summary": "1 user-specific finding relevant to glucose handling.",
      "interpretation": "For this user, TCF7L2 rs7903146 CT is relevant to glucose handling and diet-adjacent metabolic context.",
      "evidence_level": "moderate",
      "user_findings": [
        {
          "gene": "TCF7L2",
          "variant_id": "rs7903146",
          "user_result": "CT",
          "interpretation": "The user carries one T allele at rs7903146, a common variant associated with glucose and type 2 diabetes risk in population studies.",
          "relevance": "Useful as inherited metabolic context alongside diet, labs, history, and clinician review.",
          "evidence_basis": "Moderate evidence based on GWAS Catalog and gnomAD."
        }
      ]
    }
  ],
  "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 glucose, insulin sensitivity, diet, or symptoms.",
    "This panel does not diagnose diabetes or recommend a nutrition protocol."
  ],
  "clinical_boundary": "Use as inherited context for education and clinician review. Do not present as diagnosis, treatment, or dosing guidance."
}

Natural-language answer

Q&A response
{
  "answer_id": "ans_4az91r",
  "genome_id": "gen_test_nutrition_001",
  "response_length": "medium",
  "answer": "This genome can support peptide-related decision making indirectly. The relevant genetic context is around metabolic handling, inflammation and recovery pathways, connective tissue repair, cardiovascular safety, endocrine signaling, and medication response. It should be presented as inherited pathway context for clinician review, not as a peptide prescription, deficiency assessment, or yes/no treatment recommendation.",
  "citations": [
    {
      "source": "interpretation_artifact",
      "version": "2026.05.1"
    }
  ],
  "safety": {
    "clinical_advice": false,
    "requires_clinician_review": true
  },
  "usage": {
    "input_tokens": 2190,
    "output_tokens": 142,
    "model_name": "gpt-5.5"
  }
}

Advanced context

Context response
{
  "context_id": "ctx_7v1a9k",
  "genome_id": "gen_test_nutrition_001",
  "domain": "nutrition",
  "detail_level": "standard",
  "summary": "Nutrition context includes folate handling, caffeine response, lactose persistence, lipid metabolism, and selected cardiometabolic markers.",
  "structured_findings": [
    {
      "id": "nutr_folate_mthfr",
      "title": "Folate and methylation context",
      "evidence_level": "moderate",
      "genes": ["MTHFR", "MTR", "MTRR"],
      "client_display": "Show as inherited folate-pathway context, not as a diagnosis or supplement instruction."
    }
  ],
  "citations": [
    {
      "source": "ClinVar",
      "accessed_at": "2026-05-20",
      "url": "https://www.ncbi.nlm.nih.gov/clinvar/"
    }
  ],
  "interpretation_version": "2026.05.1"
}
Use the interpretation record for quick status and version display. Use panel results for structured product UI, Q&A for plain-English explanation, and context responses only when you need deterministic grounding artifacts.