{"openapi":"3.1.0","info":{"title":"Apple API (Bowmark)","version":"e833508f87ff","description":"apple.com's own site search and product pages — no API, no login, no browser.\n\nEvery function Bowmark has for Apple (apple.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/apple/search":{"post":{"operationId":"search","summary":"Runs apple.com's own site search for a keyword and returns the organic and curated result rows it renders server-side.","description":"Runs apple.com's own site search for a keyword and returns the organic and curated result rows it renders server-side.\n\nCalls `bowmark.providers.apple.search`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<AppleSearchResponse>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"query":{"type":"string","description":"TypeScript: `string`"}},"required":["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/apple/suggestSearches":{"post":{"operationId":"suggestSearches","summary":"Types a partial query into apple.com's own search box and returns what it suggests: completed search phrases (\"AirPods Pro 3\") and quick links straight to a product page (\"AirPods\" → apple.com/airpods","description":"Types a partial query into apple.com's own search box and returns what it suggests: completed search phrases (\"AirPods Pro 3\") and quick links straight to a product page (\"AirPods\" → apple.com/airpods/). A caller holding only the words somebody said gets a real product URL with no id to know first.\n\nCalls `bowmark.providers.apple.suggestSearches`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<AppleSuggestResponse>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"query":{"type":"string","description":"TypeScript: `string`"}},"required":["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/apple/getProduct":{"post":{"operationId":"getProduct","summary":"Reads one apple.com product/buy page (a URL or path, e.g.","description":"Reads one apple.com product/buy page (a URL or path, e.g. search()'s own rows) and returns every schema.org Product block it publishes.\n\nCalls `bowmark.providers.apple.getProduct`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<AppleProductPage>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"urlOrPath":{"type":"string","description":"TypeScript: `string`"}},"required":["urlOrPath"],"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/apple/getProductByPartNumber":{"post":{"operationId":"getProductByPartNumber","summary":"Turns an Apple part number — the \"MYAP3LL/A\"-shaped code printed on every buy page and returned by getPickupAvailability/getDeliveryEstimate — into the product it names: real name, price and currency,","description":"Turns an Apple part number — the \"MYAP3LL/A\"-shaped code printed on every buy page and returned by getPickupAvailability/getDeliveryEstimate — into the product it names: real name, price and currency, straight off the configured buy page apple.com redirects a part number to. Also accepts a /shop/ path or apple.com URL, resolved the same way getProduct's argument is.\n\nCalls `bowmark.providers.apple.getProductByPartNumber`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<AppleProductPage>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"partNumber":{"type":"string","description":"TypeScript: `string`"}},"required":["partNumber"],"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/apple/getConfigurationOptions":{"post":{"operationId":"getConfigurationOptions","summary":"Reads every choice a Mac/iPhone/iPad buy page actually offers — screen size, colour, chip, memory, storage, keyboard layout, connectivity — straight off the page's own configurator data, with the part","description":"Reads every choice a Mac/iPhone/iPad buy page actually offers — screen size, colour, chip, memory, storage, keyboard layout, connectivity — straight off the page's own configurator data, with the part number and price each fixed combination already resolves to. \"Configure and price it\" as one read instead of clicking through the on-page configurator: every part number this returns is directly usable by getProductByPartNumber, getPickupAvailability and getDeliveryEstimate. A combination apple.com has not fixed a single part number for yet (memory/storage still open) comes back with `buildToOrder: true` and a null part number, listing the further choices rather than guessing a price for combinations apple.com computes client-side.\n\nCalls `bowmark.providers.apple.getConfigurationOptions`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<AppleConfigurationOptions>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"urlOrPath":{"type":"string","description":"TypeScript: `string`"}},"required":["urlOrPath"],"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/apple/getPurchaseOptions":{"post":{"operationId":"getPurchaseOptions","summary":"Reads the ways apple.com will let you pay for the product a buy page has settled on — buy outright, Apple Card Monthly Installments, or the Apple Upgrade Program lease (with its 24- vs 36-month term c","description":"Reads the ways apple.com will let you pay for the product a buy page has settled on — buy outright, Apple Card Monthly Installments, or the Apple Upgrade Program lease (with its 24- vs 36-month term choice) — with apple.com's own copy for each, straight off the buy page's own window.PURCHASE_OPTIONS_BOOTSTRAP. Only a page that has resolved to ONE product exposes this: every Mac family buy page has (e.g. \"/shop/buy-mac/macbook-air\"), an iPhone/iPad chooser page has not even at one specific part number, and this throws a caller-fixable error naming that rather than guessing. Carries no dollar figure — apple.com computes a monthly amount only after a term and trade-in are picked on the buy page itself; read a configuration's own price off getConfigurationOptions.\n\nCalls `bowmark.providers.apple.getPurchaseOptions`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<ApplePurchaseOptions>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"urlOrPath":{"type":"string","description":"TypeScript: `string`"}},"required":["urlOrPath"],"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/apple/compareModels":{"post":{"operationId":"compareModels","summary":"Puts two or more models of the SAME family — Mac, iPhone, iPad or Apple Watch — side by side on the specs apple.com itself compares them on, straight off apple.com's own /<family>/compare/ grid; which","description":"Puts two or more models of the SAME family — Mac, iPhone, iPad or Apple Watch — side by side on the specs apple.com itself compares them on, straight off apple.com's own /<family>/compare/ grid; which family is read off the model names themselves, never a second argument. Model names must match the page's own naming exactly (e.g. \"iPhone 17 Pro\", not \"17 Pro\" or \"iphone17pro\"; \"MacBook Air 13-in. (M5)\", not \"MacBook Air\"); an unmatched name throws naming the page's own list, and names spanning two families throws too. Carries no price: apple.com's own compare page renders its Price row as an unfilled client-side template with no number in the static HTML, so this omits it rather than guess — read a price off getConfigurationOptions or getPurchaseOptions instead. A spec absent for one model (an older phone with no Dynamic Island) is simply missing from that model's own list, never a false \"no\".\n\nCalls `bowmark.providers.apple.compareModels`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<AppleCompareModels>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"models":{"type":"array","items":{"type":"string"},"description":"TypeScript: `string[]`"}},"required":["models"],"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/apple/listFamilyModels":{"post":{"operationId":"listFamilyModels","summary":"Lists every model apple.com currently sells in one product family — the chooser page's own cards (e.g.","description":"Lists every model apple.com currently sells in one product family — the chooser page's own cards (e.g. \"MacBook Air\", \"iPad mini\"), each with its starting price and the buy page that configures it. Takes \"mac\", \"iphone\", \"ipad\" or \"watch\" — apple.com publishes no equivalent chooser page for AirPods or Vision Pro, each sold as a single named model with no lineup to list.\n\nCalls `bowmark.providers.apple.listFamilyModels`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<AppleFamilyModelList>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"family":{"anyOf":[{"const":"mac"},{"const":"iphone"},{"const":"ipad"},{"const":"watch"}],"description":"TypeScript: `\"mac\" | \"iphone\" | \"ipad\" | \"watch\"`"}},"required":["family"],"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/apple/listRefurbished":{"post":{"operationId":"listRefurbished","summary":"Apple's own certified refurbished store, read as data: every listing currently in stock in one category, each with its real name, its current price and the part number that resolves it straight throug","description":"Apple's own certified refurbished store, read as data: every listing currently in stock in one category, each with its real name, its current price and the part number that resolves it straight through getProductByPartNumber. Stock turns over daily and a category can legitimately be empty when Apple has nothing left in it.\n\nCalls `bowmark.providers.apple.listRefurbished`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<AppleRefurbishedCatalog>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"category":{"anyOf":[{"const":"mac"},{"const":"ipad"},{"const":"iphone"},{"const":"watch"},{"const":"appletv"},{"const":"homepod"},{"const":"airpods"},{"const":"accessories"}],"description":"TypeScript: `\"mac\" | \"ipad\" | \"iphone\" | \"watch\" | \"appletv\" | \"homepod\" | \"airpods\" | \"accessories\"`"}},"required":["category"],"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/apple/listAccessories":{"post":{"operationId":"listAccessories","summary":"Everything Apple sells that is not a device, browsable by the sixteen categories apple.com's own accessories store uses — cases, chargers, headphones, drives, keyboards and the rest — each listing wit","description":"Everything Apple sells that is not a device, browsable by the sixteen categories apple.com's own accessories store uses — cases, chargers, headphones, drives, keyboards and the rest — each listing with its real name, current price and the part number that resolves it straight through getProductByPartNumber. Apple paginates this store server-side (up to 30 listings a page); `hasMore` says whether another page exists, since apple.com publishes no total count.\n\nCalls `bowmark.providers.apple.listAccessories`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<AppleAccessoryCatalog>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"category":{"anyOf":[{"const":"cases-protection"},{"const":"chargers-adapters"},{"const":"headphones-speakers"},{"const":"drives-storage"},{"const":"mice-keyboards"},{"const":"gaming"},{"const":"office"},{"const":"travel-essentials"},{"const":"college-essentials"},{"const":"software"},{"const":"homekit"},{"const":"content-creation"},{"const":"health-fitness"},{"const":"new-arrivals"},{"const":"made-by-apple"},{"const":"accessibility"}],"description":"TypeScript: `\"cases-protection\" | \"chargers-adapters\" | \"headphones-speakers\" | \"drives-storage\" | \"mice-keyboards\" | \"gaming\" | \"office\" | \"travel-essentials\" | \"college-essentials\" | \"software\" | \"homekit\" | \"content-creation\" | \"health-fitness\" | \"new-arrivals\" | \"made-by-apple\" | \"accessibility\"`"},"page":{"type":"number","description":"TypeScript: `number`"}},"required":["category"],"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/apple/getTradeInEstimate":{"post":{"operationId":"getTradeInEstimate","summary":"Reads apple.com's own trade-in value table and returns the CEILING (\"up to $X\") cash-or-credit estimate it publishes for one device — a human name (\"iPhone 14 Pro\") or the slug `phone_trade_in` alread","description":"Reads apple.com's own trade-in value table and returns the CEILING (\"up to $X\") cash-or-credit estimate it publishes for one device — a human name (\"iPhone 14 Pro\") or the slug `phone_trade_in` already normalizes to (\"iphone-14-pro\") both resolve. Apple publishes ONE number per device, not a matrix by storage or condition: the value is Apple's advertised best-case figure, not a quote for a specific unit's actual condition.\n\nCalls `bowmark.providers.apple.getTradeInEstimate`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<AppleTradeInEstimate>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"model":{"type":"string","description":"TypeScript: `string`"}},"required":["model"],"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/apple/listTradeInValues":{"post":{"operationId":"listTradeInValues","summary":"The whole Apple Trade In price list in one call.","description":"The whole Apple Trade In price list in one call. \"smartphone\" is the RICH catalog behind the estimator — every individual phone model apple.com will take, INCLUDING non-Apple ones (Samsung, Google, …), each with its own ceiling. \"computer\" and \"watch\" are coarser: a ceiling per product LINE (\"MacBook Pro\", \"Apple Watch Ultra 3\"), the same table getTradeInEstimate reads for iPhone. apple.com has no measured trade-in catalog for \"tablet\" at all — neither surface this function uses covers it.\n\nCalls `bowmark.providers.apple.listTradeInValues`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<AppleTradeInCatalog>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"category":{"anyOf":[{"const":"smartphone"},{"const":"computer"},{"const":"watch"}],"description":"TypeScript: `\"smartphone\" | \"computer\" | \"watch\"`"}},"required":["category"],"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/apple/searchSupport":{"post":{"operationId":"searchSupport","summary":"Searches Apple's own support library the way a person describes a problem (\"iphone battery draining\") and returns the articles Apple ranks for it — HelpKB pages, User Guide pages and Apple Support Com","description":"Searches Apple's own support library the way a person describes a problem (\"iphone battery draining\") and returns the articles Apple ranks for it — HelpKB pages, User Guide pages and Apple Support Community threads mixed in one list, each with its document id, title, URL and a plain-text snippet. A DOOR: the way into the support half of this provider before getSupportArticle reads one page in full.\n\nCalls `bowmark.providers.apple.searchSupport`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<AppleSupportSearchResponse>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"query":{"type":"string","description":"TypeScript: `string`"}},"required":["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/apple/getSupportArticle":{"post":{"operationId":"getSupportArticle","summary":"Reads one Apple support article end to end — the real instructions under its headline, not a search snippet — from the docid or URL one of searchSupport()'s own rows carries.","description":"Reads one Apple support article end to end — the real instructions under its headline, not a search snippet — from the docid or URL one of searchSupport()'s own rows carries. Opens a HelpKB article (docid or URL), a User Guide page (\"url\" field only — its own docid carries no URL apple.com could resolve), and an Apple Support Community thread (\"thread_<id>\" docid or a discussions.apple.com URL) — the last of those through a headless browser past discussions.apple.com's bot-verification redirect, since it is the door Apple ranks first for an ordinary problem. The read an agent reaches for once searchSupport has narrowed the problem to one page.\n\nCalls `bowmark.providers.apple.getSupportArticle`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<AppleSupportArticle>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"docidOrUrl":{"type":"string","description":"TypeScript: `string`"}},"required":["docidOrUrl"],"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/apple/resolveLocation":{"post":{"operationId":"resolveLocation","summary":"Turns the place a person said — \"cupertino\", \"san francisco\" — into the exact \"<city>, <state>\" string apple.com's own store and delivery lookups accept, off apple.com's own location typeahead.","description":"Turns the place a person said — \"cupertino\", \"san francisco\" — into the exact \"<city>, <state>\" string apple.com's own store and delivery lookups accept, off apple.com's own location typeahead. A DOOR HOP: the small step that makes findStoresNear, getPickupAvailability and getDeliveryEstimate callable from words alone instead of a pre-resolved location string.\n\nCalls `bowmark.providers.apple.resolveLocation`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<AppleResolvedLocation>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"place":{"type":"string","description":"TypeScript: `string`"}},"required":["place"],"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/apple/findStoresNear":{"post":{"operationId":"findStoresNear","summary":"Finds the Apple Stores near a place a person named — \"Cupertino\", \"94108\", \"San Francisco\" — with each store's name, number, city, state, address, phone and distance, nearest first.","description":"Finds the Apple Stores near a place a person named — \"Cupertino\", \"94108\", \"San Francisco\" — with each store's name, number, city, state, address, phone and distance, nearest first. The finder that turns a place into the store records every other retail function here takes, for a caller who holds no part number and must not have to invent one.\n\nCalls `bowmark.providers.apple.findStoresNear`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<AppleStoresNear>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"place":{"type":"string","description":"TypeScript: `string`"}},"required":["place"],"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/apple/getPickupAvailability":{"post":{"operationId":"getPickupAvailability","summary":"Answers the one question apple.com is uniquely able to answer: can I walk into a store today and pick this up.","description":"Answers the one question apple.com is uniquely able to answer: can I walk into a store today and pick this up. Give it a part number (or a /shop/ path or apple.com URL — resolved the same way getProduct's argument is) and a place, and it returns every nearby Apple Store with whether that exact configuration is in stock, the pickup window, and the store's name, number, address, phone and distance.\n\nCalls `bowmark.providers.apple.getPickupAvailability`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<ApplePickupAvailability>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"partNumber":{"type":"string","description":"TypeScript: `string`"},"place":{"type":"string","description":"TypeScript: `string`"}},"required":["partNumber","place"],"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/apple/getDeliveryEstimate":{"post":{"operationId":"getDeliveryEstimate","summary":"When would this actually arrive if ordered now, to a ZIP code — the shipping options and delivery dates apple.com quotes on the buy page for one exact configuration, without starting a checkout.","description":"When would this actually arrive if ordered now, to a ZIP code — the shipping options and delivery dates apple.com quotes on the buy page for one exact configuration, without starting a checkout. Takes a bare 5-digit ZIP, NOT the resolved place string getPickupAvailability takes: apple.com's own delivery-message endpoint reads a different parameter and ignores a \"<city>, <state>\" value entirely.\n\nCalls `bowmark.providers.apple.getDeliveryEstimate`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<AppleDeliveryEstimate>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"partNumber":{"type":"string","description":"TypeScript: `string`"},"postalCode":{"type":"string","description":"TypeScript: `string`"}},"required":["partNumber","postalCode"],"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/apple/listStores":{"post":{"operationId":"listStores","summary":"Every Apple Store in the US on one call — its name, its store number and its page — off apple.com's own store-locator directory, so a caller can browse or filter them rather than guess a slug.","description":"Every Apple Store in the US on one call — its name, its store number and its page — off apple.com's own store-locator directory, so a caller can browse or filter them rather than guess a slug. The store number is the SAME id findStoresNear and getPickupAvailability's rows carry, so a listing here joins straight to either.\n\nCalls `bowmark.providers.apple.listStores`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<AppleStoreList>`.","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/apple/getStore":{"post":{"operationId":"getStore","summary":"Read one Apple Store: its full address, phone number, map coordinates, store number and the hours it is open each day of the week — everything a person needs before driving there.","description":"Read one Apple Store: its full address, phone number, map coordinates, store number and the hours it is open each day of the week — everything a person needs before driving there. Takes a URL or /retail/ path, e.g. one of listStores()'s own rows.\n\nCalls `bowmark.providers.apple.getStore`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<AppleStore>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"urlOrPath":{"type":"string","description":"TypeScript: `string`"}},"required":["urlOrPath"],"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/apple/listTodaySessions":{"post":{"operationId":"listTodaySessions","summary":"The free Today at Apple sessions one store is running, with each one's title, description, start/end time and RSVP status — off the store's own calendar page.","description":"The free Today at Apple sessions one store is running, with each one's title, description, start/end time and RSVP status — off the store's own calendar page. Takes a bare store slug (\"unionsquare\") or a URL/path from listStores() or getStore()'s own rows.\n\nCalls `bowmark.providers.apple.listTodaySessions`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<AppleTodaySessionList>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"storeSlugOrUrl":{"type":"string","description":"TypeScript: `string`"}},"required":["storeSlugOrUrl"],"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/apple/listNewsroomPosts":{"post":{"operationId":"listNewsroomPosts","summary":"Apple's official announcements, newest first, off its own published RSS feed — every product launch, financial result and press release, with its headline, category, publish date and link.","description":"Apple's official announcements, newest first, off its own published RSS feed — every product launch, financial result and press release, with its headline, category, publish date and link. The primary source for \"what did Apple just announce\", with no publisher in between.\n\nCalls `bowmark.providers.apple.listNewsroomPosts`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<AppleNewsroomPostList>`.","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/apple/getNewsroomPost":{"post":{"operationId":"getNewsroomPost","summary":"Read one Apple press release or announcement in full from its URL — the article text itself, not the feed's one-line summary.","description":"Read one Apple press release or announcement in full from its URL — the article text itself, not the feed's one-line summary. Takes a URL straight off listNewsroomPosts()'s own rows.\n\nCalls `bowmark.providers.apple.getNewsroomPost`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<AppleNewsroomArticle>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string","description":"TypeScript: `string`"}},"required":["url"],"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/apple/getSystemStatus":{"post":{"operationId":"getSystemStatus","summary":"Is App Store / iCloud / FaceTime / Apple Music down right now — apple.com's own machine-readable status feed, straight off the same JSON the System Status page renders.","description":"Is App Store / iCloud / FaceTime / Apple Music down right now — apple.com's own machine-readable status feed, straight off the same JSON the System Status page renders. \"consumer\" (the default) covers the everyday services; \"developer\" reads the separate feed for App Store Connect, APNS and TestFlight. Every service that is healthy carries an empty events list, which is the ordinary answer on an ordinary day, not a sign this failed — check this before reporting any other apple.com read as broken.\n\nCalls `bowmark.providers.apple.getSystemStatus`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<AppleSystemStatus>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"scope":{"anyOf":[{"const":"consumer"},{"const":"developer"}],"description":"TypeScript: `\"consumer\" | \"developer\"`"}},"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/apple/getRepairPricing":{"post":{"operationId":"getRepairPricing","summary":"What Apple charges to fix a device, per model and per kind of damage — straight off the same widget the site's own repair pages render.","description":"What Apple charges to fix a device, per model and per kind of damage — straight off the same widget the site's own repair pages render. Returns BOTH plans for every model: out-of-warranty (paying without AppleCare+) and AppleCare+ pricing, which cover different damage categories and are never merged into one figure. Mac is not offered — apple.com prices Mac service after an in-person diagnosis, not off a public list.\n\nCalls `bowmark.providers.apple.getRepairPricing`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<AppleRepairPricing>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"device":{"anyOf":[{"const":"iphone"},{"const":"ipad"},{"const":"watch"}],"description":"TypeScript: `\"iphone\" | \"ipad\" | \"watch\"`"}},"required":["device"],"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/apple/getOrderStatus":{"post":{"operationId":"getOrderStatus","summary":"Where is one Apple order, off the signed-in Order List page — NEEDS THE CALLER SIGNED IN (Apple has no guest order lookup: order/guest, order/status and order/track are all bare 404s).","description":"Where is one Apple order, off the signed-in Order List page — NEEDS THE CALLER SIGNED IN (Apple has no guest order lookup: order/guest, order/status and order/track are all bare 404s). `raw` carries whatever apple.com's order-list bootstrap holds for the matching order number — the exact field shape is UNMEASURED (no fleet-held Apple Account session exists to capture one from), so read it defensively rather than trusting fixed field names.\n\nCalls `bowmark.providers.apple.getOrderStatus`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<AppleOrderStatus>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"orderNumber":{"type":"string","description":"TypeScript: `string`"},"opts":{"type":"object","properties":{"connection":{"type":"string"}},"required":["connection"],"additionalProperties":true,"description":"TypeScript: `ConnectionOption`"}},"required":["orderNumber"],"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/apple/listOrders":{"post":{"operationId":"listOrders","summary":"Everything I have bought from Apple, off the signed-in Order List page — NEEDS THE CALLER SIGNED IN, the same door and the same wall as getOrderStatus (Apple has no guest order history at all).","description":"Everything I have bought from Apple, off the signed-in Order List page — NEEDS THE CALLER SIGNED IN, the same door and the same wall as getOrderStatus (Apple has no guest order history at all). `raw` carries the order-list page's own data payload verbatim — the exact field shape is UNMEASURED (no fleet-held Apple Account session exists to capture one from), so read it defensively rather than trusting fixed field names.\n\nCalls `bowmark.providers.apple.listOrders`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<AppleOrderList>`.","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/apple/checkCoverage":{"post":{"operationId":"checkCoverage","summary":"What warranty or AppleCare a device still has, from its serial number — NO sign-in needed (apple.com's own captcha-gated lookup, solved automatically).","description":"What warranty or AppleCare a device still has, from its serial number — NO sign-in needed (apple.com's own captcha-gated lookup, solved automatically). `found: false` with `errorToken: \"INVALID_SERIAL_NUMBER\"` is a real, complete answer for a serial Apple does not recognize. `found: true`'s `raw` field is UNMEASURED — no real Apple serial has been tried against this chain — so it carries the result page's own markup rather than typed fields; read it defensively.\n\nCalls `bowmark.providers.apple.checkCoverage`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<AppleCoverageResult>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"serial":{"type":"string","description":"TypeScript: `string`"}},"required":["serial"],"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/apple/bookGeniusBarAppointment":{"post":{"operationId":"bookGeniusBarAppointment","summary":"Submit a Genius Bar / repair reservation's confirmation step — NEEDS THE CALLER SIGNED IN.","description":"Submit a Genius Bar / repair reservation's confirmation step — NEEDS THE CALLER SIGNED IN. A THIN PASSTHROUGH, not a guided wizard: getsupport.apple.com's reservation wizard (facade/topics -> facade/solutions -> facade/timeslots -> facade/timeslots/lock) has never been walked with a real signed-in Apple Account session, so this cannot resolve a topic, product or store into the ids the confirmation step needs. `authToken` is the X-APPLE-AUTH-TOKEN bearer (the signed-in session's own jwtToken) and `body` is the confirmation payload (solutionType, caseId, formDetails, selectedSolutionTriggers, the *ConfirmationRequest objects, …) — both read off the caller's own browser session, which has already walked the wizard. Sent verbatim to POST /api/v1/facade/solution/execute, real field names measured off getsupport.apple.com's own bundle. `raw` is UNMEASURED — no real booking has been submitted through this door — so it carries the site's own confirmation response rather than invented fields.\n\nCalls `bowmark.providers.apple.bookGeniusBarAppointment`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<AppleGeniusBarBookingResult>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"request":{"type":"object","properties":{"locale":{"type":"string"},"authToken":{"type":"string"},"body":{"type":"object","additionalProperties":{}}},"required":["locale","authToken","body"],"additionalProperties":true,"description":"TypeScript: `{ locale: string; authToken: string; body: Record<string, unknown> }`"},"opts":{"type":"object","properties":{"connection":{"type":"string"}},"required":["connection"],"additionalProperties":true,"description":"TypeScript: `ConnectionOption`"}},"required":["request"],"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/apple/addToBag":{"post":{"operationId":"addToBag","summary":"Add a product to the shopping bag (cart) by part number — NEEDS THE CALLER'S OWN BAG WIDGET SESSION.","description":"Add a product to the shopping bag (cart) by part number — NEEDS THE CALLER'S OWN BAG WIDGET SESSION. A GET to /<storefront>/shop/bag/add, the Bag widget's own API: `part` is the product's part number, `atbtoken` is the widget's bearer read off the `as_atb` cookie, `apiKey` is `config.storeApiKey` and `storefront` is `config.storefront` — all four baked into the running buy page at load time and read off the caller's own browser session, never computed or captured here. Returns the site's own `{addedToBag, bagQuantity, errorCode, message}` envelope verbatim.\n\nCalls `bowmark.providers.apple.addToBag`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<AppleAddToBagResult>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"request":{"$ref":"#/components/schemas/AppleAddToBagRequest","description":"TypeScript: `AppleAddToBagRequest`"}},"required":["request"],"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/apple/getBag":{"post":{"operationId":"getBag","summary":"What's in the shopping bag right now, no sign-in needed — reads /shop/bag's own #init_data bootstrap (the same envelope getOrderStatus/listOrders already parse).","description":"What's in the shopping bag right now, no sign-in needed — reads /shop/bag's own #init_data bootstrap (the same envelope getOrderStatus/listOrders already parse). `hasItems` is real and reliable. This provider cannot populate a bag browserless (addToBag needs the caller's own widget session, per AppleAddToBagRequest), so every call this provider makes starts a fresh anonymous bag and `raw`'s item-level shape is UNMEASURED — read it defensively.\n\nCalls `bowmark.providers.apple.getBag`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<AppleBagContents>`.","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/apple/removeFromBag":{"post":{"operationId":"removeFromBag","summary":"Remove an item from the shopping bag by its UUID.","description":"Remove an item from the shopping bag by its UUID. Takes the item's UUID from getBag's raw output and the CSRF token from the bag page's meta tag. Returns success confirmation.\n\nCalls `bowmark.providers.apple.removeFromBag`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<AppleRemoveFromBagResult>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"request":{"$ref":"#/components/schemas/AppleRemoveFromBagRequest","description":"TypeScript: `AppleRemoveFromBagRequest`"}},"required":["request"],"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}}},"AppleAddToBagRequest":{"type":"object","properties":{"part":{"type":"string"},"atbtoken":{"type":"string"},"apiKey":{"type":"string"},"storefront":{"type":"string"},"options":{"type":"object","additionalProperties":{}}},"required":["part","atbtoken","apiKey","storefront"],"additionalProperties":true},"AppleRemoveFromBagRequest":{"type":"object","properties":{"itemUuid":{"type":"string"},"csrfToken":{"type":"string"}},"required":["itemUuid","csrfToken"],"additionalProperties":true}}}}