Scans

Scans are audit/debug records created when NutritionSignals processes an image (or other analyzers, as they ship). Use this endpoint to retrieve a scan event for traceability, support, and debugging.

A scan record typically includes timestamps, processing metadata, image references (like image_object_path), and the structured nutrition result (when available).

Endpoint

GET /v1/scans/{scan_id}

Requests are made to:

Base URL

https://api.nutritionsignals.com

Authentication

All requests require an API key sent as a Bearer token in the Authorization header.

Authorization header

Authorization: Bearer YOUR_API_KEY

Don’t have a key yet? Read Authentication.

Path parameters

scan_id (string) — the scan identifier returned by NutritionSignals when a scan is created

Try it

Paste your API key, enter a scan id, click Run, and you’ll see the raw JSON response.

This runs in the browser. Your key (and last-used scan id) are stored only in your browser (localStorage) so you don’t need to retype them. They’re sent only to the Base URL you enter below when you click Run.

Try it

GET /v1/scans/{scan_id}

API Key (Bearer)

Tip: Use test_123 to try quickly, or get a real key in Authentication.

Scan ID

Function URL / Base URL

Calling:

(enter scan_id)

Notes

If you get 404, the scan doesn’t exist (or you’re querying the wrong environment).
If you get 401, your API key is missing/invalid.

Response

{}

Examples

Use any standard HTTP client. Here are copy/paste examples:

curl -sS \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json" \
  "https://api.nutritionsignals.com/v1/scans/00012942?debug=1" | jq

Response

Example response (fields may vary by scan type and availability):

Example response

{
  "scan_id": "00012942",
  "kind": "food_image_analysis",
  "status": "completed",

  "created_at": { "_seconds": 1769368000, "_nanoseconds": 0 },
  "updated_at": { "_seconds": 1769368003, "_nanoseconds": 500000000 },

  "image_object_path": "scans/00012942.webp",
  "image_cloud_url": "https://firebasestorage.googleapis.com/v0/b/<your-bucket>/o/scans%2F00012942.webp?alt=media&token=<token>",
  "image_hash": "578cf566ab5765c869ff6694a32d71e9fb2f89cc8bbbe1bee2bd966caa9ff2ef",

  "calories_kcal_total": 420,
  "protein_g": 28,
  "carbs_g": 35,
  "fat_g": 18,
  "fiber_g": 0,
  "sugar_g": 0,
  "sodium_mg": 0,

  "match": {
    "confidence": 0.86,
    "source": "food_image_analysis"
  }
}

Common fields

scan_id — identifier for this scan
status — queued | processing | completed | failed
image_object_path — internal storage object path (if an image was uploaded)
image_url — a clickable URL served via your domain (if available)
result — structured output (varies by scan type)
meta — processing/debug metadata (best-effort)

Errors

401 — Missing/invalid API key
404 — Scan not found
429 — Rate limited
5xx — Server error

Read Errors

API endpoints

Name
GET /v1/scans/:scan_id
Description
Retrieve scan/audit details for debugging and support.