← Back to Home

Quickstart

Get started with Syntherx in minutes.

1. Get API Key

Sign up at Syntherx to create an account. After completing the signup flow, you'll be guided through a Stripe checkout to subscribe to an API plan. Once your payment is confirmed, your API key will be generated and displayed in your dashboard. Copy it and keep it secure — you'll use it to authenticate all API requests.

2. Make Your First Request

Use the /datasets/generate endpoint to create a synthetic dataset. Pass your API key in the x-api-key header:

curl -X POST https://api.syntherx.com/datasets/generate \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"blueprint":"diabetes_hba1c_trial","n_patients":100}'

Available Blueprints

Syntherx provides a set of predefined dataset blueprints across clinical domains. Each blueprint defines the structure, variables, and relationships used to generate synthetic datasets.

Cardiology

cardiology_outcomes

Synthetic cardiovascular outcomes trial. Includes MACE (major adverse cardiovascular events), LDL, blood pressure, and cardiac biomarkers.

Diabetes

diabetes_hba1c_trial

Synthetic type 2 diabetes trial with HbA1c as primary endpoint. Includes baseline demographics, visit schedule at weeks 0/12/24/52, and biomarker progression.

EHR

ehr_longitudinal

Synthetic longitudinal electronic health record cohort. Includes encounter types, diagnosis codes, and lab values over time for temporal analysis.

Metabolic

metabolic_disease

Synthetic metabolic disease cohort with HbA1c, LDL, and lab biomarkers. Designed for diabetes, dyslipidemia, and metabolic syndrome research.

Oncology

oncology_survival_trial

Synthetic oncology trial with overall survival and progression-free survival endpoints. Designed for cancer treatment efficacy simulation.

Survival

survival_analysis

Synthetic survival analysis dataset with time-to-event endpoints. Includes treatment groups, tumor staging, survival time, and event indicators for Kaplan-Meier and Cox regression.

Clinical Trial

clinical_trial

Generic synthetic clinical trial with baseline and outcome measures. Designed for treatment efficacy comparison and primary endpoint analysis.

Healthcare Utilization

claims_utilization

Synthetic healthcare claims and utilization dataset. Includes encounter types, admission diagnoses, ICD codes, and discharge dispositions for utilization analysis.

hospital_readmission

Synthetic dataset for 30-day hospital readmission prediction. Includes admission characteristics, discharge disposition, and readmission outcomes.

Python example using the public API:

import requests

res = requests.post(
  "https://api.syntherx.com/datasets/generate",
  json={
    "blueprint": "oncology_survival_trial",
    "n_patients": 100
  }
)

print(res.json()["download_url"])

3. Download Dataset

The API returns a JSON response containing a download_url field. This is a signed URL that provides temporary, secure access to your generated dataset file. Use a GET request to this URL — or open it in a browser — to download the dataset. Signed URLs expire after a set time, so download promptly.

Response Example

{
  "download_url": "...",
  "rows": 100,
  "blueprint": "diabetes_hba1c_trial"
}

Docs Navigation