API Documentation

Quick start

All requests are HTTPS. Authenticate via Bearer token.

# 1. Get your API key from Settings → API keys
export CHEFFY_KEY="ciq_live_..."

# 2. List recent alerts
curl -H "Authorization: Bearer $CHEFFY_KEY" \
  https://api.cheffyiq.com/v1/alerts?limit=10

Endpoints

Alerts

GET /v1/alerts

GET /v1/alerts/{id}

POST /v1/alerts/{id}/acknowledge

Recipes

GET /v1/recipes

POST /v1/recipes

PUT /v1/recipes/{id}

Chefs

GET /v1/chefs

GET /v1/chefs/{id}/score

POS Webhooks (inbound)

POST /v1/webhooks/pos/order-placed

POST /v1/webhooks/pos/order-fulfilled

Example: alert webhook payload

When a violation is detected, we POST this to your endpoint:

{
  "event": "alert.created",
  "timestamp": "2026-04-30T12:42:18Z",
  "alert": {
    "id": "alt_8d3kf9",
    "severity": "critical",
    "category": "hygiene",
    "title": "Plating without gloves",
    "chef_id": "chef_anita_42",
    "camera_id": "cam_02",
    "location_id": "loc_federal_hill",
    "clip_url": "https://clips.cheffyiq.com/...",
    "confidence": 0.96
  }
}

Resources

Rate limits

Growth: 500 req/min
Enterprise: 5,000 req/min

Build on top of CheffyIQ