{"openapi":"3.1.0","info":{"title":"Adobe API (Bowmark)","version":"e833508f87ff","description":"Adobe Stock, Fonts and Express search, Creative Cloud plans, Acrobat's free PDF tools, and Adobe's help center — all reachable logged out.\n\nEvery function Bowmark has for Adobe (adobe.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/adobe/getCreativeCloudPlans":{"post":{"operationId":"getCreativeCloudPlans","summary":"Returns the Individual plans Adobe publishes on www.adobe.com/creativecloud/plans.html — each plan's name, the price shown right now, the undiscounted price and promo end/duration when a promo is acti","description":"Returns the Individual plans Adobe publishes on www.adobe.com/creativecloud/plans.html — each plan's name, the price shown right now, the undiscounted price and promo end/duration when a promo is active, and a free-text description, the way a visitor reads the default tab of that page. `warnings` names any card or description phrase that could not be priced or rendered. The site does not expose a separate annual total or a structured included-apps list at this card granularity, so both are currently always null/empty.\n\nCalls `bowmark.providers.adobe.getCreativeCloudPlans`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<CreativeCloudPlansResult>`.","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/adobe/findHelpArticle":{"post":{"operationId":"findHelpArticle","summary":"Searches Adobe's help center (helpx.adobe.com) for an article matching free text — e.g.","description":"Searches Adobe's help center (helpx.adobe.com) for an article matching free text — e.g. \"how do I cancel my Creative Cloud subscription\" — returning each result's title, product, URL and a summary snippet, the way an agent helping someone navigate Adobe's own support would.\n\nCalls `bowmark.providers.adobe.findHelpArticle`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<HelpArticle[]>`.","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/adobe/searchFonts":{"post":{"operationId":"searchFonts","summary":"Searches Adobe Fonts (fonts.adobe.com) by family name, returning each matching font family's slug and name (foundry comes from getFont).","description":"Searches Adobe Fonts (fonts.adobe.com) by family name, returning each matching font family's slug and name (foundry comes from getFont). The entry point to Adobe Fonts: every other font function starts with a slug from this search.\n\nCalls `bowmark.providers.adobe.searchFonts`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<Font[]>`.","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/adobe/getFont":{"post":{"operationId":"getFont","summary":"Returns one Adobe Fonts family's detail page — name, foundry, description, every weight/style in the family, and licensing info (Creative Cloud-included vs.","description":"Returns one Adobe Fonts family's detail page — name, foundry, description, every weight/style in the family, and licensing info (Creative Cloud-included vs. foundry-licensed) — from a font slug from searchFonts. `suggestedPairings` is always empty: the site's \"similar fonts\" module is fetched by client-side JS the family page never embeds server-side.\n\nCalls `bowmark.providers.adobe.getFont`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<FontDetail>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"slug":{"type":"string","description":"TypeScript: `string`"}},"required":["slug"],"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/adobe/searchTemplates":{"post":{"operationId":"searchTemplates","summary":"Searches Adobe Express (new.express.adobe.com) templates by free text, optionally narrowed to one format/category, returning each template's id, title, thumbnail URL, category (the site's own format n","description":"Searches Adobe Express (new.express.adobe.com) templates by free text, optionally narrowed to one format/category, returning each template's id, title, thumbnail URL, category (the site's own format name, e.g. \"flyer\", \"instagram-story\") and whether it is free or Premium. A row may carry a `warning` when the site likely fell back to generic recommendations instead of a real match.\n\nCalls `bowmark.providers.adobe.searchTemplates`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<ExpressTemplate[]>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"query":{"type":"string","description":"TypeScript: `string`"},"options":{"$ref":"#/components/schemas/SearchTemplatesOptions","description":"TypeScript: `SearchTemplatesOptions`"}},"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/adobe/getTemplate":{"post":{"operationId":"getTemplate","summary":"Returns one Adobe Express template's detail — title, category, dimensions, whether it is free or Premium, and the editable elements the editor lists — from a template id returned by searchTemplates.","description":"Returns one Adobe Express template's detail — title, category, dimensions, whether it is free or Premium, and the editable elements the editor lists — from a template id returned by searchTemplates. Dimensions are omitted (never fabricated) when neither the document model, a numeric task-size name, nor the row's own preview image answers them.\n\nCalls `bowmark.providers.adobe.getTemplate`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<ExpressTemplateDetail>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"TypeScript: `string`"}},"required":["id"],"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/adobe/searchStockAssets":{"post":{"operationId":"searchStockAssets","summary":"Searches Adobe Stock (stock.adobe.com) for photos, vectors, illustrations, templates and video the way the site's own search box does, returning each asset's id, thumbnail, title, media type, orientat","description":"Searches Adobe Stock (stock.adobe.com) for photos, vectors, illustrations, templates and video the way the site's own search box does, returning each asset's id, thumbnail, title, media type, orientation and licensing price tier. The entry point to every other Stock function: nothing on Stock can be read without an asset id.\n\nCalls `bowmark.providers.adobe.searchStockAssets`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<StockAsset[]>`.","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/adobe/getAgreementStatus":{"post":{"operationId":"getAgreementStatus","summary":"Reads back one Acrobat Sign agreement the caller sent (the agreementId sendForSignature returns): its state (OUT_FOR_SIGNATURE, SIGNED, …), whether it is signed, who it went to, and once signed a shor","description":"Reads back one Acrobat Sign agreement the caller sent (the agreementId sendForSignature returns): its state (OUT_FOR_SIGNATURE, SIGNED, …), whether it is signed, who it went to, and once signed a short-lived download URL of the signed PDF. Needs the caller signed in to their own Adobe ID.\n\nCalls `bowmark.providers.adobe.getAgreementStatus`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<AgreementStatus>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"agreementId":{"type":"string","description":"TypeScript: `string`"},"opts":{"type":"object","properties":{"connection":{"type":"string"}},"required":["connection"],"additionalProperties":true,"description":"TypeScript: `ConnectionOption`"}},"required":["agreementId"],"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/adobe/licenseStockAsset":{"post":{"operationId":"licenseStockAsset","summary":"Takes an Adobe Stock asset (id or URL from searchStockAssets) up to the payment step of licensing it and stops there: returns every licence tier the asset offers with its price, the tier asked for (e.","description":"Takes an Adobe Stock asset (id or URL from searchStockAssets) up to the payment step of licensing it and stops there: returns every licence tier the asset offers with its price, the tier asked for (e.g. \"Extended License\", default the first) with what the caller would be charged, and the asset page URL whose License button the caller presses in their own browser. Never charges — `charged` is always false.\n\nCalls `bowmark.providers.adobe.licenseStockAsset`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<StockLicenseQuote>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"idOrUrl":{"type":"string","description":"TypeScript: `string`"},"license":{"type":"string","description":"TypeScript: `string`"}},"required":["idOrUrl"],"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/adobe/getStockAsset":{"post":{"operationId":"getStockAsset","summary":"Returns one Adobe Stock asset's detail — title, media type, dimensions, keywords, contributor name and every licensing tier's price — from the asset id or stock.adobe.com URL searchStockAssets returns","description":"Returns one Adobe Stock asset's detail — title, media type, dimensions, keywords, contributor name and every licensing tier's price — from the asset id or stock.adobe.com URL searchStockAssets returns. The site's own description meta is a templated restatement of the title, so it is not carried as a separate field.\n\nCalls `bowmark.providers.adobe.getStockAsset`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<StockAssetDetail>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"idOrUrl":{"type":"string","description":"TypeScript: `string`"}},"required":["idOrUrl"],"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/adobe/compressPdf":{"post":{"operationId":"compressPdf","summary":"Runs Adobe Acrobat's free online \"Compress PDF\" on a public PDF URL and returns a link to the smaller PDF plus its size, at level low, medium or high (default medium).","description":"Runs Adobe Acrobat's free online \"Compress PDF\" on a public PDF URL and returns a link to the smaller PDF plus its size, at level low, medium or high (default medium). No Adobe account needed. A PDF that is already as small as it gets fails with \"already compressed\".\n\nCalls `bowmark.providers.adobe.compressPdf`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<AcrobatPdfResult>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"$ref":"#/components/schemas/CompressPdfArgs","description":"TypeScript: `CompressPdfArgs`"}},"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/adobe/convertPdfToWord":{"post":{"operationId":"convertPdfToWord","summary":"Runs Adobe Acrobat's free online PDF-to-Word converter on a public PDF URL and returns a link to the editable .docx.","description":"Runs Adobe Acrobat's free online PDF-to-Word converter on a public PDF URL and returns a link to the editable .docx. No Adobe account needed.\n\nCalls `bowmark.providers.adobe.convertPdfToWord`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<AcrobatPdfResult>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"$ref":"#/components/schemas/ConvertPdfToWordArgs","description":"TypeScript: `ConvertPdfToWordArgs`"}},"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/adobe/mergePdfs":{"post":{"operationId":"mergePdfs","summary":"Runs Adobe Acrobat's free online \"Merge PDF\" on two to twelve public PDF URLs and returns a link to one combined PDF in the order given.","description":"Runs Adobe Acrobat's free online \"Merge PDF\" on two to twelve public PDF URLs and returns a link to one combined PDF in the order given. No Adobe account needed.\n\nCalls `bowmark.providers.adobe.mergePdfs`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<AcrobatPdfResult>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"$ref":"#/components/schemas/MergePdfsArgs","description":"TypeScript: `MergePdfsArgs`"}},"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/adobe/saveAssetToCreativeCloud":{"post":{"operationId":"saveAssetToCreativeCloud","summary":"Saves an image (by public https URL, under 5 MB) into the signed-in caller's own Creative Cloud Libraries, the same store Adobe Express's \"Save to library\" writes to.","description":"Saves an image (by public https URL, under 5 MB) into the signed-in caller's own Creative Cloud Libraries, the same store Adobe Express's \"Save to library\" writes to. Goes to \"My Library\" unless a libraryId is given. Returns the library and new element id. Needs the caller signed in to their own Adobe ID.\n\nCalls `bowmark.providers.adobe.saveAssetToCreativeCloud`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<SavedCreativeCloudAsset>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"$ref":"#/components/schemas/SaveToCreativeCloudArgs","description":"TypeScript: `SaveToCreativeCloudArgs`"},"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/adobe/sendForSignature":{"post":{"operationId":"sendForSignature","summary":"Sends a PDF out for e-signature from the caller's own Adobe account through Acrobat Sign — the signed-in \"Request signatures\" flow: a public PDF URL, one or more signer emails (signed in order), an op","description":"Sends a PDF out for e-signature from the caller's own Adobe account through Acrobat Sign — the signed-in \"Request signatures\" flow: a public PDF URL, one or more signer emails (signed in order), an optional message. Returns the agreement id. Needs the caller signed in to their own Adobe ID, and it really emails the signers.\n\nCalls `bowmark.providers.adobe.sendForSignature`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<SignatureRequest>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"$ref":"#/components/schemas/SendForSignatureArgs","description":"TypeScript: `SendForSignatureArgs`"},"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"}}}}}}}},"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}}},"CompressPdfArgs":{"type":"object","properties":{"pdfUrl":{"type":"string"},"level":{"anyOf":[{"const":"low"},{"const":"medium"},{"const":"high"}]}},"required":["pdfUrl"],"additionalProperties":true},"ConvertPdfToWordArgs":{"type":"object","properties":{"pdfUrl":{"type":"string"}},"required":["pdfUrl"],"additionalProperties":true},"MergePdfsArgs":{"type":"object","properties":{"pdfUrls":{"type":"array","items":{"type":"string"}},"name":{"type":"string"}},"required":["pdfUrls"],"additionalProperties":true},"SaveToCreativeCloudArgs":{"type":"object","properties":{"assetUrl":{"type":"string"},"name":{"type":"string"},"libraryId":{"type":"string"}},"required":["assetUrl"],"additionalProperties":true},"SearchTemplatesOptions":{"type":"object","properties":{"format":{"type":"string"}},"additionalProperties":true},"SendForSignatureArgs":{"type":"object","properties":{"documentUrl":{"type":"string"},"signers":{"type":"array","items":{"type":"string"}},"name":{"type":"string"},"message":{"type":"string"}},"required":["documentUrl","signers"],"additionalProperties":true}}}}