Developer docs

Tamr developer docs

Put Tamr's AI waiter in your restaurant app with the restaurant ordering SDK for the web, React Native, Flutter, iOS and Android, plus the API reference and webhooks.

Tamr's SDK puts a restaurant's AI waiter inside its own app or website. Diners ask about the menu in their own language, get answers and dish cards, and order, either through Tamr or into your app's own cart. These docs cover the five SDKs, the HTTP API at https://tamr.link/api/v1 and the webhooks Tamr sends your backend.

What you build

The chat is a web page Tamr hosts, https://tamr.link/w/{restaurant}. The SDK shows that page in a webview (an iframe on a website) and passes messages between the page and your app. Everything the waiter decides happens in the page, so it improves without an app release.

WhoWhat it does
Your appShows the waiter with the SDK, says who the diner is by asking your backend for a short signed token, and, if the restaurant chose it, takes the waiter's dishes into its own cart.
Your backendSigns diner tokens. Receives webhooks. Optionally sends your orders, your product ids and your nutrition figures to Tamr, and erases a user on request.
TamrRuns the waiter page, the AI, the menu, and, in one ordering mode, table orders, pickups and payments.

How the SDK works explains the parts in more detail.

Where orders go

The restaurant chooses, with one setting in its Tamr dashboard ("Orders go to"):

  • Tamr, the default. The diner orders and pays inside the waiter page, as on Tamr's QR menu: dine-in at a table they scanned, or pickup. Your app hears that an order was placed or paid.
  • The app's cart. The waiter proposes dishes, your app puts them in its own cart, and your checkout takes the order. Your backend then sends the order to Tamr, so the waiter can offer "the usual" next time.

Your code is mostly the same in both. Ordering modes covers the differences.

Words used in these docs

WordMeaning
Restaurant addressThe restaurant's short name on Tamr, as in tamr.link/w/{address}. You pass it to the SDK as restaurant.
BranchOne location of a chain. Each has an address too: lower-case letters, digits and dashes.
App keyA publishable key, tamr_pk_live_… or tamr_pk_test_…. It names your app and is safe to ship in it.
Secret API keyA key for your backend only, with permissions. Never ship it in an app or a website.
Diner tokenA short-lived JWT your backend signs to say which of your users is chatting.
Launch codeA one-time code your backend asks Tamr for, for backends that can't sign tokens.
External idYour own id for a dish, size or option: your SKU or product id.
Minor unitsMoney as a whole number in the currency's smallest unit, sent as a string: "1250" is 12.50 in USD.

For agents

Every page is also served as Markdown: add .md to its address, or send Accept: text/markdown. llms.txt lists them all and llms-full.txt holds every page in one file.