{"openapi":"3.1.0","info":{"title":"eBay API (Bowmark)","version":"e833508f87ff","description":"Live eBay listing details, category or seller listings, autosuggest and deals on ebay.com or the German marketplace ebay.de — returning title, price, condition, buying option, seller and the item's own eBay URL. Keyword search uses eBay's documented Browse API when the caller brings an OAuth key; when it is unavailable, use searchByCategory or getSellerListings only when the caller already knows the category or seller.\n\nEvery function Bowmark has for eBay (ebay.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/ebay/search":{"post":{"operationId":"search","summary":"Runs an eBay item search through eBay's documented Browse API — title, price, condition, buying option (auction/fixed-price/best-offer), seller and the item's own ebay.com URL.","description":"Runs an eBay item search through eBay's documented Browse API — title, price, condition, buying option (auction/fixed-price/best-offer), seller and the item's own ebay.com URL. Requires the caller's eBay OAuth key. `limit` caps the row count (default 20, ceiling 200). `marketplace: \"DE\"` searches the German marketplace, ebay.de, instead — euro prices and ebay.de URLs. Without a key no ebay.de listing is reachable from this provider: there is no keyless German search door, so say a key is needed rather than answering with ebay.com results.\n\nCalls `bowmark.providers.ebay.search`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<ebayItem[]>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"anyOf":[{"type":"string"},{"type":"object","properties":{"query":{"type":"string"},"limit":{"type":"number"},"marketplace":{"anyOf":[{"const":"US"},{"const":"DE"}]}},"required":["query"],"additionalProperties":true}],"description":"TypeScript: `string | { query: string; limit?: number; marketplace?: \"US\" | \"DE\" }`"}},"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/ebay/getItem":{"post":{"operationId":"getItem","summary":"Reads one eBay listing through the documented Browse API by item id (`137474897118`, or `v1|110034424734|0`) or an ebay.com/itm/ URL — title, price, condition, buying options, seller feedback, item lo","description":"Reads one eBay listing through the documented Browse API by item id (`137474897118`, or `v1|110034424734|0`) or an ebay.com/itm/ URL — title, price, condition, buying options, seller feedback, item location, the site's own default shipping option, and current bid / bid count for an active auction. Requires the caller's eBay OAuth key. An ebay.de/itm/ URL, or `{ itemId, marketplace: \"DE\" }`, reads the listing on ebay.de.\n\nCalls `bowmark.providers.ebay.getItem`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<ebayItemDetail>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"anyOf":[{"type":"string"},{"type":"object","properties":{"itemId":{"type":"string"},"marketplace":{"anyOf":[{"const":"US"},{"const":"DE"}]}},"required":["itemId"],"additionalProperties":true}],"description":"TypeScript: `string | { itemId: string; marketplace?: \"US\" | \"DE\" }`"}},"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/ebay/searchByCategory":{"post":{"operationId":"searchByCategory","summary":"Searches one eBay category through the documented Browse API by id (e.g.","description":"Searches one eBay category through the documented Browse API by id (e.g. `\"15709\"` for Men's Athletic Shoes), with an optional keyword query narrowing within the category. Returns listing title, price, condition, buying option, seller and item URL. Requires the caller's eBay OAuth key. `limit` caps the row count (default 20, ceiling 200).\n\nCalls `bowmark.providers.ebay.searchByCategory`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<ebayItem[]>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"anyOf":[{"type":"string"},{"type":"object","properties":{"categoryId":{"type":"string"},"query":{"type":"string"},"limit":{"type":"number"}},"required":["categoryId"],"additionalProperties":true}],"description":"TypeScript: `string | { categoryId: string; 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/ebay/getSellerListings":{"post":{"operationId":"getSellerListings","summary":"Searches one seller's own eBay listings through the documented Browse API by seller username and `query` — a seller filter cannot stand alone on eBay's Browse API, so `query` is required alongside `se","description":"Searches one seller's own eBay listings through the documented Browse API by seller username and `query` — a seller filter cannot stand alone on eBay's Browse API, so `query` is required alongside `seller`. Returns listing title, price, condition, buying option, seller and item URL. Requires the caller's eBay OAuth key. `limit` caps the row count (default 20, ceiling 200).\n\nCalls `bowmark.providers.ebay.getSellerListings`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<ebayItem[]>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"type":"object","properties":{"seller":{"type":"string"},"query":{"type":"string"},"limit":{"type":"number"}},"required":["seller","query"],"additionalProperties":true,"description":"TypeScript: `{ seller: string; 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/ebay/getSellerProfile":{"post":{"operationId":"getSellerProfile","summary":"Reads one eBay seller's public feedback profile by username — lifetime feedback score, positive-feedback percentage over the last 12 months, business or individual seller, the date they joined, the co","description":"Reads one eBay seller's public feedback profile by username — lifetime feedback score, positive-feedback percentage over the last 12 months, business or individual seller, the date they joined, the country eBay lists them in, and their eBay Store when they run one. Needs no eBay OAuth key. Throws for a username eBay has no profile for.\n\nCalls `bowmark.providers.ebay.getSellerProfile`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<ebaySellerProfile>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"anyOf":[{"type":"string"},{"type":"object","properties":{"seller":{"type":"string"}},"required":["seller"],"additionalProperties":true}],"description":"TypeScript: `string | { seller: 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/ebay/searchAutocomplete":{"post":{"operationId":"searchAutocomplete","summary":"Reads eBay's own search-box autosuggest — the same suggestions typed into ebay.com's search field would show — via `autosug.ebay.com/autosug`, eBay's undocumented but keyless autocomplete endpoint.","description":"Reads eBay's own search-box autosuggest — the same suggestions typed into ebay.com's search field would show — via `autosug.ebay.com/autosug`, eBay's undocumented but keyless autocomplete endpoint. Needs no eBay OAuth key, unlike every other function on this provider. `marketplace: \"DE\"` returns ebay.de's German suggestions and category names. Returns an empty `suggestions`/`categories` pair when eBay has nothing to suggest for the prefix.\n\nCalls `bowmark.providers.ebay.searchAutocomplete`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<ebayAutocompleteResult>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"anyOf":[{"type":"string"},{"type":"object","properties":{"query":{"type":"string"},"marketplace":{"anyOf":[{"const":"US"},{"const":"DE"}]}},"required":["query"],"additionalProperties":true}],"description":"TypeScript: `string | { query: string; marketplace?: \"US\" | \"DE\" }`"}},"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/ebay/getDeals":{"post":{"operationId":"getDeals","summary":"Reads eBay's own `/deals` page — the same spotlight, trending and featured deals a shopper sees on ebay.com — via a plain keyless GET and a DOM parse of the page's own schema.org Product/Offer microda","description":"Reads eBay's own `/deals` page — the same spotlight, trending and featured deals a shopper sees on ebay.com — via a plain keyless GET and a DOM parse of the page's own schema.org Product/Offer microdata. Needs no eBay OAuth key, unlike every keyed function on this provider. `originalPrice` and `discountPercent` are present only on a tile that carries a discount badge. It reads ebay.com only, in USD: there is no ebay.de deals page here, so these rows are not German-marketplace deals.\n\nCalls `bowmark.providers.ebay.getDeals`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<ebayDeal[]>`.","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/ebay/searchSold":{"post":{"operationId":"searchSold","summary":"Sold prices from PriceCharting's record of completed eBay sales; covers video games, consoles, trading cards, comics and Lego only, in USD for ebay.com.","description":"Sold prices from PriceCharting's record of completed eBay sales; covers video games, consoles, trading cards, comics and Lego only, in USD for ebay.com. Returns what each item actually SOLD for (not asking prices): title, sold price, sold date, condition bucket and the listing URL, newest first, with a median and 25th/75th-percentile `summary` for ONE condition named in `summaryCondition` (Loose for games and consoles, Ungraded for cards, New for sealed sets, or the grade named in the query such as \"psa 10\"), and `byCondition` for the rest. Keyless (eBay's own sold-listings page is blocked by Akamai on every route we have). A query with no closely matching product returns no rows, count 0 and a warning, with the closest titles in `nearestProducts` (not matches), never another product's sales. Reads ONE product per call, named in `matchedProducts`; `site`-less, USD, query up to 200 characters. `limit` caps the rows (default 60, ceiling 200).\n\nCalls `bowmark.providers.ebay.searchSold`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<ebaySoldSearch>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"anyOf":[{"type":"string"},{"type":"object","properties":{"query":{"type":"string"},"site":{"const":"ebay.com"},"limit":{"type":"number"}},"required":["query"],"additionalProperties":true}],"description":"TypeScript: `string | { query: string; site?: \"ebay.com\"; 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/ebay/getWatchlist":{"post":{"operationId":"getWatchlist","summary":"Get the caller's watch list — items they are monitoring for price changes.","description":"Get the caller's watch list — items they are monitoring for price changes. Needs a signed-in eBay account; the caller supplies their session. Returns listing fields plus a `watchlistPosition` (1-indexed order in the list). `limit` caps the row count (default 20, ceiling 200).\n\nCalls `bowmark.providers.ebay.getWatchlist`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<ebayWatchlistItem[]>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"type":"object","properties":{"limit":{"type":"number"}},"additionalProperties":true,"description":"TypeScript: `{ limit?: number }`"},"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/ebay/getMyListings":{"post":{"operationId":"getMyListings","summary":"Get the caller's own active selling listings.","description":"Get the caller's own active selling listings. Needs a signed-in eBay account; the caller supplies their session. Returns listing fields; `seller` is always `null`, since the page is the caller's own listings and does not print their username back to them. `limit` caps the row count (default 20, ceiling 200).\n\nCalls `bowmark.providers.ebay.getMyListings`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<ebayItem[]>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"type":"object","properties":{"limit":{"type":"number"}},"additionalProperties":true,"description":"TypeScript: `{ limit?: number }`"},"opts":{"type":"object","properties":{"connection":{"type":"string"}},"required":["connection"],"additionalProperties":true,"description":"TypeScript: `ConnectionOption`"}},"additionalProperties":false}}}},"responses":{"200":{"description":"The call ran. That includes a call that failed (`status: error`) or paused for a sign-in (`status: needs_user`), so branch on `status`.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/RunEnvelope"},{"type":"object","properties":{"result":{}}}]}}}},"400":{"description":"The body was malformed. `error` says what to send.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"401":{"description":"No API key, or a key that was refused.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"402":{"description":"The account is out of free usage, at its spend cap, or its card was declined. Fix billing at https://bowmark.ai/dashboard/billing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"404":{"$ref":"#/components/responses/NotFound"},"429":{"description":"Too many runs in flight on this account. Nothing was started or charged.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}},"headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Seconds to wait."}}},"503":{"description":"A failure on Bowmark's side. Retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}}}}}},"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer","description":"Your Bowmark API key."},"apiKeyHeader":{"type":"apiKey","in":"header","name":"X-Bowmark-Key"}},"responses":{"NotFound":{"description":"No such site or function.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}}},"schemas":{"RunEnvelope":{"type":"object","description":"What a run returns. `status` says whether the SCRIPT succeeded. A script that threw or paused for a login is still HTTP 200. Branch on `status`, not on the HTTP code.","required":["ok","status","result","logs","error","ms"],"properties":{"runId":{"type":"string","description":"Stable id for this run. Quote it in a support or `report` message."},"ok":{"type":"boolean","description":"False only when the run produced nothing usable."},"status":{"type":"string","enum":["ok","error","partial","needs_user"],"description":"`partial`: the result is real but some calls failed (see `incomplete`); `ok` stays true. `needs_user`: a person must sign in to a site first. Relay `meta.handoff.url` to them, then run again."},"egress":{"type":"string","enum":["default","link"],"description":"The egress the run was given, present only when the request asked for one. `link`: every request went through the caller's own Chrome (Bowmark Buddy)."},"result":{"description":"Whatever the script `return`ed. Any JSON value."},"logs":{"type":"array","items":{"type":"string"},"description":"Lines the script wrote with `log(...)`."},"error":{"type":["string","null"],"description":"Why the run failed, in plain words. Null on success."},"ms":{"type":"integer","description":"How long the script itself ran, in milliseconds."},"queuedMs":{"type":"integer","description":"How long the run waited for a worker before starting. Present only when it was a second or more."},"needs":{"type":"array","description":"The sign-ins this script is waiting on. Present when `status` is `needs_user`.","items":{"type":"object","required":["capability","provider","providerTitle","kind"],"properties":{"capability":{"type":"string"},"provider":{"type":"string"},"providerTitle":{"type":"string","description":"The site's name, to show a person."},"kind":{"type":"string"}}}},"incomplete":{"type":"object","description":"Present only when `status` is `partial`: which calls did not answer.","properties":{"summary":{"type":"string"},"totalCalls":{"type":"integer"}},"additionalProperties":true},"emptyHanded":{"type":"object","description":"Present when the script returned nothing while its calls returned rows, usually a filter that matched none of the site's own labels. Lists the label values the calls actually returned.","additionalProperties":true},"notes":{"type":"array","description":"Caveats a call attached to a complete answer. Never changes `status`.","items":{"type":"object","properties":{"path":{"type":"string"},"notes":{"type":"array","items":{"type":"string"}}}}},"meta":{"type":"object","properties":{"handoff":{"type":"object","description":"A single-use sign-in link for a person to open. Expires at `expiresAt`.","properties":{"ref":{"type":"string"},"url":{"type":"string","format":"uri"},"expiresAt":{"type":"string","format":"date-time"}}},"concurrency":{"type":"object","description":"On a 429: how many runs are in flight and when to retry.","properties":{"limit":{"type":"integer"},"inFlight":{"type":"integer"},"retryAfterSeconds":{"type":"integer"}}}},"additionalProperties":true},"notice":{"type":"object","description":"Set when the account owner has not accepted the current Terms. Relay it to them.","additionalProperties":true}}}}}}