How it works
You submit a batch of simulation runs to the Lynx API. Lynx distributes those runs across your runner pool. Each runner picks up jobs, executes your simulation, and reports results back. You poll the API for status and retrieve results when complete.Submit
POST /jobs with your simulation config and run count. Lynx generates the parameter samples and queues the jobs.Execute
Your runners pick up jobs from the queue, run your simulation, and report results.
Collect
Poll batch or job status via the API. Fetch results when jobs reach a terminal state.
Base URL
Key concepts
| Term | Meaning |
|---|---|
batch | A submitted collection of jobs — one Monte Carlo study |
job | One individual simulation run within a batch |
runner | A worker process you deploy that picks up and executes jobs |
What is available today
- Submit Monte Carlo batches via
POST /jobs - Inspect batch and job status via the read APIs
- Manage your runner pool: inspect, drain, and resume runners
- Retry handling: failed jobs are automatically retried up to
max_retries
Get started
Quickstart
Submit your first batch and verify job results in minutes.
Runners
Learn how to deploy and manage your runner pool.
Jobs and Batches
Understand the job and batch model.
API Reference
Full HTTP API reference.