5-minute quickstart

You’ll get from zero to a returned simulation in about five minutes. The API is available in sandbox and production; this walkthrough uses sandbox.

1. Get an API key

Request sandbox access — the key is issued instantly.

Don’t have an account?

Sandbox is free. 100 simulations / month. No credit card.

Get sandbox key

2. Make your first call

The integration surface today is the REST API. Idiomatic SDKs for TypeScript, Python, and Go are generated by Stainless and publish during the v1.0 launch window — until then, call the API directly from any HTTP client (see SDKs for the per-language roadmap). Two ways to mint a simulation: pass an explicit workflow_id (browse the catalog at /dashboard/workflows), or hand the auto-router a natural-language question and let Simulix pick the workflow for you. Pass the same Idempotency-Key on retry to keep the request safe.

curl -X POST https://api.simulix.com/v1/simulations
  -H "Authorization: Bearer sk_test_..."
  -H "Content-Type: application/json"
  -H "Idempotency-Key: f3a1..."
  -d '{"workflow_id":"cdc_nhis_adult_smoking","agent_count":200,"scenario_context":{"region":"US"}}'

3. Inspect the response

The response is structured JSON — no narrative, no charts, no HTML. Your code acts on aggregate, segments, and (optionally) per-agent rationales.

{
  "id": "sim_01HXA6NBFK",
  "workflow_id": "cdc_nhis_adult_smoking",
  "status": "completed",
  "aggregate": {
    "yes_rate": 0.234,
    "confidence_ci_95": [0.21, 0.26],
    "n": 200
  },
  "segments": [ /* 15 items */ ],
  "rounds": [ /* 3 rounds */ ],
  "accuracy": { "confirm_mean": 0.948, "k": 3 }
}

You’re done.

Your first call came back. Everything else is incremental — different workflows, bigger populations, and hooking simulations into your product workflow via webhooks.

4. Production webhooks (optional)

For async simulations (>500 agents), subscribing a webhook avoids polling. See Webhooks.

Concepts / Workflows