{"openapi":"3.1.0","info":{"title":"Scribd API (Bowmark)","version":"e833508f87ff","description":"Scribd, the document-sharing library: search user-uploaded documents, read a document's metadata and full text, browse trending documents, lists and uploader profiles; signed in, save, list, rate, download and upload documents.\n\nEvery function Bowmark has for Scribd (scribd.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/scribd/searchDocuments":{"post":{"operationId":"searchDocuments","summary":"Searches Scribd's user-uploaded documents by free text and returns up to 40 a page: id, title, url, author (name and profile url), description, page count, views, up/down votes, thumbnail and type.","description":"Searches Scribd's user-uploaded documents by free text and returns up to 40 a page: id, title, url, author (name and profile url), description, page count, views, up/down votes, thumbnail and type. page defaults to 1.\n\nCalls `bowmark.providers.scribd.searchDocuments`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<ScribdSearchResult[]>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"query":{"type":"string","description":"TypeScript: `string`"},"page":{"type":"number","description":"TypeScript: `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"}}}}}}},"/v1/sites/scribd/getDocument":{"post":{"operationId":"getDocument","summary":"Reads one Scribd document's metadata from a scribd.com/document/<id>/<slug> url or the numeric id: title, type, uploader, description and Scribd's AI summary, page count and dimensions, word count, vi","description":"Reads one Scribd document's metadata from a scribd.com/document/<id>/<slug> url or the numeric id: title, type, uploader, description and Scribd's AI summary, page count and dimensions, word count, views, rating, formats with file sizes, downloadable / view-restricted flags, categories, key-phrase definitions, the site's generated Q&A pairs and thumbnail. Not the text — that is getDocumentText.\n\nCalls `bowmark.providers.scribd.getDocument`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<ScribdDocument>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"document":{"anyOf":[{"type":"string"},{"type":"number"}],"description":"TypeScript: `string | number`"}},"required":["document"],"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/scribd/getDocumentText":{"post":{"operationId":"getDocumentText","summary":"Reads the full extracted text of a public Scribd document — what the viewer shows, including on view-restricted documents whose download is paywalled — from a scribd.com/document/<id>/<slug> url or th","description":"Reads the full extracted text of a public Scribd document — what the viewer shows, including on view-restricted documents whose download is paywalled — from a scribd.com/document/<id>/<slug> url or the numeric id. One string, paragraphs separated by a blank line; the site marks no page breaks in it.\n\nCalls `bowmark.providers.scribd.getDocumentText`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<ScribdDocumentText>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"document":{"anyOf":[{"type":"string"},{"type":"number"}],"description":"TypeScript: `string | number`"}},"required":["document"],"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/scribd/getUserProfile":{"post":{"operationId":"getUserProfile","summary":"Reads a Scribd uploader's public profile from a scribd.com/user/<id>/<slug> url, the /users/<id> url searchDocuments returns, or the numeric id: display name, avatar, canonical url and the profile's c","description":"Reads a Scribd uploader's public profile from a scribd.com/user/<id>/<slug> url, the /users/<id> url searchDocuments returns, or the numeric id: display name, avatar, canonical url and the profile's carousels (\"Uploads\" first) with each document's id, title, url, views, votes, language and thumbnail. The Uploads carousel is the profile's first page only — listUserUploads pages through all of them.\n\nCalls `bowmark.providers.scribd.getUserProfile`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<ScribdUserProfile>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"user":{"anyOf":[{"type":"string"},{"type":"number"}],"description":"TypeScript: `string | number`"}},"required":["user"],"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/scribd/getRelatedDocuments":{"post":{"operationId":"getRelatedDocuments","summary":"Lists the documents Scribd recommends alongside one document (its \"more like this\" list, ~90 rows, in the site's order) from a scribd.com/document/<id>/<slug> url or the numeric id: id, title, url, au","description":"Lists the documents Scribd recommends alongside one document (its \"more like this\" list, ~90 rows, in the site's order) from a scribd.com/document/<id>/<slug> url or the numeric id: id, title, url, author, description, page count, views, up-vote and rating counts, thumbnail and type.\n\nCalls `bowmark.providers.scribd.getRelatedDocuments`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<ScribdRelatedDocument[]>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"document":{"anyOf":[{"type":"string"},{"type":"number"}],"description":"TypeScript: `string | number`"}},"required":["document"],"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/scribd/getList":{"post":{"operationId":"getList","summary":"Reads a public Scribd list (a curated collection of documents) from a scribd.com/lists/<id>/<slug> url or the numeric id: the list's name, description, privacy flag, owner and every document in it wit","description":"Reads a public Scribd list (a curated collection of documents) from a scribd.com/lists/<id>/<slug> url or the numeric id: the list's name, description, privacy flag, owner and every document in it with id, title, url, author, description, page count and thumbnail.\n\nCalls `bowmark.providers.scribd.getList`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<ScribdList>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"list":{"anyOf":[{"type":"string"},{"type":"number"}],"description":"TypeScript: `string | number`"}},"required":["list"],"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/scribd/getEmbedCode":{"post":{"operationId":"getEmbedCode","summary":"Returns Scribd's documented, keyless oEmbed for a public document — the iframe html, aspect ratio, title, author (name and url) and thumbnail (url and dimensions) — from a scribd.com/document/<id>/<sl","description":"Returns Scribd's documented, keyless oEmbed for a public document — the iframe html, aspect ratio, title, author (name and url) and thumbnail (url and dimensions) — from a scribd.com/document/<id>/<slug> url or the numeric id, so a caller can place it in a page.\n\nCalls `bowmark.providers.scribd.getEmbedCode`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<ScribdEmbedCode>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"document":{"anyOf":[{"type":"string"},{"type":"number"}],"description":"TypeScript: `string | number`"}},"required":["document"],"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/scribd/listSavedDocuments":{"post":{"operationId":"listSavedDocuments","summary":"Lists the documents in the signed-in caller's Scribd library (scribd.com/saved) — each with id, title, url, author, description, page count and thumbnail — plus the ids Scribd marks saved and finished","description":"Lists the documents in the signed-in caller's Scribd library (scribd.com/saved) — each with id, title, url, author, description, page count and thumbnail — plus the ids Scribd marks saved and finished. Needs the caller signed in to Scribd.\n\nCalls `bowmark.providers.scribd.listSavedDocuments`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<ScribdSavedDocuments>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"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/scribd/saveDocument":{"post":{"operationId":"saveDocument","summary":"Saves a Scribd document to the signed-in caller's library (the bookmark icon) from a scribd.com/document/<id>/<slug> url or the numeric id, and returns the id with saved: true.","description":"Saves a Scribd document to the signed-in caller's library (the bookmark icon) from a scribd.com/document/<id>/<slug> url or the numeric id, and returns the id with saved: true. Undo with unsaveDocument. Needs the caller signed in to Scribd.\n\nCalls `bowmark.providers.scribd.saveDocument`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<ScribdSaveResult>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"document":{"anyOf":[{"type":"string"},{"type":"number"}],"description":"TypeScript: `string | number`"},"opts":{"type":"object","properties":{"connection":{"type":"string"}},"required":["connection"],"additionalProperties":true,"description":"TypeScript: `ConnectionOption`"}},"required":["document"],"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/scribd/unsaveDocument":{"post":{"operationId":"unsaveDocument","summary":"Removes a document from the signed-in caller's Scribd library, from a scribd.com/document/<id>/<slug> url or the numeric id, and returns the id with saved: false.","description":"Removes a document from the signed-in caller's Scribd library, from a scribd.com/document/<id>/<slug> url or the numeric id, and returns the id with saved: false. Needs the caller signed in to Scribd.\n\nCalls `bowmark.providers.scribd.unsaveDocument`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<ScribdSaveResult>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"document":{"anyOf":[{"type":"string"},{"type":"number"}],"description":"TypeScript: `string | number`"},"opts":{"type":"object","properties":{"connection":{"type":"string"}},"required":["connection"],"additionalProperties":true,"description":"TypeScript: `ConnectionOption`"}},"required":["document"],"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/scribd/listMyLists":{"post":{"operationId":"listMyLists","summary":"Lists the signed-in caller's own Scribd lists (collections) — each with id, name, url, privacy and document count where Scribd sends them, plus the raw row.","description":"Lists the signed-in caller's own Scribd lists (collections) — each with id, name, url, privacy and document count where Scribd sends them, plus the raw row. Pass an id to addDocumentToList. Needs the caller signed in to Scribd.\n\nCalls `bowmark.providers.scribd.listMyLists`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<ScribdMyList[]>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"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/scribd/addDocumentToList":{"post":{"operationId":"addDocumentToList","summary":"Adds a Scribd document to one of the signed-in caller's own lists, taking the list's scribd.com/lists/<id>/<slug> url or id (from listMyLists) and the document's url or id, and returns both ids with a","description":"Adds a Scribd document to one of the signed-in caller's own lists, taking the list's scribd.com/lists/<id>/<slug> url or id (from listMyLists) and the document's url or id, and returns both ids with added: true. Needs the caller signed in to Scribd.\n\nCalls `bowmark.providers.scribd.addDocumentToList`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<ScribdListWriteResult>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"list":{"anyOf":[{"type":"string"},{"type":"number"}],"description":"TypeScript: `string | number`"},"document":{"anyOf":[{"type":"string"},{"type":"number"}],"description":"TypeScript: `string | number`"},"opts":{"type":"object","properties":{"connection":{"type":"string"}},"required":["connection"],"additionalProperties":true,"description":"TypeScript: `ConnectionOption`"}},"required":["list","document"],"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/scribd/removeDocumentFromList":{"post":{"operationId":"removeDocumentFromList","summary":"Removes a Scribd document from one of the signed-in caller's own lists, taking the list's scribd.com/lists/<id>/<slug> url or id (from listMyLists) and the document's url or id, and returns both ids w","description":"Removes a Scribd document from one of the signed-in caller's own lists, taking the list's scribd.com/lists/<id>/<slug> url or id (from listMyLists) and the document's url or id, and returns both ids with added: false. Needs the caller signed in to Scribd.\n\nCalls `bowmark.providers.scribd.removeDocumentFromList`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<ScribdListWriteResult>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"list":{"anyOf":[{"type":"string"},{"type":"number"}],"description":"TypeScript: `string | number`"},"document":{"anyOf":[{"type":"string"},{"type":"number"}],"description":"TypeScript: `string | number`"},"opts":{"type":"object","properties":{"connection":{"type":"string"}},"required":["connection"],"additionalProperties":true,"description":"TypeScript: `ConnectionOption`"}},"required":["list","document"],"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/scribd/createList":{"post":{"operationId":"createList","summary":"Creates a new list (collection) on the signed-in caller's Scribd account with the given name, private unless privacy: 'public' is passed, optionally starting it with one document (url or id), and retu","description":"Creates a new list (collection) on the signed-in caller's Scribd account with the given name, private unless privacy: 'public' is passed, optionally starting it with one document (url or id), and returns the new list's id. Needs the caller signed in to Scribd.\n\nCalls `bowmark.providers.scribd.createList`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<ScribdCreatedList>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"TypeScript: `string`"},"options":{"type":"object","properties":{"privacy":{"anyOf":[{"const":"private"},{"const":"public"}]},"document":{"anyOf":[{"type":"string"},{"type":"number"}]}},"additionalProperties":true,"description":"TypeScript: `{ privacy?: 'private' | 'public'; document?: string | number }`"},"opts":{"type":"object","properties":{"connection":{"type":"string"}},"required":["connection"],"additionalProperties":true,"description":"TypeScript: `ConnectionOption`"}},"required":["name"],"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/scribd/markDocumentFinished":{"post":{"operationId":"markDocumentFinished","summary":"Marks a document in the signed-in caller's Scribd library as finished reading (or, with finished: false, back to just saved), from a scribd.com/document/<id>/<slug> url or the numeric id.","description":"Marks a document in the signed-in caller's Scribd library as finished reading (or, with finished: false, back to just saved), from a scribd.com/document/<id>/<slug> url or the numeric id. Needs the caller signed in to Scribd.\n\nCalls `bowmark.providers.scribd.markDocumentFinished`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<ScribdFinishResult>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"document":{"anyOf":[{"type":"string"},{"type":"number"}],"description":"TypeScript: `string | number`"},"finished":{"type":"boolean","description":"TypeScript: `boolean`"},"opts":{"type":"object","properties":{"connection":{"type":"string"}},"required":["connection"],"additionalProperties":true,"description":"TypeScript: `ConnectionOption`"}},"required":["document"],"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/scribd/askDocument":{"post":{"operationId":"askDocument","summary":"Asks Scribd's AI assistant (Ask AI) a question about one document, from a scribd.com/document/<id>/<slug> url or the numeric id, and returns its answer text, the source passages it cites and its sugge","description":"Asks Scribd's AI assistant (Ask AI) a question about one document, from a scribd.com/document/<id>/<slug> url or the numeric id, and returns its answer text, the source passages it cites and its suggested follow-up questions. Needs the caller signed in to Scribd; Scribd may limit how many questions an account without a subscription can ask.\n\nCalls `bowmark.providers.scribd.askDocument`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<ScribdAnswer>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"document":{"anyOf":[{"type":"string"},{"type":"number"}],"description":"TypeScript: `string | number`"},"question":{"type":"string","description":"TypeScript: `string`"},"opts":{"type":"object","properties":{"connection":{"type":"string"}},"required":["connection"],"additionalProperties":true,"description":"TypeScript: `ConnectionOption`"}},"required":["document","question"],"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/scribd/downloadDocument":{"post":{"operationId":"downloadDocument","summary":"Downloads a Scribd document's file as the signed-in caller, in one of the formats getDocument lists (format defaults to 'pdf'), from a scribd.com/document/<id>/<slug> url or the numeric id, and return","description":"Downloads a Scribd document's file as the signed-in caller, in one of the formats getDocument lists (format defaults to 'pdf'), from a scribd.com/document/<id>/<slug> url or the numeric id, and returns the file as base64 with its name, content type and size. Never buys a plan: a caller whose account has no download access gets Scribd's own refusal as an error. Needs the caller signed in to Scribd.\n\nCalls `bowmark.providers.scribd.downloadDocument`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<ScribdDownload>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"document":{"anyOf":[{"type":"string"},{"type":"number"}],"description":"TypeScript: `string | number`"},"format":{"type":"string","description":"TypeScript: `string`"},"opts":{"type":"object","properties":{"connection":{"type":"string"}},"required":["connection"],"additionalProperties":true,"description":"TypeScript: `ConnectionOption`"}},"required":["document"],"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/scribd/deleteDocument":{"post":{"operationId":"deleteDocument","summary":"Deletes one of the signed-in caller's own uploaded Scribd documents, from its scribd.com/document/<id>/<slug> url or numeric id.","description":"Deletes one of the signed-in caller's own uploaded Scribd documents, from its scribd.com/document/<id>/<slug> url or numeric id. Irreversible; Scribd refuses a document the caller does not own. Needs the caller signed in to Scribd.\n\nCalls `bowmark.providers.scribd.deleteDocument`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<ScribdDeleteResult>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"document":{"anyOf":[{"type":"string"},{"type":"number"}],"description":"TypeScript: `string | number`"},"opts":{"type":"object","properties":{"connection":{"type":"string"}},"required":["connection"],"additionalProperties":true,"description":"TypeScript: `ConnectionOption`"}},"required":["document"],"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/scribd/rateDocument":{"post":{"operationId":"rateDocument","summary":"Rates a Scribd document helpful ('up', a thumbs up) or not helpful ('down') as the signed-in caller, or clears the caller's rating ('clear'), from a scribd.com/document/<id>/<slug> url or the numeric ","description":"Rates a Scribd document helpful ('up', a thumbs up) or not helpful ('down') as the signed-in caller, or clears the caller's rating ('clear'), from a scribd.com/document/<id>/<slug> url or the numeric id. Needs the caller signed in to Scribd.\n\nCalls `bowmark.providers.scribd.rateDocument`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<ScribdRatingResult>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"document":{"anyOf":[{"type":"string"},{"type":"number"}],"description":"TypeScript: `string | number`"},"rating":{"anyOf":[{"const":"up"},{"const":"down"},{"const":"clear"}],"description":"TypeScript: `'up' | 'down' | 'clear'`"},"opts":{"type":"object","properties":{"connection":{"type":"string"}},"required":["connection"],"additionalProperties":true,"description":"TypeScript: `ConnectionOption`"}},"required":["document","rating"],"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/scribd/listCategories":{"post":{"operationId":"listCategories","summary":"Lists Scribd's document categories (Art, Business, Career & Growth, Finance & Money Management, Law, Science & Mathematics, Teaching Methods & Materials, Technology & Engineering, Wellness) with each ","description":"Lists Scribd's document categories (Art, Business, Career & Growth, Finance & Money Management, Law, Science & Mathematics, Teaching Methods & Materials, Technology & Engineering, Wellness) with each one's name, url slug and url, for a caller holding only a subject's name.\n\nCalls `bowmark.providers.scribd.listCategories`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<ScribdCategory[]>`.","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/scribd/getTrendingDocuments":{"post":{"operationId":"getTrendingDocuments","summary":"With no argument, every \"Trending in <Category>\" module (9, 30 documents each) plus Scribd's editorial lists (\"Business Templates\" …), each with its documents (id, title, url, author, page count, vote","description":"With no argument, every \"Trending in <Category>\" module (9, 30 documents each) plus Scribd's editorial lists (\"Business Templates\" …), each with its documents (id, title, url, author, page count, votes, thumbnail). With a category name or part of one, only the matching module(s).\n\nCalls `bowmark.providers.scribd.getTrendingDocuments`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<ScribdTrendingModule[]>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"category":{"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"}}}}}}}},"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}}}}}}