SIMDATA

GETTING STARTED

Quick start

Get your first synthetic record in under two minutes.

Step 1: Obtain an API key

If you have not already created an account, sign up for free. Every account receives promotional starter credit. Then navigate to API Keys and click Create API key.

API secrets (starting with sk_live_) are shown only once upon creation. Copy and store them securely in your secret store or environment variable.

Step 2: Generate a JSON record

Run the following curl command in your terminal:

curl -H "Authorization: Bearer $SIMHEALTH_API_KEY" \
  -H "Accept: application/json" \
  "https://simdata.interoperabilitypro.com/v1/random/person?count=1&seed=1842"

Step 3: Test reproducibility

Run the exact same command a second time. Because the seed (1842) is identical, the generated record (name, birthdate, identifier) will be identical. Changing the seed will deterministically draw a different record.

Step 4: Generate bulk Avro

Omit the Accept: application/json header to stream Avro Object Container Files directly to disk:

curl -H "Authorization: Bearer $SIMHEALTH_API_KEY" \
  "https://simdata.interoperabilitypro.com/v1/random/person?count=10000&seed=1842" -o persons.avro