{"openapi":"3.1.0","info":{"title":"HelloFresh API (Bowmark)","version":"e833508f87ff","description":"Meal-kit subscription — this week's menu, plan pricing, delivery availability by ZIP, and the public recipe archive on hellofresh.com.\n\nEvery function Bowmark has for HelloFresh (hellofresh.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/hellofresh/getWeeklyMenu":{"post":{"operationId":"getWeeklyMenu","summary":"Reads every meal on offer for one delivery week — name, subtitle, its recipe URL, dietary/preference tags, and any per-serving premium surcharge.","description":"Reads every meal on offer for one delivery week — name, subtitle, its recipe URL, dietary/preference tags, and any per-serving premium surcharge. `week` is the site's own ISO-week string (e.g. \"2026-W34\"); omit it for the current week. An unauthenticated call gets the same real menu a subscriber would see — no ZIP, no session, no signup. Requesting a week HelloFresh has not published returns `[]`, not an error, matching the site's own behavior; call with no argument to get `currentWeek`'s meals reliably.\n\nCalls `bowmark.providers.hellofresh.getWeeklyMenu`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<HellofreshMeal[]>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"week":{"type":"string","description":"TypeScript: `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/hellofresh/checkDeliveryAvailability":{"post":{"operationId":"checkDeliveryAvailability","summary":"Answers whether HelloFresh delivers to a US ZIP code and which delivery days it can choose, without signing up for anything — `deliversTo`, the distinct weekday windows (`options`, each with its time ","description":"Answers whether HelloFresh delivers to a US ZIP code and which delivery days it can choose, without signing up for anything — `deliversTo`, the distinct weekday windows (`options`, each with its time window and any surcharge), and every concrete upcoming date with its order cutoff (`slots`). Takes a bare 5-digit ZIP and no identity: no name, no email, no account. Coverage is genuinely per-ZIP, not per-state — measured 2026-08-05, Manhattan 10001 gets 6 weekday windows free, rural Hutchinson KS 67501 gets 5 (no Sunday), Honolulu 96813 gets 2 at a $49.99 surcharge, and Juneau AK 99801 gets none at all. `deliversTo: false` with an empty `options` IS the site's answer for an unserved ZIP, not an error.\n\nCalls `bowmark.providers.hellofresh.checkDeliveryAvailability`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<HellofreshDeliveryAvailability>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"zip":{"type":"string","description":"TypeScript: `string`"}},"required":["zip"],"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/hellofresh/getRecipe":{"post":{"operationId":"getRecipe","summary":"Reads one recipe page in full — description, difficulty, total time, cuisines, allergens, the cookware (\"utensils\") it calls for, per-serving nutrition, the numbered steps (each with its own photo whe","description":"Reads one recipe page in full — description, difficulty, total time, cuisines, allergens, the cookware (\"utensils\") it calls for, per-serving nutrition, the numbered steps (each with its own photo when the site has one), and the ingredient list PRE-SCALED for every box size HelloFresh publishes (`yields`, normally 2 and 4 servings — never a client-side multiplication). Takes either a recipe URL (the `recipeUrl` field `getWeeklyMenu` returns) or a bare 24-character recipe id; the URL's slug is decorative; only the trailing id is looked up. An unauthenticated call reads the same public page anyone gets — no session, no signup. A url/id HelloFresh does not recognize throws rather than returning an empty recipe.\n\nCalls `bowmark.providers.hellofresh.getRecipe`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<HellofreshRecipeDetail>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"recipeUrlOrId":{"type":"string","description":"TypeScript: `string`"}},"required":["recipeUrlOrId"],"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/hellofresh/searchRecipes":{"post":{"operationId":"searchRecipes","summary":"Searches HelloFresh's whole public recipe archive by keyword or ingredient (\"chicken\", \"salmon\", \"thai\", \"beef tacos\") and returns matching recipes with enough identity to pick one: name, headline, im","description":"Searches HelloFresh's whole public recipe archive by keyword or ingredient (\"chicken\", \"salmon\", \"thai\", \"beef tacos\") and returns matching recipes with enough identity to pick one: name, headline, image, total time, difficulty, category, cuisines, dietary tags, allergens, calories and rating. This is the FREE half of HelloFresh and a far larger surface than `getWeeklyMenu`: measured 2026-08-05 the archive holds ~47,800 recipes against one week's ~75, and it needs no subscription, no ZIP and no session. Each hit's `id` goes straight into `getRecipe` for the full steps and ingredients. `total` is the archive's own count for the query, so paginate with `skip`/`take` (default 20, max 100) until you have what you need. What the matching actually is, measured rather than assumed: case-insensitive, stemmed (\"chickens\" === \"chicken\"), whole-word rather than prefix (\"chicke\" matches nothing relevant), and multi-word terms are ANDed (\"chicken pasta\" → 295 where \"pasta\" alone → 801). Four caveats worth knowing before you trust a count. It matches a recipe's TEXT, not its diet tags — \"vegetarian\" returns only the 56 recipes with that word in their name or description, NOT every meat-free recipe, so filter `tags`/`allergens` on the results for a real dietary search. The archive contains genuine duplicate entries for the same dish under different ids, so dedupe by `name` if you are counting. Relevance ranking is not stable across pages, so a recipe can also repeat between adjacent pages — dedupe by `id` when paging. And match `tags` on `name`, not `slug`: this surface mixes clean slugs with ones carrying an internal campaign suffix (the tag shown as \"Pork-free\" is `pork-free-fj-xsell` here but `pork-free` on `getWeeklyMenu`), so a slug filter can silently match nothing. A query the archive knows nothing about returns an empty `results` with `total: 0` — a real answer, not an error.\n\nCalls `bowmark.providers.hellofresh.searchRecipes`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<HellofreshRecipeSearchPage>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"query":{"type":"string","description":"TypeScript: `string`"},"options":{"type":"object","properties":{"take":{"type":"number"},"skip":{"type":"number"}},"additionalProperties":true,"description":"TypeScript: `{ take?: number; skip?: number }`"}},"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"}}}}}}}},"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}}}}}}