{"openapi":"3.1.0","info":{"title":"Interior Define API (Bowmark)","version":"e833508f87ff","description":"Interior Define's custom sofa/sectional configurator — search the catalog, read one product's full customizer (fabric color, leg finish, dimensions, cushion fill, every option's exact price), and price a specific configuration against the live catalog rather than a researched estimate.\n\nEvery function Bowmark has for Interior Define (interiordefine.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/interiordefine/searchProducts":{"post":{"operationId":"searchProducts","summary":"Searches Interior Define's catalog by free text (e.g.","description":"Searches Interior Define's catalog by free text (e.g. \"sectional\", \"leather sofa\") and returns every customizable match with its SKU, name, entry URL and starting price. Non-customizable items (pillows, accessories) are dropped — this provider's other two functions have nothing to do with them. The `sku` on each row is what getConfigurator and priceConfiguration take.\n\nCalls `bowmark.providers.interiordefine.searchProducts`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<InteriorDefineProductSummary[]>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"query":{"type":"string","description":"TypeScript: `string`"}},"required":["query"],"additionalProperties":false}}}},"responses":{"200":{"description":"The call ran. That includes a call that failed (`status: error`) or paused for a sign-in (`status: needs_user`), so branch on `status`.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/RunEnvelope"},{"type":"object","properties":{"result":{}}}]}}}},"400":{"description":"The body was malformed. `error` says what to send.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"401":{"description":"No API key, or a key that was refused.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"402":{"description":"The account is out of free usage, at its spend cap, or its card was declined. Fix billing at https://bowmark.ai/dashboard/billing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"404":{"$ref":"#/components/responses/NotFound"},"429":{"description":"Too many runs in flight on this account. Nothing was started or charged.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}},"headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Seconds to wait."}}},"503":{"description":"A failure on Bowmark's side. Retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}}}}},"/v1/sites/interiordefine/getConfigurator":{"post":{"operationId":"getConfigurator","summary":"Reads one product's whole customizer: every option category (fabric Color, leg Finish, Length, Total Depth, Cushion Fill, Total Sofa Cushions — the exact set varies by product) with each choice's exac","description":"Reads one product's whole customizer: every option category (fabric Color, leg Finish, Length, Total Depth, Cushion Fill, Total Sofa Cushions — the exact set varies by product) with each choice's exact label and signed price delta versus the base price. THROWS on an unknown SKU, naming searchProducts() as the way to find current ones.\n\nCalls `bowmark.providers.interiordefine.getConfigurator`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<InteriorDefineConfigurator>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"sku":{"type":"string","description":"TypeScript: `string`"}},"required":["sku"],"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/interiordefine/priceConfiguration":{"post":{"operationId":"priceConfiguration","summary":"Prices ONE specific configuration — selections keyed by option title (case-insensitive), e.g.","description":"Prices ONE specific configuration — selections keyed by option title (case-insensitive), e.g. { Color: \"Coconut\", Finish: \"Matte Black\" } — against the SKU's live customizer and returns the total, the per-choice breakdown, and the site URL to re-pick the same choices (Interior Define publishes no shareable URL for a configured state). `missingRequired` names any required category left unpicked — the total is a floor until those are chosen. `unmatched` names any selection that did not match a real option or choice, rather than silently mispricing.\n\nCalls `bowmark.providers.interiordefine.priceConfiguration`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<InteriorDefinePriceResult>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"sku":{"type":"string","description":"TypeScript: `string`"},"selections":{"type":"object","additionalProperties":{"type":"string"},"description":"TypeScript: `Record<string, string>`"}},"required":["sku","selections"],"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/interiordefine/addToCart":{"post":{"operationId":"addToCart","summary":"Turns a configuration into the link you hand the shopper: Interior Define's own product page with every matched choice PRESELECTED (fabric, leg finish, size, cushions), landing them on the site's Add ","description":"Turns a configuration into the link you hand the shopper: Interior Define's own product page with every matched choice PRESELECTED (fabric, leg finish, size, cushions), landing them on the site's Add to Cart button instead of re-picking a fabric out of 115. Same selections shape as priceConfiguration, e.g. { Color: \"Coconut\", Finish: \"Matte Black\" }, and it returns the same total and per-choice breakdown alongside the URL. NOTHING IS CREATED SERVER-SIDE and nothing is bought: the cart appears in the SHOPPER's own session when they click, exactly as for any other visitor. That is a measured limit of the site, not caution — Interior Define publishes no way to hand an anonymous shopper a cart that already exists (see the provider's reach note), so this is the whole handoff available. `missingRequired` names categories the site will default for the shopper; `unmatched` names selections that matched nothing and were therefore left out of the URL rather than silently mispricing it.\n\nCalls `bowmark.providers.interiordefine.addToCart`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<InteriorDefineCartHandoff>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"sku":{"type":"string","description":"TypeScript: `string`"},"selections":{"type":"object","additionalProperties":{"type":"string"},"description":"TypeScript: `Record<string, string>`"}},"required":["sku","selections"],"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}}}}}}