← 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 patient-level cardiovascular risk factors and biomarkers for ML and outcomes research.

Claims

claims

Synthetic patient-level rows with fields: patient_id, age, sex, diagnosis_code, procedure_code, claim_amount, ….

claims_utilization

Synthetic patient-level rows with fields: patient_id, age, sex, diagnosis_code, procedure_code, claim_amount, ….

Clinical trial

clinical_trial_outcomes

Synthetic patient-level rows with fields: patient_id, age, sex, trial_arm, baseline_value, endpoint_value, ….

EHR

ehr

Synthetic patient-level rows with fields: patient_id, visit_date, age, sex, diagnosis, medication, ….

Healthcare

diabetes_hba1c_trial

Synthetic patient-level rows with fields: patient_id, age, sex, treatment_group, baseline_measure, outcome_measure.

Hospital

hospital_readmission

Synthetic patient-level rows with fields: patient_id, age, sex, admission_diagnosis, discharge_disposition, readmission_30d.

Metabolic

metabolic_cohort

Synthetic patient-level metabolic and intervention outcomes for clinical and ML research.

metabolic_disease

Synthetic patient-level metabolic and intervention outcomes for clinical and ML research.

metabolic_outcomes_trial

Synthetic patient-level metabolic and intervention outcomes for clinical and ML research.

Oncology

oncology_survival_trial

Synthetic patient-level rows with fields: patient_id, age, sex, treatment_arm, survival_time, event_observed.

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