Quickstart

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}'

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"
}