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

# Quickstart

> Get your first forecast in under 5 minutes.

## 1. Get your API key

Contact the eomer.ai team to receive a Bearer token. Keys are issued per client
and can be rotated at any time without downtime.

## 2. Check the API is up

```bash theme={null}
curl https://eomer-api.onrender.com/health
```

Expected response:

```json theme={null}
{
  "status": "ok",
  "version": "0.1.0",
  "timestamp": "2026-01-01T00:00:00+00:00",
  "checks": {
    "upload_dir": "ok",
    "output_dir": "ok"
  }
}
```

## 3. Submit a forecast job

Prepare a CSV file with at minimum three columns:

| Column      | Description                        |
| ----------- | ---------------------------------- |
| `item_id`   | Series identifier (e.g. `store_A`) |
| `timestamp` | ISO-8601 datetime or date string   |
| `target`    | Numeric value to forecast          |

```bash theme={null}
curl -X POST https://eomer-api.onrender.com/forecast \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -F "file=@data.csv" \
  -F "prediction_length=24" \
  -F "presets=eomer_pulse_nano"
```

The API returns immediately with a job ID and status `pending`:

```json theme={null}
{
  "job_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "status": "pending",
  "prediction_length": 24
}
```

## 4. Poll for completion

```bash theme={null}
curl https://eomer-api.onrender.com/jobs/3fa85f64-5717-4562-b3fc-2c963f66afa6 \
  -H "Authorization: Bearer YOUR_API_KEY"
```

When `status` is `completed`, a `download_url` appears in the response.

## 5. Download the forecast

```bash theme={null}
curl https://eomer-api.onrender.com/jobs/3fa85f64-5717-4562-b3fc-2c963f66afa6/download \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -o forecast.csv
```

The output CSV contains one row per (item\_id, future\_timestamp) pair with columns
`mean`, `0.1`, `0.5`, `0.9` (10th, 50th, 90th quantile forecasts).

***

## Available model presets

Retrieve the full list at any time:

```bash theme={null}
curl https://eomer-api.onrender.com/models \
  -H "Authorization: Bearer YOUR_API_KEY"
```

| Preset               | Size     | Best for                    |
| -------------------- | -------- | --------------------------- |
| `eomer_pulse_nano`   | Smallest | Fast prototyping, CI        |
| `eomer_pulse_mini`   | Small    | Balanced speed and accuracy |
| `eomer_pulse`        | Medium   | Production workloads        |
| `eomer_horizon_core` | Large    | Complex workloads           |
| `eomer_horizon`      | Largest  | High-capacity workloads     |
| `eomer_horizon_max`  | Ensemble | Maximum forecast quality    |

All presets are zero-shot - no training data required.