{"openapi":"3.1.0","info":{"title":"MSN API (Bowmark)","version":"e833508f87ff","description":"MSN's news portal — top stories, section feeds, article text, money quotes and weather, logged out.\n\nEvery function Bowmark has for MSN (msn.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/msn/getTopStories":{"post":{"operationId":"getTopStories","summary":"Returns the top stories the MSN front page is showing right now, the way www.msn.com does for a visitor with no account: each story's headline, its own outlet's byline, the outlet name, a summary, pub","description":"Returns the top stories the MSN front page is showing right now, the way www.msn.com does for a visitor with no account: each story's headline, its own outlet's byline, the outlet name, a summary, publish time and a thumbnail. This is the general 'what's happening' read — the entry point for anything that starts with the portal's own front-page mix rather than a specific query. `type` is `article` or `video`; a video card carries no `readTimeMin`. A bare number is `limit`, which slices the answer client-side — the feed door itself has no page-size parameter, so a lower limit costs the same one request. `nextPageUrl` is the site's own pagination cursor — a run script has no `fetch` of its own, so pass it back as `{ cursor }` to THIS SAME function to read the next ten, never to a plain GET. `null` when the site reports no further page.\n\nCalls `bowmark.providers.msn.getTopStories`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<MsnTopStories>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"limitOrOptions":{"anyOf":[{"type":"number"},{"type":"object","properties":{"limit":{"type":"number"},"cursor":{"type":"string"}},"additionalProperties":true}],"description":"TypeScript: `number | { limit?: number; cursor?: string }`"}},"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/msn/searchNews":{"post":{"operationId":"searchNews","summary":"Searches MSN's own aggregated news index the way its front-page search does and returns matching stories in the same shape as getTopStories — headline, outlet, summary, publish time, thumbnail.","description":"Searches MSN's own aggregated news index the way its front-page search does and returns matching stories in the same shape as getTopStories — headline, outlet, summary, publish time, thumbnail. Distinct from a general web search: MSN only returns coverage it has actually aggregated from its publisher network, never the wider web. There is no separate search route — `query` steers the same feed door getTopStories reads, so the result set is whatever that door currently returns for the term. `nextPageUrl` from a prior call passed back as `{ cursor }` reads the next ten — `query` is still required but ignored once a cursor is given, since the site's own cursor already carries it.\n\nCalls `bowmark.providers.msn.searchNews`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<MsnTopStories>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"query":{"type":"string","description":"TypeScript: `string`"},"options":{"type":"object","properties":{"cursor":{"type":"string"}},"additionalProperties":true,"description":"TypeScript: `{ cursor?: 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/msn/getSectionFeed":{"post":{"operationId":"getSectionFeed","summary":"Returns a top-stories feed scoped to one of six sections — sports, entertainment, health, lifestyle, travel, autos — by using the section name as a search term against the same feed door searchNews re","description":"Returns a top-stories feed scoped to one of six sections — sports, entertainment, health, lifestyle, travel, autos — by using the section name as a search term against the same feed door searchNews reads. Measured 2026-09-23: the site's OWN section pages fire an identical, unscoped request for all six, so there is no section-specific door to call; measured 2026-11-01: steering that door's own `query` parameter with the section name works instead (e.g. `query=sports` returns NFL/F1/NBA coverage), the way `searchNews(\"sports\")` would. \"money\" and \"weather\" are not article-feed sections at all (their pages are server-rendered quote/forecast data) — use getMarketSummary, getStockQuote or getWeatherForecast. \"video\" is its own feed — use getVideoFeed. `nextPageUrl` from a prior call passed back as `{ cursor }` reads the next ten.\n\nCalls `bowmark.providers.msn.getSectionFeed`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<MsnTopStories>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"section":{"anyOf":[{"const":"sports"},{"const":"entertainment"},{"const":"health"},{"const":"lifestyle"},{"const":"travel"},{"const":"autos"}],"description":"TypeScript: `\"sports\" | \"entertainment\" | \"health\" | \"lifestyle\" | \"travel\" | \"autos\"`"},"options":{"type":"object","properties":{"cursor":{"type":"string"}},"additionalProperties":true,"description":"TypeScript: `{ cursor?: string }`"}},"required":["section"],"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/msn/getArticle":{"post":{"operationId":"getArticle","summary":"Reads one MSN article's full text, byline, publish time and images off its own article URL — the door every other read hands a caller: getTopStories, searchNews and getSectionFeed each return a `url` ","description":"Reads one MSN article's full text, byline, publish time and images off its own article URL — the door every other read hands a caller: getTopStories, searchNews and getSectionFeed each return a `url` that only this function can turn into the actual story. A caller holding a headline and nothing else cannot reach the body without it. `byline` and `publishedDateTime` are `null` when the page carries neither.\n\nCalls `bowmark.providers.msn.getArticle`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<MsnArticle>`.","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/msn/getStandings":{"post":{"operationId":"getStandings","summary":"Returns one league's current standings table the way msn.com/en-us/sports/<league>/standings shows it to a visitor with no account: every team with its conference and division, ranks, wins/losses/ties","description":"Returns one league's current standings table the way msn.com/en-us/sports/<league>/standings shows it to a visitor with no account: every team with its conference and division, ranks, wins/losses/ties, win percentage, games back, table points, streak and last-10 record. `league` is nfl, nba, nhl, mlb, epl, laliga, bundesliga, seriea or ligue1 (MSN serves no standings for MLS or college football). Filter `rows` by `conference` or `division` for one group.\n\nCalls `bowmark.providers.msn.getStandings`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<MsnStandings>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"$ref":"#/components/schemas/MsnStandingsArgs","description":"TypeScript: `MsnStandingsArgs`"}},"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/msn/getStockQuote":{"post":{"operationId":"getStockQuote","summary":"Reads one ticker's current price, day range, 52-week range, volume, market cap and P/E off MSN Money the way msn.com/en-us/money/stockdetails does for a visitor with no account.","description":"Reads one ticker's current price, day range, 52-week range, volume, market cap and P/E off MSN Money the way msn.com/en-us/money/stockdetails does for a visitor with no account. Resolves `symbol` (e.g. \"AAPL\") to MSN's own internal instrument first, then reads its quote — a company name works too, the same way MSN's own search box takes one. `averageVolume`, `marketCap`, `marketCapCurrency` and `peRatio` are `null` for a non-equity instrument (an index, most notably from getMarketSummary — those fields do not apply). Throws a caller-fixable error when the ticker is not one MSN indexes.\n\nCalls `bowmark.providers.msn.getStockQuote`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<MsnStockQuote>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"symbol":{"type":"string","description":"TypeScript: `string`"}},"required":["symbol"],"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/msn/convertCurrency":{"post":{"operationId":"convertCurrency","summary":"Converts an amount between two currencies at MSN Money's live FX cross rate, the rate msn.com/en-us/money/tools/currencyconverter shows: e.g.","description":"Converts an amount between two currencies at MSN Money's live FX cross rate, the rate msn.com/en-us/money/tools/currencyconverter shows: e.g. `{ from: \"USD\", to: \"EUR\", amount: 500 }` returns the rate, the converted amount and when the rate last traded. Codes are three-letter ISO (USD, EUR, GBP, JPY, INR …); `amount` defaults to 1. Throws a caller-fixable error when MSN lists no rate for the pair.\n\nCalls `bowmark.providers.msn.convertCurrency`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<MsnCurrencyConversion>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"$ref":"#/components/schemas/MsnConvertCurrencyArgs","description":"TypeScript: `MsnConvertCurrencyArgs`"}},"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/msn/getMarketSummary":{"post":{"operationId":"getMarketSummary","summary":"Reads the Dow Jones Industrial Average, S&P 500 and NASDAQ Composite — the same three index levels and day's change msn.com/en-us/money's own \"Popular\" strip shows first for a visitor with no account ","description":"Reads the Dow Jones Industrial Average, S&P 500 and NASDAQ Composite — the same three index levels and day's change msn.com/en-us/money's own \"Popular\" strip shows first for a visitor with no account — the door a caller asking 'how are markets doing' reaches for before naming any one ticker. Same MsnStockQuote shape getStockQuote returns per index; `averageVolume`, `marketCap`, `marketCapCurrency` and `peRatio` are `null` on all three (indices don't carry them).\n\nCalls `bowmark.providers.msn.getMarketSummary`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<MsnMarketSummary>`.","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/msn/getWeatherForecast":{"post":{"operationId":"getWeatherForecast","summary":"Reads the 10-day forecast for a named city off MSN Weather the way msn.com/en-us/weather/forecast/in-<City>,<ST> does for a visitor with no account: current temperature and condition, then per day a h","description":"Reads the 10-day forecast for a named city off MSN Weather the way msn.com/en-us/weather/forecast/in-<City>,<ST> does for a visitor with no account: current temperature and condition, then per day a high/low, condition, day and night precipitation chance, rain/snow amount and the site's own summary sentence. `location` is a city, optionally with a 2-letter state, e.g. \"Seattle, WA\" or \"Seattle\". Throws when MSN cannot resolve the name and would otherwise fall back to guessing a location from the caller's own network address — never silently returns weather for the wrong place.\n\nCalls `bowmark.providers.msn.getWeatherForecast`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<MsnWeatherForecast>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"location":{"type":"string","description":"TypeScript: `string`"}},"required":["location"],"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/msn/getHourlyForecast":{"post":{"operationId":"getHourlyForecast","summary":"Reads the hour-by-hour forecast for a named city off MSN Weather's hourly page, starting with the current hour: temperature, feels-like, condition, precipitation chance, humidity and wind for each hou","description":"Reads the hour-by-hour forecast for a named city off MSN Weather's hourly page, starting with the current hour: temperature, feels-like, condition, precipitation chance, humidity and wind for each hour. `options.hours` is how many hours to return, 1-240 (default 24). `location` is a city, optionally with a 2-letter state, e.g. \"Denver, CO\". Throws when MSN cannot resolve the name rather than returning weather for the caller's own network location.\n\nCalls `bowmark.providers.msn.getHourlyForecast`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<MsnHourlyForecast>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"location":{"type":"string","description":"TypeScript: `string`"},"options":{"$ref":"#/components/schemas/MsnHourlyOptions","description":"TypeScript: `MsnHourlyOptions`"}},"required":["location"],"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/msn/listSavedArticles":{"post":{"operationId":"listSavedArticles","summary":"Lists the articles the signed-in caller has saved to their MSN reading list — the browser-parity read for an account feature a signed-in visitor uses every day.","description":"Lists the articles the signed-in caller has saved to their MSN reading list — the browser-parity read for an account feature a signed-in visitor uses every day. NEEDS A SIGN-IN: the caller signs in to MSN with their own Microsoft account through the relay, never a Bowmark one. Each row's `url` goes straight into getArticle. `metadata` is whatever MSN stored beside the save, passed through unchanged. Throws a sign-in error rather than an empty list when the saved sign-in no longer carries MSN's session cookie, because MSN itself answers a stranger with an empty list.\n\nCalls `bowmark.providers.msn.listSavedArticles`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<MsnSavedArticles>`.","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/msn/saveArticle":{"post":{"operationId":"saveArticle","summary":"Adds an article to the signed-in caller's MSN reading list — the write half of listSavedArticles.","description":"Adds an article to the signed-in caller's MSN reading list — the write half of listSavedArticles. NEEDS A SIGN-IN: the caller signs in to MSN with their own Microsoft account through the relay, never a Bowmark one. `articleId` is the `ar-<id>` segment of an article URL, or the `articleId` a listSavedArticles/getArticle row already carries. Throws a sign-in error when the saved sign-in no longer carries MSN's session cookie.\n\nCalls `bowmark.providers.msn.saveArticle`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<MsnSaveArticleResult>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"$ref":"#/components/schemas/MsnSaveArticleArgs","description":"TypeScript: `MsnSaveArticleArgs`"},"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/msn/getVideoFeed":{"post":{"operationId":"getVideoFeed","summary":"Lists the videos MSN's video section (www.msn.com/en-us/video) shows a visitor with no account: title, outlet, summary, publish time, thumbnail, duration in seconds, a direct mp4 link and a captions l","description":"Lists the videos MSN's video section (www.msn.com/en-us/video) shows a visitor with no account: title, outlet, summary, publish time, thumbnail, duration in seconds, a direct mp4 link and a captions link where the site has them. `url` is the video's own MSN page. `limit` is 5, 10 or 20 (default 10). Pass a prior call's `nextPageUrl` back as `{ cursor }` to read the next page.\n\nCalls `bowmark.providers.msn.getVideoFeed`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<MsnVideoFeed>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"options":{"$ref":"#/components/schemas/MsnVideoFeedOptions","description":"TypeScript: `MsnVideoFeedOptions`"}},"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/msn/getPlayback":{"post":{"operationId":"getPlayback","summary":"Returns every measured way to play one MSN video: all of MSN's direct progressive MP4 files, one per rendition, in the site's muxed menu.","description":"Returns every measured way to play one MSN video: all of MSN's direct progressive MP4 files, one per rendition, in the site's muxed menu. The files play without MSN's player chrome or ads and the model can choose the resolution; MSN's iframe embed is not included yet because its embed URL has not been measured. `video` is an MSN `/vi-<id>` URL or the id from getVideoFeed.\n\nCalls `bowmark.providers.msn.getPlayback`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<MsnPlayback>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"$ref":"#/components/schemas/MsnGetPlaybackArgs","description":"TypeScript: `MsnGetPlaybackArgs`"}},"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/msn/searchVideos":{"post":{"operationId":"searchVideos","summary":"Finds videos in MSN's video section by a topic the caller types (e.g.","description":"Finds videos in MSN's video section by a topic the caller types (e.g. \"apollo 11 moon landing\"), returning the same rows getVideoFeed returns: title, outlet, summary, publish time, thumbnail, duration in seconds, a direct mp4 link and the video's MSN page. `limit` is 5, 10 or 20 (default 10); pass `nextPageUrl` back as `{ cursor }` for more. A topic MSN's video index has nothing on returns an empty `videos` list — MSN's video index is narrower than its news search, so broad one-word topics often return nothing; a specific phrase works better.\n\nCalls `bowmark.providers.msn.searchVideos`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<MsnVideoFeed>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"query":{"type":"string","description":"TypeScript: `string`"},"options":{"$ref":"#/components/schemas/MsnVideoFeedOptions","description":"TypeScript: `MsnVideoFeedOptions`"}},"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/msn/getScores":{"post":{"operationId":"getScores","summary":"Returns one league's games on one date the way MSN Sports' scores page does for a visitor with no account: each game's start time, status (e.g.","description":"Returns one league's games on one date the way MSN Sports' scores page does for a visitor with no account: each game's start time, status (e.g. Final, Scheduled, or the live period), venue, TV channels and both teams with name, abbreviation, home/away, score, won/lost and season record. `league` is nfl, nba, nhl, mlb, ncaaf, mls, epl, laliga, bundesliga, seriea or ligue1; `date` is a UTC calendar day \"YYYY-MM-DD\" (default today), so an evening US game can fall on the next UTC day. A date with no games returns an empty `games` list.\n\nCalls `bowmark.providers.msn.getScores`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<MsnScores>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"$ref":"#/components/schemas/MsnScoresArgs","description":"TypeScript: `MsnScoresArgs`"}},"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"}}}}}}}},"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}}},"MsnConvertCurrencyArgs":{"type":"object","properties":{"from":{"type":"string"},"to":{"type":"string"},"amount":{"type":"number"}},"required":["from","to"],"additionalProperties":true},"MsnGetPlaybackArgs":{"type":"object","properties":{"video":{"type":"string"}},"required":["video"],"additionalProperties":true},"MsnHourlyOptions":{"type":"object","properties":{"hours":{"type":"number"}},"additionalProperties":true},"MsnSaveArticleArgs":{"type":"object","properties":{"articleId":{"type":"string"}},"required":["articleId"],"additionalProperties":true},"MsnScoresArgs":{"type":"object","properties":{"league":{"anyOf":[{"const":"nfl"},{"const":"nba"},{"const":"nhl"},{"const":"mlb"},{"const":"ncaaf"},{"const":"mls"},{"const":"epl"},{"const":"laliga"},{"const":"bundesliga"},{"const":"seriea"},{"const":"ligue1"}]},"date":{"type":"string"}},"required":["league"],"additionalProperties":true},"MsnStandingsArgs":{"type":"object","properties":{"league":{"anyOf":[{"const":"nfl"},{"const":"nba"},{"const":"nhl"},{"const":"mlb"},{"const":"epl"},{"const":"laliga"},{"const":"bundesliga"},{"const":"seriea"},{"const":"ligue1"}]}},"required":["league"],"additionalProperties":true},"MsnVideoFeedOptions":{"type":"object","properties":{"limit":{"anyOf":[{"const":5},{"const":10},{"const":20}]},"cursor":{"type":"string"}},"additionalProperties":true}}}}