{"openapi":"3.1.0","info":{"title":"Toast API (Bowmark)","version":"e833508f87ff","description":"Toast, the restaurant platform behind Toast Local (toast.app), Toast online ordering and Toast Tables: find restaurants near a place or in a city, a restaurant's details, menu, item choices, ordering options and pickup times, a priced cart up to the payment step, reservation availability, waitlist estimates, events, offers, order tracking, and the signed-in guest's own orders, bookings, reservations, addresses, cards and rewards.\n\nEvery function Bowmark has for Toast (toasttab.com) as one HTTP call. Each runs on Bowmark's infrastructure with the same billing, rules and response envelope as `POST /v1/run`. The whole API: https://api.bowmark.ai/openapi.json. Guide: https://bowmark.ai/docs/api.","contact":{"email":"support@bowmark.ai","url":"https://bowmark.ai/docs/api"}},"servers":[{"url":"https://api.bowmark.ai"}],"security":[{"bearer":[]},{"apiKeyHeader":[]}],"paths":{"/v1/sites/toast/getRestaurant":{"post":{"operationId":"getRestaurant","summary":"Reads one Toast restaurant by its toast.app URL, slug or guid: name, cuisine, address, phone, whether online ordering, delivery, reservations and the waitlist are on, its website and rating, and the g","description":"Reads one Toast restaurant by its toast.app URL, slug or guid: name, cuisine, address, phone, whether online ordering, delivery, reservations and the waitlist are on, its website and rating, and the guid every other Toast function takes. An unknown slug is a clear error, not an empty answer.\n\nCalls `bowmark.providers.toast.getRestaurant`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<ToastRestaurant>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"ref":{"$ref":"#/components/schemas/ToastRestaurantRef","description":"TypeScript: `ToastRestaurantRef`"}},"required":["ref"],"additionalProperties":false}}}},"responses":{"200":{"description":"The call ran. That includes a call that failed (`status: error`) or paused for a sign-in (`status: needs_user`), so branch on `status`.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/RunEnvelope"},{"type":"object","properties":{"result":{}}}]}}}},"400":{"description":"The body was malformed. `error` says what to send.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"401":{"description":"No API key, or a key that was refused.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"402":{"description":"The account is out of free usage, at its spend cap, or its card was declined. Fix billing at https://bowmark.ai/dashboard/billing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"404":{"$ref":"#/components/responses/NotFound"},"429":{"description":"Too many runs in flight on this account. Nothing was started or charged.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}},"headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Seconds to wait."}}},"503":{"description":"A failure on Bowmark's side. Retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}}}}},"/v1/sites/toast/searchRestaurants":{"post":{"operationId":"searchRestaurants","summary":"Finds Toast restaurants near a latitude/longitude, nearest first, optionally by free text, cuisine, or for delivery, pickup or reservations: name, slug and guid, distance in miles, address, price tier","description":"Finds Toast restaurants near a latitude/longitude, nearest first, optionally by free text, cuisine, or for delivery, pickup or reservations: name, slug and guid, distance in miles, address, price tier, rating, whether online ordering, delivery, ASAP pickup or delivery and reservations are on, and minimum delivery and pickup times. Takes coordinates, not a place name.\n\nCalls `bowmark.providers.toast.searchRestaurants`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<ToastSearchResult[]>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"$ref":"#/components/schemas/SearchRestaurantsArgs","description":"TypeScript: `SearchRestaurantsArgs`"}},"required":["args"],"additionalProperties":false}}}},"responses":{"200":{"description":"The call ran. That includes a call that failed (`status: error`) or paused for a sign-in (`status: needs_user`), so branch on `status`.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/RunEnvelope"},{"type":"object","properties":{"result":{}}}]}}}},"400":{"description":"The body was malformed. `error` says what to send.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"401":{"description":"No API key, or a key that was refused.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"402":{"description":"The account is out of free usage, at its spend cap, or its card was declined. Fix billing at https://bowmark.ai/dashboard/billing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"404":{"$ref":"#/components/responses/NotFound"},"429":{"description":"Too many runs in flight on this account. Nothing was started or charged.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}},"headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Seconds to wait."}}},"503":{"description":"A failure on Bowmark's side. Retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}}}}},"/v1/sites/toast/listCities":{"post":{"operationId":"listCities","summary":"Lists the ~400 US cities Toast's restaurant directory covers (toast.app/cities): name, two-letter state, and the city slug listCityRestaurants takes.","description":"Lists the ~400 US cities Toast's restaurant directory covers (toast.app/cities): name, two-letter state, and the city slug listCityRestaurants takes.\n\nCalls `bowmark.providers.toast.listCities`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<ToastCity[]>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{},"additionalProperties":false}}}},"responses":{"200":{"description":"The call ran. That includes a call that failed (`status: error`) or paused for a sign-in (`status: needs_user`), so branch on `status`.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/RunEnvelope"},{"type":"object","properties":{"result":{}}}]}}}},"400":{"description":"The body was malformed. `error` says what to send.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"401":{"description":"No API key, or a key that was refused.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"402":{"description":"The account is out of free usage, at its spend cap, or its card was declined. Fix billing at https://bowmark.ai/dashboard/billing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"404":{"$ref":"#/components/responses/NotFound"},"429":{"description":"Too many runs in flight on this account. Nothing was started or charged.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}},"headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Seconds to wait."}}},"503":{"description":"A failure on Bowmark's side. Retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}}}}},"/v1/sites/toast/listCityRestaurants":{"post":{"operationId":"listCityRestaurants","summary":"Lists the Toast restaurants in a city (\"richmond-va\"), optionally by cuisine (pizza, sushi, thai...), the way toast.app's city pages do: name, cuisine, neighborhood, price tier, rating, image, and the","description":"Lists the Toast restaurants in a city (\"richmond-va\"), optionally by cuisine (pizza, sushi, thai...), the way toast.app's city pages do: name, cuisine, neighborhood, price tier, rating, image, and the slug getRestaurant takes. A city or cuisine toast.app has no page for is a clear error.\n\nCalls `bowmark.providers.toast.listCityRestaurants`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<ToastCityRestaurant[]>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"$ref":"#/components/schemas/ListCityRestaurantsArgs","description":"TypeScript: `ListCityRestaurantsArgs`"}},"required":["args"],"additionalProperties":false}}}},"responses":{"200":{"description":"The call ran. That includes a call that failed (`status: error`) or paused for a sign-in (`status: needs_user`), so branch on `status`.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/RunEnvelope"},{"type":"object","properties":{"result":{}}}]}}}},"400":{"description":"The body was malformed. `error` says what to send.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"401":{"description":"No API key, or a key that was refused.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"402":{"description":"The account is out of free usage, at its spend cap, or its card was declined. Fix billing at https://bowmark.ai/dashboard/billing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"404":{"$ref":"#/components/responses/NotFound"},"429":{"description":"Too many runs in flight on this account. Nothing was started or charged.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}},"headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Seconds to wait."}}},"503":{"description":"A failure on Bowmark's side. Retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}}}}},"/v1/sites/toast/getOrderingOptions":{"post":{"operationId":"getOrderingOptions","summary":"Says how a restaurant takes online orders right now: whether online ordering and delivery are on, ASAP takeout and delivery, today's hours, each dining option (takeout, delivery…) with its guid and th","description":"Says how a restaurant takes online orders right now: whether online ordering and delivery are on, ASAP takeout and delivery, today's hours, each dining option (takeout, delivery…) with its guid and the future pickup or delivery times on offer for the next few days (default 3, max 14), and the ordering schedule by day.\n\nCalls `bowmark.providers.toast.getOrderingOptions`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<ToastOrderingOptions>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"ref":{"$ref":"#/components/schemas/ToastRestaurantRef","description":"TypeScript: `ToastRestaurantRef`"},"daysAhead":{"type":"number","description":"TypeScript: `number`"}},"required":["ref"],"additionalProperties":false}}}},"responses":{"200":{"description":"The call ran. That includes a call that failed (`status: error`) or paused for a sign-in (`status: needs_user`), so branch on `status`.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/RunEnvelope"},{"type":"object","properties":{"result":{}}}]}}}},"400":{"description":"The body was malformed. `error` says what to send.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"401":{"description":"No API key, or a key that was refused.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"402":{"description":"The account is out of free usage, at its spend cap, or its card was declined. Fix billing at https://bowmark.ai/dashboard/billing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"404":{"$ref":"#/components/responses/NotFound"},"429":{"description":"Too many runs in flight on this account. Nothing was started or charged.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}},"headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Seconds to wait."}}},"503":{"description":"A failure on Bowmark's side. Retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}}}}},"/v1/sites/toast/getMenu":{"post":{"operationId":"getMenu","summary":"Reads a restaurant's online-ordering menu by toast.app URL, slug or guid: each menu, its groups, and every item with name, description, price in dollars, whether it is out of stock or has sizes and ad","description":"Reads a restaurant's online-ordering menu by toast.app URL, slug or guid: each menu, its groups, and every item with name, description, price in dollars, whether it is out of stock or has sizes and add-ons, an image, and the item guid getMenuItem and addToCart take.\n\nCalls `bowmark.providers.toast.getMenu`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<ToastMenu>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"ref":{"$ref":"#/components/schemas/ToastRestaurantRef","description":"TypeScript: `ToastRestaurantRef`"}},"required":["ref"],"additionalProperties":false}}}},"responses":{"200":{"description":"The call ran. That includes a call that failed (`status: error`) or paused for a sign-in (`status: needs_user`), so branch on `status`.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/RunEnvelope"},{"type":"object","properties":{"result":{}}}]}}}},"400":{"description":"The body was malformed. `error` says what to send.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"401":{"description":"No API key, or a key that was refused.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"402":{"description":"The account is out of free usage, at its spend cap, or its card was declined. Fix billing at https://bowmark.ai/dashboard/billing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"404":{"$ref":"#/components/responses/NotFound"},"429":{"description":"Too many runs in flight on this account. Nothing was started or charged.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}},"headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Seconds to wait."}}},"503":{"description":"A failure on Bowmark's side. Retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}}}}},"/v1/sites/toast/getMenuItem":{"post":{"operationId":"getMenuItem","summary":"Reads one menu item (guid from getMenu) with everything ordering it needs: its price, every modifier group (sizes and add-ons) with whether it is required and how many may be picked, each option's nam","description":"Reads one menu item (guid from getMenu) with everything ordering it needs: its price, every modifier group (sizes and add-ons) with whether it is required and how many may be picked, each option's name, price and whether it is the default or out of stock, and the guids addToCart takes for the item and each chosen modifier.\n\nCalls `bowmark.providers.toast.getMenuItem`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<ToastMenuItemDetail>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"ref":{"$ref":"#/components/schemas/ToastRestaurantRef","description":"TypeScript: `ToastRestaurantRef`"},"itemGuid":{"type":"string","description":"TypeScript: `string`"},"itemGroupGuid":{"type":"string","description":"TypeScript: `string`"}},"required":["ref","itemGuid"],"additionalProperties":false}}}},"responses":{"200":{"description":"The call ran. That includes a call that failed (`status: error`) or paused for a sign-in (`status: needs_user`), so branch on `status`.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/RunEnvelope"},{"type":"object","properties":{"result":{}}}]}}}},"400":{"description":"The body was malformed. `error` says what to send.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"401":{"description":"No API key, or a key that was refused.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"402":{"description":"The account is out of free usage, at its spend cap, or its card was declined. Fix billing at https://bowmark.ai/dashboard/billing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"404":{"$ref":"#/components/responses/NotFound"},"429":{"description":"Too many runs in flight on this account. Nothing was started or charged.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}},"headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Seconds to wait."}}},"503":{"description":"A failure on Bowmark's side. Retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}}}}},"/v1/sites/toast/searchMenu":{"post":{"operationId":"searchMenu","summary":"Searches one restaurant's online-ordering menu by words (\"paneer\") and returns the matching items, best match first, with name, price, whether it is out of stock, an image, its menu group, and the gui","description":"Searches one restaurant's online-ordering menu by words (\"paneer\") and returns the matching items, best match first, with name, price, whether it is out of stock, an image, its menu group, and the guid getMenuItem and addToCart take.\n\nCalls `bowmark.providers.toast.searchMenu`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<ToastMenuSearchItem[]>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"ref":{"$ref":"#/components/schemas/ToastRestaurantRef","description":"TypeScript: `ToastRestaurantRef`"},"query":{"type":"string","description":"TypeScript: `string`"},"limit":{"type":"number","description":"TypeScript: `number`"}},"required":["ref","query"],"additionalProperties":false}}}},"responses":{"200":{"description":"The call ran. That includes a call that failed (`status: error`) or paused for a sign-in (`status: needs_user`), so branch on `status`.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/RunEnvelope"},{"type":"object","properties":{"result":{}}}]}}}},"400":{"description":"The body was malformed. `error` says what to send.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"401":{"description":"No API key, or a key that was refused.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"402":{"description":"The account is out of free usage, at its spend cap, or its card was declined. Fix billing at https://bowmark.ai/dashboard/billing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"404":{"$ref":"#/components/responses/NotFound"},"429":{"description":"Too many runs in flight on this account. Nothing was started or charged.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}},"headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Seconds to wait."}}},"503":{"description":"A failure on Bowmark's side. Retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}}}}},"/v1/sites/toast/getPopularItems":{"post":{"operationId":"getPopularItems","summary":"Lists a restaurant's most-ordered online-ordering items with name, price and the guid getMenuItem and addToCart take.","description":"Lists a restaurant's most-ordered online-ordering items with name, price and the guid getMenuItem and addToCart take.\n\nCalls `bowmark.providers.toast.getPopularItems`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<ToastPopularItem[]>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"ref":{"$ref":"#/components/schemas/ToastRestaurantRef","description":"TypeScript: `ToastRestaurantRef`"}},"required":["ref"],"additionalProperties":false}}}},"responses":{"200":{"description":"The call ran. That includes a call that failed (`status: error`) or paused for a sign-in (`status: needs_user`), so branch on `status`.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/RunEnvelope"},{"type":"object","properties":{"result":{}}}]}}}},"400":{"description":"The body was malformed. `error` says what to send.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"401":{"description":"No API key, or a key that was refused.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"402":{"description":"The account is out of free usage, at its spend cap, or its card was declined. Fix billing at https://bowmark.ai/dashboard/billing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"404":{"$ref":"#/components/responses/NotFound"},"429":{"description":"Too many runs in flight on this account. Nothing was started or charged.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}},"headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Seconds to wait."}}},"503":{"description":"A failure on Bowmark's side. Retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}}}}},"/v1/sites/toast/getReservationAvailability":{"post":{"operationId":"getReservationAvailability","summary":"Reads a Toast Tables restaurant's open reservation times for a party size across a time window (default 4 hours): each time with the seating areas offered and any deposit or card hold it needs, plus t","description":"Reads a Toast Tables restaurant's open reservation times for a party size across a time window (default 4 hours): each time with the seating areas offered and any deposit or card hold it needs, plus the party-size limits and whether online booking is blocked that day. A restaurant not on Toast Tables comes back onTables: false, not an error.\n\nCalls `bowmark.providers.toast.getReservationAvailability`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<ToastReservationAvailability>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"ref":{"$ref":"#/components/schemas/ToastRestaurantRef","description":"TypeScript: `ToastRestaurantRef`"},"args":{"$ref":"#/components/schemas/ReservationAvailabilityArgs","description":"TypeScript: `ReservationAvailabilityArgs`"}},"required":["ref","args"],"additionalProperties":false}}}},"responses":{"200":{"description":"The call ran. That includes a call that failed (`status: error`) or paused for a sign-in (`status: needs_user`), so branch on `status`.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/RunEnvelope"},{"type":"object","properties":{"result":{}}}]}}}},"400":{"description":"The body was malformed. `error` says what to send.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"401":{"description":"No API key, or a key that was refused.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"402":{"description":"The account is out of free usage, at its spend cap, or its card was declined. Fix billing at https://bowmark.ai/dashboard/billing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"404":{"$ref":"#/components/responses/NotFound"},"429":{"description":"Too many runs in flight on this account. Nothing was started or charged.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}},"headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Seconds to wait."}}},"503":{"description":"A failure on Bowmark's side. Retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}}}}}},"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer","description":"Your Bowmark API key."},"apiKeyHeader":{"type":"apiKey","in":"header","name":"X-Bowmark-Key"}},"responses":{"NotFound":{"description":"No such site or function.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}}},"schemas":{"RunEnvelope":{"type":"object","description":"What a run returns. `status` says whether the SCRIPT succeeded. A script that threw or paused for a login is still HTTP 200. Branch on `status`, not on the HTTP code.","required":["ok","status","result","logs","error","ms"],"properties":{"runId":{"type":"string","description":"Stable id for this run. Quote it in a support or `report` message."},"ok":{"type":"boolean","description":"False only when the run produced nothing usable."},"status":{"type":"string","enum":["ok","error","partial","needs_user"],"description":"`partial`: the result is real but some calls failed (see `incomplete`); `ok` stays true. `needs_user`: a person must sign in to a site first. Relay `meta.handoff.url` to them, then run again."},"egress":{"type":"string","enum":["default","link"],"description":"The egress the run was given, present only when the request asked for one. `link`: every request went through the caller's own Chrome (Bowmark Buddy)."},"result":{"description":"Whatever the script `return`ed. Any JSON value."},"logs":{"type":"array","items":{"type":"string"},"description":"Lines the script wrote with `log(...)`."},"error":{"type":["string","null"],"description":"Why the run failed, in plain words. Null on success."},"ms":{"type":"integer","description":"How long the script itself ran, in milliseconds."},"queuedMs":{"type":"integer","description":"How long the run waited for a worker before starting. Present only when it was a second or more."},"needs":{"type":"array","description":"The sign-ins this script is waiting on. Present when `status` is `needs_user`.","items":{"type":"object","required":["capability","provider","providerTitle","kind"],"properties":{"capability":{"type":"string"},"provider":{"type":"string"},"providerTitle":{"type":"string","description":"The site's name, to show a person."},"kind":{"type":"string"}}}},"incomplete":{"type":"object","description":"Present only when `status` is `partial`: which calls did not answer.","properties":{"summary":{"type":"string"},"totalCalls":{"type":"integer"}},"additionalProperties":true},"emptyHanded":{"type":"object","description":"Present when the script returned nothing while its calls returned rows, usually a filter that matched none of the site's own labels. Lists the label values the calls actually returned.","additionalProperties":true},"notes":{"type":"array","description":"Caveats a call attached to a complete answer. Never changes `status`.","items":{"type":"object","properties":{"path":{"type":"string"},"notes":{"type":"array","items":{"type":"string"}}}}},"meta":{"type":"object","properties":{"handoff":{"type":"object","description":"A single-use sign-in link for a person to open. Expires at `expiresAt`.","properties":{"ref":{"type":"string"},"url":{"type":"string","format":"uri"},"expiresAt":{"type":"string","format":"date-time"}}},"concurrency":{"type":"object","description":"On a 429: how many runs are in flight and when to retry.","properties":{"limit":{"type":"integer"},"inFlight":{"type":"integer"},"retryAfterSeconds":{"type":"integer"}}}},"additionalProperties":true},"notice":{"type":"object","description":"Set when the account owner has not accepted the current Terms. Relay it to them.","additionalProperties":true}}},"ListCityRestaurantsArgs":{"type":"object","properties":{"city":{"type":"string"},"cuisine":{"type":"string"}},"required":["city"],"additionalProperties":true},"ReservationAvailabilityArgs":{"type":"object","properties":{"partySize":{"type":"number"},"start":{"type":"string"},"hours":{"type":"number"}},"required":["partySize","start"],"additionalProperties":true},"SearchRestaurantsArgs":{"type":"object","properties":{"lat":{"type":"number"},"latitude":{"type":"number"},"lng":{"type":"number"},"lon":{"type":"number"},"longitude":{"type":"number"},"query":{"type":"string"},"cuisine":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]},"context":{"anyOf":[{"const":"delivery"},{"const":"pickup"},{"const":"reservations"}]},"limit":{"type":"number"}},"additionalProperties":true},"ToastRestaurantRef":{"type":"string"}}}}