API Quickstart

From zero to a quality report in four curl commands — no SDK required.

▸ BETA

▸ APPLIES TO

cheetah service >=0.0.132

Four commands from a blank terminal to a quality report. All you need is curl, a machine on the same network as your inspection cell, and the cell's hostname or IP.

The examples use cheetah-cell.local; substitute your cell's address.

Confirm you can reach the cell.
```
curl -s http://cheetah-cell.local:8000/health | python3 -m json.tool
```
A 200 with per-component status means you're in. A connection error means a network problem, not an API one — confirm the address and that your machine can route to the cell.
List the programs the cell knows.
```
curl -s "http://cheetah-cell.local:8000/programs?limit=10" | python3 -m json.tool
```
Each program is an inspection definition. Note any id — and notice total, limit, and offset in the envelope: every list endpoint paginates the same way.
List recent program runs.
```
curl -s "http://cheetah-cell.local:8000/runs?status=completed&limit=3" | python3 -m json.tool
```
Each program run is a program executed once against a single part. Copy the id of any completed one.
Fetch its quality report.
```
curl -s http://cheetah-cell.local:8000/runs/<run_id>/quality-report | python3 -m json.tool
```
That's an inspection result — the QC outcome in status and every quality check evaluated, with values and thresholds. GET /runs/<run_id> gives the full program-run detail behind it.

If the cell is freshly installed and step 03 returns an empty list, start a program from the cell's Operator screen first — the API only reports inspections that have happened.

Where to go next#

Open REST API — turn step 03 into a production sync loop with updated_since.
Webhooks — stop polling; have the cell push events the moment a program run finishes.
API reference — every operation on the public surface.