{"openapi":"3.1.0","info":{"title":"Bing API (Bowmark)","version":"e833508f87ff","description":"General web and news search over Bing's index, read off Bing's own RSS output — ten ranked results per query with title, destination URL, snippet and date. Keyless, browserless, ~5 KB a call. Web never reports 'no matches' and ignores search operators like site:. News can be empty, but OR-joined or more-than-three-term queries are unsupported and are warned as malformed instead of retried.\n\nEvery function Bowmark has for Bing (bing.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/bing/searchWeb":{"post":{"operationId":"searchWeb","summary":"Searches the web and returns the ten results Bing ranked first, with title, destination URL, snippet and date.","description":"Searches the web and returns the ten results Bing ranked first, with title, destination URL, snippet and date. Passing `limit` over 10 fetches further pages too — bing's RSS feed and its HTML page both ignore a `first=` offset and answer the identical page 1 again (measured 2026-10-25), so rows past the tenth come from a browser rung following the page's own \"Next page\" link, deduped by url against page 1. That link is itself unreliable — about one run in four it also replays page 1 — so a `limit` over 10 can still come back short, with a warning saying whether the browser call failed or bing genuinely ran out of pages; never read a short answer as a cap. THREE FURTHER LIMITS, present whatever `limit` is. (1) It NEVER returns an empty list — a query of three invented words came back with ten confident, unrelated rows, and a long-tail query (an obscure company name plus \"pricing\", say) can get the same substituted treatment. (2) It IGNORES search operators, so `site:reddit.com …` is not scoped to reddit. (3) MEASURED 2026-09-11, and the one that hits ordinary research: it answers a MULTI-WORD query by reducing it to the single most popular word in it and returning that word's results — \"React useEffect dependency array\" comes back as React's own homepage, and a nine-word query naming a company, a job and a protocol came back as the results for the one two-letter acronym in it. Quoting the proper noun, shortening the query and site-scoping it were all tried and all returned the identical substituted set, so rewriting the query does not help. `warnings` flags five shapes. Four read the words: no row sharing a single word with the query, every row matching only a generic word like \"pricing\" while the thing you named is absent, or fewer than half the query's subject words appearing anywhere in the results, or a NAME you gave — a place, a person, a brand, capitalised or after \"in\"/\"near\" — that no row carries (measured 2026-10-27: \"coffee shops in Lisbon\" answered coffee shops in Nashville, localised to the exit). The fifth reads Bing's own behaviour and is the reliable one — the query is asked TWICE down the same exit, and an answer that differs the second time is a random decoy, because a query Bing can actually answer is stable across repeats (measured 2026-09-12: 1.00 repeat overlap on every answerable query, 0.00 on every unanswerable one, nothing in between). A partially-relevant result set is still not caught, so treat the rows as Bing's best offer rather than as proof anything matched.\n\nCalls `bowmark.providers.bing.searchWeb`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<BingSearchResult>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"type":"object","properties":{"query":{"type":"string"},"limit":{"type":"number"}},"required":["query"],"additionalProperties":true,"description":"TypeScript: `{ query: string, limit?: number }`"}},"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/bing/searchWebBrowser":{"post":{"operationId":"searchWebBrowser","summary":"Searches the web through a browser to bing.com instead of reading the RSS feed — same results shape.","description":"Searches the web through a browser to bing.com instead of reading the RSS feed — same results shape. It does NOT fix relevance: measured 2026-09-12 from the fleet's own egress, it substitutes on exactly the queries the RSS feed substitutes on, on a residential exit and a datacenter one alike (the earlier claim that a browser answers multi-word queries correctly was measured from a laptop and confounded the client with the network). Kept as a standby that can rescue a query the primary drops. Expensive: holds a browser pool slot for ~4s per call. Use searchWeb instead, and let the search capability choose when to fall back to this version.\n\nCalls `bowmark.providers.bing.searchWebBrowser`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<BingSearchResult>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"type":"object","properties":{"query":{"type":"string"},"limit":{"type":"number"}},"required":["query"],"additionalProperties":true,"description":"TypeScript: `{ query: string, limit?: number }`"}},"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/bing/searchNews":{"post":{"operationId":"searchNews","summary":"Searches news coverage and returns stories with the headline, the outlet's own article URL, a summary, a real publication timestamp, the publisher name and a thumbnail.","description":"Searches news coverage and returns stories with the headline, the outlet's own article URL, a summary, a real publication timestamp, the publisher name and a thumbnail. Use this rather than searchWeb when the question is 'what happened' — the web feed's dates are Bing's crawl stamps, this feed's are the story's. Keep each query to 2–3 words: OR-joined and more-than-three-term queries return an empty feed and are warned as unsupported, so split them into separate calls rather than retrying.\n\nCalls `bowmark.providers.bing.searchNews`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<BingNewsSearchResult>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"type":"object","properties":{"query":{"type":"string"},"limit":{"type":"number"}},"required":["query"],"additionalProperties":true,"description":"TypeScript: `{ query: string, limit?: number }`"}},"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/bing/searchImages":{"post":{"operationId":"searchImages","summary":"Searches Bing's image index and returns each hit's thumbnail URL, full-size image URL, the page it was found on, and its title.","description":"Searches Bing's image index and returns each hit's thumbnail URL, full-size image URL, the page it was found on, and its title. Core because a caller sent to Bing to find a picture of something has no other function to reach for.\n\nCalls `bowmark.providers.bing.searchImages`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<BingImageSearchResult>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"type":"object","properties":{"query":{"type":"string"},"limit":{"type":"number"}},"required":["query"],"additionalProperties":true,"description":"TypeScript: `{ query: string, limit?: number }`"}},"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/bing/searchVideos":{"post":{"operationId":"searchVideos","summary":"Searches Bing's video index and returns each hit's title, destination URL, thumbnail, and duration.","description":"Searches Bing's video index and returns each hit's title, destination URL, thumbnail, and duration. Core because a caller sent to Bing to find a video of something has no other function to reach for.\n\nCalls `bowmark.providers.bing.searchVideos`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<BingVideoSearchResult>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"type":"object","properties":{"query":{"type":"string"},"limit":{"type":"number"}},"required":["query"],"additionalProperties":true,"description":"TypeScript: `{ query: string, limit?: number }`"}},"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/bing/searchShopping":{"post":{"operationId":"searchShopping","summary":"Searches Bing Shopping and returns each product's title, price, merchant, star rating and thumbnail — the retail-comparison read for 'who sells X and for how much'.","description":"Searches Bing Shopping and returns each product's title, price, merchant, star rating and thumbnail — the retail-comparison read for 'who sells X and for how much'. `url` is Bing's OWN listing page for the offer (`/shop/productdetails?…`), never the merchant's — the grid never carries the merchant's own product URL, only the retailer's name.\n\nCalls `bowmark.providers.bing.searchShopping`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<BingShoppingSearchResult>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"type":"object","properties":{"query":{"type":"string"},"limit":{"type":"number"}},"required":["query"],"additionalProperties":true,"description":"TypeScript: `{ query: string, limit?: number }`"}},"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/bing/define":{"post":{"operationId":"define","summary":"Looks up a word in Bing's dictionary and returns its definitions grouped by part of speech, example sentences, and phonetic information when available — the reference read for 'what does this word mea","description":"Looks up a word in Bing's dictionary and returns its definitions grouped by part of speech, example sentences, and phonetic information when available — the reference read for 'what does this word mean'.\n\nCalls `bowmark.providers.bing.define`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<BingDictEntry>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"word":{"type":"string","description":"TypeScript: `string`"}},"required":["word"],"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/bing/translateText":{"post":{"operationId":"translateText","summary":"Translates text through Bing Translator to a specified target language and returns the translated result and the detected source language when auto-detected.","description":"Translates text through Bing Translator to a specified target language and returns the translated result and the detected source language when auto-detected. The `to` parameter is required and sets the target language code (e.g., 'es', 'fr', 'ja'). The `from` parameter is optional — Bing detects the source language if omitted.\n\nCalls `bowmark.providers.bing.translateText`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<BingTranslationResult>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"type":"object","properties":{"text":{"type":"string"},"to":{"type":"string"},"from":{"type":"string"}},"required":["text","to"],"additionalProperties":true,"description":"TypeScript: `{ text: string, to: string, from?: string }`"}},"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/bing/findPlace":{"post":{"operationId":"findPlace","summary":"Looks up a place on Bing Maps by name or address and returns its name, full address, latitude/longitude coordinates, and category — the door function a caller holding a place name needs before any map","description":"Looks up a place on Bing Maps by name or address and returns its name, full address, latitude/longitude coordinates, and category — the door function a caller holding a place name needs before any maps read that requires a location.\n\nCalls `bowmark.providers.bing.findPlace`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<BingMapsFindPlaceResult>`.","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/bing/searchPlaces":{"post":{"operationId":"searchPlaces","summary":"Searches Bing Maps and returns every place result rendered for the query ('coffee shops near Pike Place' wants several places, not one), each with name, address, coordinates, category, rating, rating ","description":"Searches Bing Maps and returns every place result rendered for the query ('coffee shops near Pike Place' wants several places, not one), each with name, address, coordinates, category, rating, rating count, phone, website and open-hours text when Bing publishes them. The same page findPlace reads, read in full rather than taking only the first card.\n\nCalls `bowmark.providers.bing.searchPlaces`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<BingMapsSearchPlacesResult>`.","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/bing/listSaves":{"post":{"operationId":"listSaves","summary":"Lists the pages, searches and images the signed-in caller has saved to Bing Collections (bing.com/saves) — the browser-parity read for an account feature a signed-in visitor uses every day.","description":"Lists the pages, searches and images the signed-in caller has saved to Bing Collections (bing.com/saves) — the browser-parity read for an account feature a signed-in visitor uses every day. Needs the caller's own Bing sign-in through the relay; Bowmark never creates a Microsoft account. Returns an empty list for an honestly empty collection, same as the site.\n\nCalls `bowmark.providers.bing.listSaves`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<BingListSavesResult>`.","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/bing/saveResult":{"post":{"operationId":"saveResult","summary":"Adds a page, search or image to the signed-in caller's Bing Collections (bing.com/saves) — the write half of listSaves.","description":"Adds a page, search or image to the signed-in caller's Bing Collections (bing.com/saves) — the write half of listSaves. Needs the caller's own Bing sign-in through the relay; Bowmark never creates a Microsoft account. Saving the same url twice in one run is a no-op the second time (idempotent per run), not two saved items.\n\nCalls `bowmark.providers.bing.saveResult`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<BingSaveResultResult>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"type":"object","properties":{"url":{"type":"string"},"title":{"type":"string"},"note":{"type":"string"}},"required":["url","title"],"additionalProperties":true,"description":"TypeScript: `{ url: string, title: string, note?: string }`"},"opts":{"type":"object","properties":{"connection":{"type":"string"}},"required":["connection"],"additionalProperties":true,"description":"TypeScript: `ConnectionOption`"}},"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/bing/suggestQueries":{"post":{"operationId":"suggestQueries","summary":"Returns what Bing's own search-box autocomplete suggests for a partial query — 'what are people searching about X' — ranked, off the same endpoint the search box itself calls.","description":"Returns what Bing's own search-box autocomplete suggests for a partial query — 'what are people searching about X' — ranked, off the same endpoint the search box itself calls. May return an empty list for a fragment Bing has nothing to suggest for; that is an honest answer, not a failure.\n\nCalls `bowmark.providers.bing.suggestQueries`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<BingSuggestResult>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"partialQuery":{"type":"string","description":"TypeScript: `string`"}},"required":["partialQuery"],"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}}}}}}