{"openapi":"3.1.0","info":{"title":"Goodreads API (Bowmark)","version":"e833508f87ff","description":"A social network for book readers: book details and ratings, member reviews, curated lists, genre browsing, and (once a caller signs in) shelving, rating and reviewing.\n\nEvery function Bowmark has for Goodreads (goodreads.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/goodreads/searchBooks":{"post":{"operationId":"searchBooks","summary":"Runs goodreads.com's book search and returns title, author, url and (when the card shows one) average rating per row.","description":"Runs goodreads.com's book search and returns title, author, url and (when the card shows one) average rating per row.\n\nCalls `bowmark.providers.goodreads.searchBooks`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<GoodreadsBookRow[]>`.","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/goodreads/getBook":{"post":{"operationId":"getBook","summary":"Reads one book's full record off its page — title, author, format, page count, ISBN, genres, description, and Goodreads' own weighted average rating with rating and review counts.","description":"Reads one book's full record off its page — title, author, format, page count, ISBN, genres, description, and Goodreads' own weighted average rating with rating and review counts. Takes the numeric id or the full URL searchBooks returns.\n\nCalls `bowmark.providers.goodreads.getBook`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<GoodreadsBook>`.","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/goodreads/getBookReviews":{"post":{"operationId":"getBookReviews","summary":"Reads a page of member reviews for one book — reviewer name, review text, and creation timestamp per row.","description":"Reads a page of member reviews for one book — reviewer name, review text, and creation timestamp per row. Takes the numeric id or the full URL searchBooks returns, and an optional 1-indexed page number (defaults to 1).\n\nCalls `bowmark.providers.goodreads.getBookReviews`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<GoodreadsReviewRow[]>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"idOrUrl":{"type":"string","description":"TypeScript: `string`"},"pageNumber":{"type":"number","description":"TypeScript: `number`"}},"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/goodreads/getSimilarBooks":{"post":{"operationId":"getSimilarBooks","summary":"Lists the books Goodreads suggests next to one book — the 'readers also enjoyed' carousel on its page: title, url, cover image, author, average rating and ratings count per row.","description":"Lists the books Goodreads suggests next to one book — the 'readers also enjoyed' carousel on its page: title, url, cover image, author, average rating and ratings count per row. Takes the numeric id or the full URL searchBooks returns. Up to 20 rows, the same list the page shows.\n\nCalls `bowmark.providers.goodreads.getSimilarBooks`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<GoodreadsSimilarBook[]>`.","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/goodreads/listGenreBooks":{"post":{"operationId":"listGenreBooks","summary":"Lists books in a Goodreads genre category — all public books on the genre browsing page.","description":"Lists books in a Goodreads genre category — all public books on the genre browsing page. Takes the genre name (e.g. 'science-fiction' or 'mystery').\n\nCalls `bowmark.providers.goodreads.listGenreBooks`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<GoodreadsBookRow[]>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"genre":{"type":"string","description":"TypeScript: `string`"}},"required":["genre"],"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/goodreads/getList":{"post":{"operationId":"getList","summary":"Reads one curated list's books — rank, title, author, url and (when shown) average rating per row.","description":"Reads one curated list's books — rank, title, author, url and (when shown) average rating per row. Takes the numeric id or the full URL.\n\nCalls `bowmark.providers.goodreads.getList`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<GoodreadsListBook[]>`.","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/goodreads/searchAuthors":{"post":{"operationId":"searchAuthors","summary":"Finds Goodreads authors by name — legacyId, name, author url, books-on-shelf count and location per match.","description":"Finds Goodreads authors by name — legacyId, name, author url, books-on-shelf count and location per match. Pass the legacyId or url to getAuthor or getAuthorBooks.\n\nCalls `bowmark.providers.goodreads.searchAuthors`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<GoodreadsAuthorSearchRow[]>`.","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/goodreads/getSeries":{"post":{"operationId":"getSeries","summary":"Reads a book series' reading order — each book's position number, title, author, rating and page count.","description":"Reads a book series' reading order — each book's position number, title, author, rating and page count. Takes the series id or the /series/ url off a book page.\n\nCalls `bowmark.providers.goodreads.getSeries`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<GoodreadsSeries>`.","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/goodreads/getAuthorBooks":{"post":{"operationId":"getAuthorBooks","summary":"Lists an author's full bibliography, 30 books a page (page is 1-indexed) — title, url, rating, ratings count and first-published year per book.","description":"Lists an author's full bibliography, 30 books a page (page is 1-indexed) — title, url, rating, ratings count and first-published year per book.\n\nCalls `bowmark.providers.goodreads.getAuthorBooks`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<GoodreadsAuthorBook[]>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"idOrUrl":{"type":"string","description":"TypeScript: `string`"},"page":{"type":"number","description":"TypeScript: `number`"}},"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/goodreads/getBookEditions":{"post":{"operationId":"getBookEditions","summary":"Lists the editions of a book, 10 a page — publisher, publication date, format, pages, ISBN, language and rating per edition.","description":"Lists the editions of a book, 10 a page — publisher, publication date, format, pages, ISBN, language and rating per edition. Takes a book id or url.\n\nCalls `bowmark.providers.goodreads.getBookEditions`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<GoodreadsBookEdition[]>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"idOrUrl":{"type":"string","description":"TypeScript: `string`"},"page":{"type":"number","description":"TypeScript: `number`"}},"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/goodreads/getAuthor":{"post":{"operationId":"getAuthor","summary":"Reads one author's page — bio, genre, influences, website, rating/review/follower stats, and a preview of their books.","description":"Reads one author's page — bio, genre, influences, website, rating/review/follower stats, and a preview of their books. Takes the numeric id or the full URL searchBooks/getBook return in authorUrl.\n\nCalls `bowmark.providers.goodreads.getAuthor`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<GoodreadsAuthor>`.","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/goodreads/searchQuotes":{"post":{"operationId":"searchQuotes","summary":"Runs the public quotes search and returns quote text with its attributed author, the book it's from (when the card names one), like count and tags.","description":"Runs the public quotes search and returns quote text with its attributed author, the book it's from (when the card names one), like count and tags.\n\nCalls `bowmark.providers.goodreads.searchQuotes`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<GoodreadsQuote[]>`.","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/goodreads/getBookQuotes":{"post":{"operationId":"getBookQuotes","summary":"Lists the quotes readers attached to one book, 30 a page — quote text, author, like count and tags.","description":"Lists the quotes readers attached to one book, 30 a page — quote text, author, like count and tags. Takes a book id or url and an optional 1-indexed page.\n\nCalls `bowmark.providers.goodreads.getBookQuotes`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<GoodreadsBookQuote[]>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"idOrUrl":{"type":"string","description":"TypeScript: `string`"},"page":{"type":"number","description":"TypeScript: `number`"}},"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/goodreads/getMemberProfile":{"post":{"operationId":"getMemberProfile","summary":"Reads a member's PUBLIC profile summary — display name, shelf counts, favorite genres and friend count — off their profile page.","description":"Reads a member's PUBLIC profile summary — display name, shelf counts, favorite genres and friend count — off their profile page. Takes the numeric id or the full goodreads.com user URL. A member whose own privacy setting restricts this to signed-in visitors comes back with only the name and book count (`private: true`).\n\nCalls `bowmark.providers.goodreads.getMemberProfile`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<GoodreadsMemberProfile>`.","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/goodreads/getMemberShelf":{"post":{"operationId":"getMemberShelf","summary":"Reads the newest 100 books on one of a member's shelves — title, book id, author, cover, the member's own rating, review snippet and tags.","description":"Reads the newest 100 books on one of a member's shelves — title, book id, author, cover, the member's own rating, review snippet and tags. Takes the numeric id or the full user URL and the shelf's slug (from getMemberProfile's shelfCounts, e.g. 'read', 'currently-reading', 'to-read' — omit for every shelved book). Only page 1 exists: the public door serves the newest 100 and nothing older. Public — no sign-in needed, even for a member whose profile page is privacy-restricted.\n\nCalls `bowmark.providers.goodreads.getMemberShelf`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<GoodreadsShelfBook[]>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"idOrUrl":{"type":"string","description":"TypeScript: `string`"},"shelf":{"type":"string","description":"TypeScript: `string`"},"pageNumber":{"type":"number","description":"TypeScript: `number`"}},"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/goodreads/rateBook":{"post":{"operationId":"rateBook","summary":"Sets the signed-in caller's own star rating (1-5) on a book.","description":"Sets the signed-in caller's own star rating (1-5) on a book. Takes the numeric id or the full book URL. Needs the caller signed in to Goodreads (an authFunction, a write).\n\nCalls `bowmark.providers.goodreads.rateBook`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<{ legacyId: string; rating: number }>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"idOrUrl":{"type":"string","description":"TypeScript: `string`"},"rating":{"anyOf":[{"const":1},{"const":2},{"const":3},{"const":4},{"const":5}],"description":"TypeScript: `1 | 2 | 3 | 4 | 5`"},"opts":{"type":"object","properties":{"connection":{"type":"string"}},"required":["connection"],"additionalProperties":true,"description":"TypeScript: `ConnectionOption`"}},"required":["idOrUrl","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/goodreads/addToShelf":{"post":{"operationId":"addToShelf","summary":"Puts a book on one of the signed-in caller's shelves — 'to-read' (the default), 'currently-reading', 'read' or a custom shelf's slug.","description":"Puts a book on one of the signed-in caller's shelves — 'to-read' (the default), 'currently-reading', 'read' or a custom shelf's slug. Needs the caller signed in to Goodreads (an authFunction, a write).\n\nCalls `bowmark.providers.goodreads.addToShelf`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<{ legacyId: string; shelf: string; shelved: true }>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"idOrUrl":{"type":"string","description":"TypeScript: `string`"},"shelf":{"type":"string","description":"TypeScript: `string`"},"opts":{"type":"object","properties":{"connection":{"type":"string"}},"required":["connection"],"additionalProperties":true,"description":"TypeScript: `ConnectionOption`"}},"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/goodreads/removeFromShelf":{"post":{"operationId":"removeFromShelf","summary":"Takes a book off one of the signed-in caller's shelves, by the shelf's slug.","description":"Takes a book off one of the signed-in caller's shelves, by the shelf's slug. Needs the caller signed in to Goodreads (an authFunction, a write).\n\nCalls `bowmark.providers.goodreads.removeFromShelf`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<{ legacyId: string; shelf: string; shelved: false }>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"idOrUrl":{"type":"string","description":"TypeScript: `string`"},"shelf":{"type":"string","description":"TypeScript: `string`"},"opts":{"type":"object","properties":{"connection":{"type":"string"}},"required":["connection"],"additionalProperties":true,"description":"TypeScript: `ConnectionOption`"}},"required":["idOrUrl","shelf"],"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/goodreads/getOwnProfile":{"post":{"operationId":"getOwnProfile","summary":"Reads the signed-in caller's OWN profile — the same fields as getMemberProfile, plus their member id, with their own private sections visible.","description":"Reads the signed-in caller's OWN profile — the same fields as getMemberProfile, plus their member id, with their own private sections visible. Needs the caller signed in to Goodreads (an authFunction).\n\nCalls `bowmark.providers.goodreads.getOwnProfile`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<GoodreadsMemberProfile & { memberId: string }>`.","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/goodreads/writeReview":{"post":{"operationId":"writeReview","summary":"Posts (or replaces) the signed-in caller's own text review of a book, with an optional 1-5 star rating.","description":"Posts (or replaces) the signed-in caller's own text review of a book, with an optional 1-5 star rating. Takes the numeric id or the full book URL. Public on Goodreads once posted. Needs the caller signed in to Goodreads (an authFunction, a write).\n\nCalls `bowmark.providers.goodreads.writeReview`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<{ legacyId: string; rating?: number; posted: true }>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"idOrUrl":{"type":"string","description":"TypeScript: `string`"},"text":{"type":"string","description":"TypeScript: `string`"},"rating":{"anyOf":[{"const":1},{"const":2},{"const":3},{"const":4},{"const":5}],"description":"TypeScript: `1 | 2 | 3 | 4 | 5`"},"opts":{"type":"object","properties":{"connection":{"type":"string"}},"required":["connection"],"additionalProperties":true,"description":"TypeScript: `ConnectionOption`"}},"required":["idOrUrl","text"],"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/goodreads/followUser":{"post":{"operationId":"followUser","summary":"Follows another Goodreads member as the signed-in caller, by numeric id or the full user URL.","description":"Follows another Goodreads member as the signed-in caller, by numeric id or the full user URL. Needs the caller signed in to Goodreads (an authFunction, a write).\n\nCalls `bowmark.providers.goodreads.followUser`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<{ memberId: string; following: true }>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"idOrUrl":{"type":"string","description":"TypeScript: `string`"},"opts":{"type":"object","properties":{"connection":{"type":"string"}},"required":["connection"],"additionalProperties":true,"description":"TypeScript: `ConnectionOption`"}},"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/goodreads/unfollowUser":{"post":{"operationId":"unfollowUser","summary":"Stops following another Goodreads member as the signed-in caller, by numeric id or the full user URL — the pair of followUser.","description":"Stops following another Goodreads member as the signed-in caller, by numeric id or the full user URL — the pair of followUser. Needs the caller signed in to Goodreads (an authFunction, a write).\n\nCalls `bowmark.providers.goodreads.unfollowUser`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<{ memberId: string; following: false }>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"idOrUrl":{"type":"string","description":"TypeScript: `string`"},"opts":{"type":"object","properties":{"connection":{"type":"string"}},"required":["connection"],"additionalProperties":true,"description":"TypeScript: `ConnectionOption`"}},"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/goodreads/getNewsFeed":{"post":{"operationId":"getNewsFeed","summary":"Reads the signed-in caller's friends feed — each row is who did what to which book (actorName, action like 'rated it' or 'is currently reading', bookTitle, bookId, author, timestamp), newest first as ","description":"Reads the signed-in caller's friends feed — each row is who did what to which book (actorName, action like 'rated it' or 'is currently reading', bookTitle, bookId, author, timestamp), newest first as Goodreads orders it. Needs the caller signed in to Goodreads (an authFunction).\n\nCalls `bowmark.providers.goodreads.getNewsFeed`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<GoodreadsUpdate[]>`.","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/goodreads/signup":{"post":{"operationId":"signup","summary":"Makes a NEW Goodreads account with the person's own email and password, in a session.","description":"Makes a NEW Goodreads account with the person's own email and password, in a session. Pauses with `needs_code` / `needs_phone` whenever the site wants something only the person has; continue with `confirmSignup` in the same session. Ends `signed_up` with the login saved and the credentials in the person's secrets.\n\nCalls `bowmark.providers.goodreads.signup`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<{ status: \"needs_code\"; channel: \"email\" | \"sms\"; sentTo?: string } | { status: \"needs_phone\" } | { status: \"in_progress\"; retryAfterSeconds: number } | { status: \"signed_up\"; username: string; email: string; connection: string | null; twoFactor: \"enrolled\" | \"none\"; secrets: string[] }>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"description":"TypeScript: `SignupInput`"}},"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/goodreads/confirmSignup":{"post":{"operationId":"confirmSignup","summary":"Continues the sign-up `signup` started in this session with the emailed or texted `code`, the email's verification `link`, or the person's `phone`.","description":"Continues the sign-up `signup` started in this session with the emailed or texted `code`, the email's verification `link`, or the person's `phone`.\n\nCalls `bowmark.providers.goodreads.confirmSignup`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<{ status: \"needs_code\"; channel: \"email\" | \"sms\"; sentTo?: string } | { status: \"needs_phone\" } | { status: \"in_progress\"; retryAfterSeconds: number } | { status: \"signed_up\"; username: string; email: string; connection: string | null; twoFactor: \"enrolled\" | \"none\"; secrets: string[] }>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"description":"TypeScript: `SignupConfirmInput`"}},"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}}}}}}