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 APISend 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
| Name | Type | Required | Description |
|---|---|---|---|
x-tamr-device | string | No | Guest sessions only: the device id the session was exchanged with. Matches ^[A-Za-z0-9_-]{8,128}$. |
x-tamr-app | string | No | Native 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
| Field | Type | Required | Description |
|---|---|---|---|
branch | string | No | An address: lower-case letters, digits and dashes. |
mode | string | No | One of dine_in, pickup, delivery. |
locale | string | No | A language tag, such as ar or en-GB. |
takes | array of string | No | At most 16 items. Matches ^[a-z][a-z_.]{0,47}$. |
open | object | No | |
open.ms | integer | Yes | 0 to 600,000. |
open.preloaded | boolean | Yes |
Response
| Field | Type | Description |
|---|---|---|
warmed | boolean |
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"
}'import { createClient } from "@tamr/api";
const tamr = createClient({ appKey: process.env.TAMR_APP_KEY });
// Sign the diner in first, with a token your backend signed (or a launch code).
await tamr.startSession({ token: dinerToken });
const result = await tamr.warmup({ branch: "hamra", mode: "pickup", locale: "ar" });
console.log(result);import os
import requests
API = "https://tamr.link/api/v1"
headers = {
"x-tamr-key": os.environ["TAMR_APP_KEY"],
"x-tamr-session": os.environ["TAMR_SESSION"], # from POST /api/v1/sdk/session
}
response = requests.post(
f"{API}/chat/warmup",
headers=headers,
json={"branch": "hamra", "mode": "pickup", "locale": "ar"},
timeout=30,
)
response.raise_for_status()
print(response.json())Example response
{
"warmed": true
}Errors
Every error has the same body; switch on data.code. See Errors and rate limits.
data.code | Status | What to do |
|---|---|---|
app_key_invalid | 401 | The key is wrong, revoked or of another kind. Check it in the dashboard. |
sdk_disabled | 403 | The SDK isn't switched on for this restaurant. Ask Tamr. |
origin_not_allowed | 403 | A browser called from an origin the key doesn't list. Add the origin to the key. |
session_expired | 401 | Start a new session with a fresh token or code, then send the call again once. |
invalid_request | 400 | A field doesn't match the spec. The message says which. |
rate_limited | 429 | Wait retryAfter seconds (also in the Retry-After header), then try again. |
menu_unavailable | 404 | No published menu is served at that branch and service mode. |