{"openapi":"3.1.0","info":{"title":"Yelp API (Bowmark)","version":"e833508f87ff","description":"Yelp's own business search — returns real, currently-listed businesses for a search term and location with Yelp's own star rating, review count, price tier and neighborhood.\n\nEvery function Bowmark has for Yelp (yelp.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/yelp/search":{"post":{"operationId":"search","summary":"Runs Yelp's own business search for a term and location, with its sort (recommended, highest rated, most reviewed), price, open-now, feature and category filters and paging by start offset, and return","description":"Runs Yelp's own business search for a term and location, with its sort (recommended, highest rated, most reviewed), price, open-now, feature and category filters and paging by start offset, and returns real, currently-listed businesses with their /biz/ alias, Yelp's own rating, review count, price tier and neighborhood. Read-only.\n\nCalls `bowmark.providers.yelp.search`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<YelpSearchResult[]>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"$ref":"#/components/schemas/YelpSearchArgs","description":"TypeScript: `YelpSearchArgs`"}},"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/yelp/getBusiness":{"post":{"operationId":"getBusiness","summary":"Reads one business's own schema.org listing off its /biz/ page: name, phone, address, coordinates, Yelp's own rating and review count, price tier, category path, hours, amenities, accepted payment and","description":"Reads one business's own schema.org listing off its /biz/ page: name, phone, address, coordinates, Yelp's own rating and review count, price tier, category path, hours, amenities, accepted payment and the main photo. Takes a /biz/ url or bare alias from search. Read-only.\n\nCalls `bowmark.providers.yelp.getBusiness`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<YelpBusiness>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"ref":{"type":"string","description":"TypeScript: `string`"}},"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/yelp/suggest":{"post":{"operationId":"suggest","summary":"Yelp's own search-as-you-type suggestions for a partial name or term near a location: businesses (with the /biz/ alias getBusiness takes), chains, categories and plain queries with their refinements.","description":"Yelp's own search-as-you-type suggestions for a partial name or term near a location: businesses (with the /biz/ alias getBusiness takes), chains, categories and plain queries with their refinements. Read-only.\n\nCalls `bowmark.providers.yelp.suggest`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<YelpSuggestion[]>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"$ref":"#/components/schemas/YelpSuggestArgs","description":"TypeScript: `YelpSuggestArgs`"}},"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/yelp/getReviews":{"post":{"operationId":"getReviews","summary":"Lists a business's reviews a page at a time through Yelp's own review feed, with its sorts (relevance, newest, oldest, highest, lowest, elites), a star filter and its search-within-reviews box: each r","description":"Lists a business's reviews a page at a time through Yelp's own review feed, with its sorts (relevance, newest, oldest, highest, lowest, elites), a star filter and its search-within-reviews box: each review's text, rating, date, photos, reactions, owner reply and the reviewer's name, location, counts and Elite year. Page on with nextCursor. Read-only.\n\nCalls `bowmark.providers.yelp.getReviews`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<YelpReviewPage>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"$ref":"#/components/schemas/YelpReviewsArgs","description":"TypeScript: `YelpReviewsArgs`"}},"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/yelp/getMenu":{"post":{"operationId":"getMenu","summary":"Reads a restaurant's menu from its /menu/<alias> page's own ld+json Menu block: each section (e.g.","description":"Reads a restaurant's menu from its /menu/<alias> page's own ld+json Menu block: each section (e.g. Appetizers, Ramen) and its items' name, item-page url, description and price. Takes a /biz/ or /menu/ url or bare alias from search. Null fields mean the site did not publish that detail for that item. Throws when the business has no menu on Yelp. Read-only.\n\nCalls `bowmark.providers.yelp.getMenu`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<YelpMenu>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"ref":{"type":"string","description":"TypeScript: `string`"}},"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/yelp/getPhotos":{"post":{"operationId":"getPhotos","summary":"Lists a business's photos from its /biz_photos/<alias> page, 30 at a time: each photo's full-size url, thumbnail, caption, upload date and uploader name.","description":"Lists a business's photos from its /biz_photos/<alias> page, 30 at a time: each photo's full-size url, thumbnail, caption, upload date and uploader name. business is a /biz/ url or bare alias from search; tab is the photo tab from a /biz_photos url's ?tab= (omit for all); pass nextStart back as start for the next page. Read-only.\n\nCalls `bowmark.providers.yelp.getPhotos`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<YelpPhotoPage>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"$ref":"#/components/schemas/YelpPhotosArgs","description":"TypeScript: `YelpPhotosArgs`"}},"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/yelp/getQuestions":{"post":{"operationId":"getQuestions","summary":"Reads a business's Ask the Community questions from its /questions/ page: each question's text, asker, relative date, answer count, top answer (text, author, date, helpful votes) and Yelp's own AI ans","description":"Reads a business's Ask the Community questions from its /questions/ page: each question's text, asker, relative date, answer count, top answer (text, author, date, helpful votes) and Yelp's own AI answer when shown — the first 10 in Yelp's best order, plus the total count. Takes a /biz/ url or bare alias from search. Read-only.\n\nCalls `bowmark.providers.yelp.getQuestions`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<YelpQuestionPage>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"ref":{"type":"string","description":"TypeScript: `string`"}},"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/yelp/getUser":{"post":{"operationId":"getUser","summary":"Reads a public Yelp member profile from /user_details?userid=<id>: name, location, join month, tagline, photo, Elite years, review/photo/friend/follower/compliment counts, their filled-in About answer","description":"Reads a public Yelp member profile from /user_details?userid=<id>: name, location, join month, tagline, photo, Elite years, review/photo/friend/follower/compliment counts, their filled-in About answers and their 5 latest reviews (rating, text, date, business alias). userId is a getReviews row's author.id, or the userid in a profile url. Read-only.\n\nCalls `bowmark.providers.yelp.getUser`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<YelpUser>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"userId":{"type":"string","description":"TypeScript: `string`"}},"required":["userId"],"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/yelp/getCollection":{"post":{"operationId":"getCollection","summary":"Reads a public Yelp collection (a member's named list of places) from its /collection/<id> url: title, description, owner (id for getUser, name), follower count, how many places it holds, and the firs","description":"Reads a public Yelp collection (a member's named list of places) from its /collection/<id> url: title, description, owner (id for getUser, name), follower count, how many places it holds, and the first page of up to 30 businesses (alias for getBusiness, name, rating, review count, city, photo). Takes the share url or the bare id. Read-only.\n\nCalls `bowmark.providers.yelp.getCollection`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<YelpCollection>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"ref":{"type":"string","description":"TypeScript: `string`"}},"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/yelp/getWaitlist":{"post":{"operationId":"getWaitlist","summary":"Reads a restaurant's Yelp Waitlist state off its business page: whether it is on Yelp Waitlist at all, whether it is taking parties right now, the quoted wait range in minutes when open, and Yelp's ow","description":"Reads a restaurant's Yelp Waitlist state off its business page: whether it is on Yelp Waitlist at all, whether it is taking parties right now, the quoted wait range in minutes when open, and Yelp's own line when closed (e.g. when it usually opens). Takes a /biz/ url or bare alias from search. Read-only.\n\nCalls `bowmark.providers.yelp.getWaitlist`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<YelpWaitlist>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"ref":{"type":"string","description":"TypeScript: `string`"}},"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/yelp/searchEvents":{"post":{"operationId":"searchEvents","summary":"Lists the events on a city's Yelp Events browse page (its first page, in the order the page shows them): each one's name, url, start time, the card's own wording of when, venue (alias for getBusiness,","description":"Lists the events on a city's Yelp Events browse page (its first page, in the order the page shows them): each one's name, url, start time, the card's own wording of when, venue (alias for getBusiness, name), locale, description, category, interest count and whether it is a Yelp-run event. Takes Yelp's city slug from its events url, e.g. \"sf\" or \"philadelphia\" — the city name is refused. Read-only.\n\nCalls `bowmark.providers.yelp.searchEvents`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<YelpEventPage>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"city":{"type":"string","description":"TypeScript: `string`"}},"required":["city"],"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/yelp/listCategories":{"post":{"operationId":"listCategories","summary":"Lists Yelp's business categories (about 1,600) from Yelp's own published category list: each one's alias (what search's category filter takes), title, parent alias, depth and the countries it is used ","description":"Lists Yelp's business categories (about 1,600) from Yelp's own published category list: each one's alias (what search's category filter takes), title, parent alias, depth and the countries it is used in. Narrow with parent (direct children of one alias), query (title or alias contains) or country. Read-only.\n\nCalls `bowmark.providers.yelp.listCategories`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<YelpCategory[]>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"$ref":"#/components/schemas/YelpCategoriesArgs","description":"TypeScript: `YelpCategoriesArgs`"}},"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/yelp/getOwnProfile":{"post":{"operationId":"getOwnProfile","summary":"Reads the signed-in caller's own Yelp profile from their /user_details page: name, location, join month, tagline, photo, Elite years, review/photo/friend/follower/compliment counts, filled-in About an","description":"Reads the signed-in caller's own Yelp profile from their /user_details page: name, location, join month, tagline, photo, Elite years, review/photo/friend/follower/compliment counts, filled-in About answers and latest reviews (the same YelpUser getUser returns). Needs the caller signed in to Yelp; runs through their own Chrome when Bowmark Buddy is attached. Read-only.\n\nCalls `bowmark.providers.yelp.getOwnProfile`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<YelpUser>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"opts":{"type":"object","properties":{"connection":{"type":"string"}},"required":["connection"],"additionalProperties":true,"description":"TypeScript: `ConnectionOption`"}},"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/yelp/getCollections":{"post":{"operationId":"getCollections","summary":"Lists the signed-in caller's own Yelp collections (their My Collections page): each one's id, title and url, in page order, [] when none; pass a url to getCollection for the places in it.","description":"Lists the signed-in caller's own Yelp collections (their My Collections page): each one's id, title and url, in page order, [] when none; pass a url to getCollection for the places in it. Needs the caller signed in to Yelp; runs through their own Chrome when Bowmark Buddy is attached. Read-only.\n\nCalls `bowmark.providers.yelp.getCollections`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<YelpOwnCollections>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"opts":{"type":"object","properties":{"connection":{"type":"string"}},"required":["connection"],"additionalProperties":true,"description":"TypeScript: `ConnectionOption`"}},"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/yelp/getMessages":{"post":{"operationId":"getMessages","summary":"Lists the threads in the signed-in caller's own Yelp inbox (/messaging/inbox): each thread's id, url and the preview text the page shows, in page order, [] when empty.","description":"Lists the threads in the signed-in caller's own Yelp inbox (/messaging/inbox): each thread's id, url and the preview text the page shows, in page order, [] when empty. Needs the caller signed in to Yelp; runs through their own Chrome when Bowmark Buddy is attached. Read-only.\n\nCalls `bowmark.providers.yelp.getMessages`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<YelpMessages>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"opts":{"type":"object","properties":{"connection":{"type":"string"}},"required":["connection"],"additionalProperties":true,"description":"TypeScript: `ConnectionOption`"}},"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/yelp/getBookmarks":{"post":{"operationId":"getBookmarks","summary":"Lists the businesses the signed-in caller has bookmarked on Yelp (their own My Bookmarks page): each business's alias, name and url, in the order the page shows them, [] when nothing is saved.","description":"Lists the businesses the signed-in caller has bookmarked on Yelp (their own My Bookmarks page): each business's alias, name and url, in the order the page shows them, [] when nothing is saved. Needs the caller signed in to Yelp; runs through their own Chrome when Bowmark Buddy is attached. Read-only.\n\nCalls `bowmark.providers.yelp.getBookmarks`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<YelpBookmarks>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"opts":{"type":"object","properties":{"connection":{"type":"string"}},"required":["connection"],"additionalProperties":true,"description":"TypeScript: `ConnectionOption`"}},"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}}},"YelpCategoriesArgs":{"type":"object","properties":{"parent":{"type":"string"},"query":{"type":"string"},"country":{"type":"string"}},"additionalProperties":true},"YelpPhotosArgs":{"type":"object","properties":{"business":{"type":"string"},"tab":{"type":"string"},"start":{"type":"number"}},"required":["business"],"additionalProperties":true},"YelpReviewsArgs":{"type":"object","properties":{"business":{"type":"string"},"sort":{"anyOf":[{"const":"relevance"},{"const":"newest"},{"const":"oldest"},{"const":"highest"},{"const":"lowest"},{"const":"elites"}]},"stars":{"type":"array","items":{"type":"number"}},"query":{"type":"string"},"after":{"type":"string"},"limit":{"type":"number"}},"required":["business"],"additionalProperties":true},"YelpSearchArgs":{"type":"object","properties":{"term":{"type":"string"},"location":{"type":"string"},"limit":{"type":"number"},"sort":{"anyOf":[{"const":"recommended"},{"const":"rating"},{"const":"review_count"}]},"price":{"type":"array","items":{"type":"number"}},"openNow":{"type":"boolean"},"features":{"type":"array","items":{"type":"string"}},"category":{"type":"string"},"start":{"type":"number"}},"required":["term","location"],"additionalProperties":true},"YelpSuggestArgs":{"type":"object","properties":{"prefix":{"type":"string"},"location":{"type":"string"}},"required":["prefix","location"],"additionalProperties":true}}}}