Skip to main content

Base URL

All API calls in this guide target:

1. Check API health

Expected:

2. Submit a batch

A batch submission tells Lynx how many simulation runs to create, what parameters to sample, and how to configure compute and telemetry.
Response:
Save the batch_id — you’ll use it to track progress.

3. Check batch status

The response includes a breakdown of jobs by status:

4. Start a runner

Runners are the workers that execute your jobs. Deploy the lynx-runner binary on your own hardware, pointed at the Lynx platform using the connection credentials from your onboarding.
Once the runner is connected, it will start picking up queued jobs automatically. You can verify it registered:
See Runner Deployment for full configuration options.

5. Fetch results

Once jobs are complete, retrieve results for the entire batch:
Or for a single job:

Next steps

Runner Deployment

Configure and scale your runner pool.

Jobs and Batches

Understand the full job lifecycle.

API Reference

Complete endpoint documentation.

Authentication

Planned authentication model.