> ## Documentation Index
> Fetch the complete documentation index at: https://docs.tetryx.io/llms.txt
> Use this file to discover all available pages before exploring further.

# API Reference

> Lynx coordinator HTTP API

## Base URL

```
https://api.lynx.tetryx.io
```

## Authentication

Authentication is not yet implemented. All endpoints are currently open. See [Authentication](/auth/overview) for the planned model.

## Endpoints

<Columns cols={2}>
  <Card title="Health" icon="heart-pulse" href="/api-reference/health/healthz">
    `GET /healthz` — API liveness check
  </Card>

  <Card title="Jobs" icon="list-check" href="/api-reference/jobs/submit-jobs">
    Submit batches and inspect individual jobs and results
  </Card>

  <Card title="Batches" icon="layer-group" href="/api-reference/batches/list-batches">
    Track batch progress and retrieve aggregate results
  </Card>

  <Card title="Runners" icon="circle-nodes" href="/api-reference/runners/list-runners">
    Inspect your runner pool and control drain/resume
  </Card>
</Columns>

## Available endpoints

| Method | Path                          | Description       |
| ------ | ----------------------------- | ----------------- |
| `GET`  | `/healthz`                    | API health        |
| `POST` | `/jobs`                       | Submit a batch    |
| `GET`  | `/jobs`                       | List jobs         |
| `GET`  | `/jobs/{job_id}`              | Get a job         |
| `GET`  | `/jobs/{job_id}/results`      | Get job results   |
| `GET`  | `/batches`                    | List batches      |
| `GET`  | `/batches/{batch_id}`         | Get batch status  |
| `GET`  | `/batches/{batch_id}/results` | Get batch results |
| `GET`  | `/runners`                    | List runners      |
| `GET`  | `/runners/{runner_id}`        | Get a runner      |
| `POST` | `/runners/{runner_id}/drain`  | Drain a runner    |
| `POST` | `/runners/{runner_id}/resume` | Resume a runner   |