{"openapi":"3.1.0","info":{"title":"Bellwether Coffee API (Bowmark)","version":"e833508f87ff","description":"Bellwether Coffee's own ROI calculator (bellwethercoffee.com/roi-calculator) — real monthly/annual savings, retail-bag revenue and profit, payback period, and first-year ROI for the Shop Roaster, computed exactly as the site's own client-side formula computes it, no estimate.\n\nEvery function Bowmark has for Bellwether Coffee (bellwethercoffee.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/bellwethercoffee/getCalculatorDefaults":{"post":{"operationId":"getCalculatorDefaults","summary":"Inputs for the coffee roasting savings calculator: returns the ROI calculator's own currencies, roaster types, per-currency default input values, per-currency slider bounds (min/max/step — the price m","description":"Inputs for the coffee roasting savings calculator: returns the ROI calculator's own currencies, roaster types, per-currency default input values, per-currency slider bounds (min/max/step — the price max differs by currency), per-currency roaster list prices, and the site's own cost-basis disclaimer text — call this before computeRoiEstimate to know the valid ranges and defaults.\n\nCalls `bowmark.providers.bellwethercoffee.getCalculatorDefaults`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<BellwethercoffeeCalculatorDefaults>`.","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/bellwethercoffee/computeRoiEstimate":{"post":{"operationId":"computeRoiEstimate","summary":"Calculate how much a cafe or coffee shop would save by roasting its own coffee in-house on a Bellwether roaster instead of buying it roasted (coffee roasting savings / ROI / payback calculator).","description":"Calculate how much a cafe or coffee shop would save by roasting its own coffee in-house on a Bellwether roaster instead of buying it roasted (coffee roasting savings / ROI / payback calculator). Runs Bellwether's own ROI calculator formula — currency, roaster type, weekly roasted-coffee usage, price paid per lb, and weekly retail-bag sales in; real monthly/annual savings, retail-bag revenue and profit, payback period (months), and first-year total ROI out, computed exactly as bellwethercoffee.com/roi-calculator's own client-side computeROI() computes it, no estimate. `requestDemoUrl` is the site's own next step, not a checkout.\n\nCalls `bowmark.providers.bellwethercoffee.computeRoiEstimate`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<BellwethercoffeeRoiEstimate>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"input":{"$ref":"#/components/schemas/BellwethercoffeeRoiInput","description":"TypeScript: `BellwethercoffeeRoiInput`"}},"required":["input"],"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}}},"BellwethercoffeeCurrency":{"anyOf":[{"const":"USD"},{"const":"CAD"},{"const":"GBP"},{"const":"EUR"}]},"BellwethercoffeeRoasterType":{"anyOf":[{"const":"ShopRoaster"},{"const":"ContinuousRoasting"}]},"BellwethercoffeeRoiInput":{"type":"object","properties":{"currency":{"$ref":"#/components/schemas/BellwethercoffeeCurrency"},"roasterType":{"$ref":"#/components/schemas/BellwethercoffeeRoasterType"},"poundsWeekly":{"type":"number"},"coffeeCost":{"type":"number"},"retailBags":{"type":"number"}},"required":["currency","roasterType","poundsWeekly","coffeeCost","retailBags"],"additionalProperties":true}}}}