Warm up the waiter

Prime the AI waiter before the diner's first message so the first answer comes faster.

POST/api/v1/chat/warmupClient API

Send it when the chat opens, with what the first message will send. It primes the waiter so the first answer comes faster; warmed says whether it did anything.

Authentication

Client API. Send your publishable key in x-tamr-key and the diner's session in x-tamr-session, from Start a session. For a guest's session, also send its device id in x-tamr-device. A browser may call it only from an origin listed on the key.

Headers

NameTypeRequiredDescription
x-tamr-devicestringNoGuest sessions only: the device id the session was exchanged with. Matches ^[A-Za-z0-9_-]{8,128}$.
x-tamr-appstringNoNative apps only: the app's iOS bundle id or Android package name. A key used from an app it doesn't list is logged, never refused. Matches ^[A-Za-z][A-Za-z0-9_-]*(\.[A-Za-z0-9_-]+)+$.

Request body

FieldTypeRequiredDescription
branchstringNoAn address: lower-case letters, digits and dashes.
modestringNoOne of dine_in, pickup, delivery.
localestringNoA language tag, such as ar or en-GB.
takesarray of stringNoAt most 16 items. Matches ^[a-z][a-z_.]{0,47}$.
openobjectNo
open.msintegerYes0 to 600,000.
open.preloadedbooleanYes

Response

FieldTypeDescription
warmedboolean

Example

curl https://tamr.link/api/v1/chat/warmup \
  -H "x-tamr-key: $TAMR_APP_KEY" \
  -H "x-tamr-session: $TAMR_SESSION" \
  -H "content-type: application/json" \
  -d '{
  "branch": "hamra",
  "mode": "pickup",
  "locale": "ar"
}'

Example response

{
  "warmed": true
}

Errors

Every error has the same body; switch on data.code. See Errors and rate limits.

data.codeStatusWhat to do
app_key_invalid401The key is wrong, revoked or of another kind. Check it in the dashboard.
sdk_disabled403The SDK isn't switched on for this restaurant. Ask Tamr.
origin_not_allowed403A browser called from an origin the key doesn't list. Add the origin to the key.
session_expired401Start a new session with a fresh token or code, then send the call again once.
invalid_request400A field doesn't match the spec. The message says which.
rate_limited429Wait retryAfter seconds (also in the Retry-After header), then try again.
menu_unavailable404No published menu is served at that branch and service mode.