Generated by API Evangelist
Written by API Evangelist tooling for Toast's API. It is a proposal applied on top of the contract, not a document Toast publishes.
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
title: API Evangelist conversational phrasing for Toast Published API
version: 1.0.0
extends: openapi/toast-published-api-openapi.yml
actions:
- target: $.info
update:
x-apievangelist-phrasing:
method: generated
generated: '2026-10-01'
generator: build-phrasing.py
label: Generated by API Evangelist
operations: 3
- target: $.paths['/published/prepStations'].get
update:
x-apievangelist-phrasing:
intent: List a restaurant's kitchen prep stations
effect: read
questions:
- Which prep stations, like kitchen printers or KDS screens, receive orders at a restaurant?
- Can I list only prep stations changed since a date?
instructions:
- text: List all prep stations at restaurant {restaurant}.
slots:
restaurant: header.Toast-Restaurant-External-ID
- text: List prep stations at {restaurant} modified since {since}.
slots:
restaurant: header.Toast-Restaurant-External-ID
since: query.lastModified
method: generated
generated: '2026-10-01'
- target: $.paths['/published/prepStations/{guid}'].get
update:
x-apievangelist-phrasing:
intent: Look up one prep station
effect: read
questions:
- How do I see the configuration of a single prep station?
- What settings does one kitchen prep station have?
instructions:
- text: Get prep station {guid} at restaurant {restaurant}.
slots:
guid: path.guid
restaurant: header.Toast-Restaurant-External-ID
- text: Show me the kitchen prep station {guid}.
slots:
guid: path.guid
method: generated
generated: '2026-10-01'
- target: $.paths['/v1/published/packagingConfig'].get
update:
x-apievangelist-phrasing:
intent: Get a restaurant's packaging configuration
effect: read
questions:
- What packaging options, like utensils or bags, has a restaurant published?
- Can I read a restaurant's published packaging settings?
instructions:
- text: Get the published packaging configuration for restaurant {restaurant}.
slots:
restaurant: header.Toast-Restaurant-External-ID
- text: Show packaging options that {restaurant} offers guests.
slots:
restaurant: header.Toast-Restaurant-External-ID
method: generated
generated: '2026-10-01'
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.