API v1 · Stable

ScanMate REST API

Ship in minutes with signed session tokens, streaming chat, and event webhooks. All endpoints return JSON.

Base URL

https://api.scanmate.app

Auth

Bearer sk_live_…

Rate limit

10k req / min

Endpoints

POST/v1/sessions

Create a scan session from a QR token.

cURL

curl -X POST https://api.scanmate.app/v1/sessions \
  -H "Authorization: Bearer sk_live_..." \
  -H "Content-Type: application/json" \
  -d '{ "qr_token": "qr_9F4K...", "device": "ios" }'

Request body

{ "qr_token": "qr_9F4K...", "device": "ios" }

200 OK

{ "session_id": "s_af12", "store": { "id": "s1", "name": "Aroma Roasters" }, "expires_in": 900 }

Webhook events

session.created

A new scan session was created.

message.completed

Assistant finished streaming a reply.

feedback.submitted

A shopper submitted a rating.

moderation.flagged

The guardrail layer flagged a response.