{"openapi":"3.1.0","info":{"title":"Pinterest API (Bowmark)","version":"e833508f87ff","description":"Pinterest — search its pins, boards, people and videos, read one pin in full with the product behind it when it is shoppable, walk anyone's boards and board sections, browse its idea topics, and (signed in as yourself) read your home feed, save pins, make boards, comment, follow and send.\n\nEvery function Bowmark has for Pinterest (pinterest.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/pinterest/searchPins":{"post":{"operationId":"searchPins","summary":"Search Pinterest the way a person types into its search box and get the pins back: `grid_title`, the outbound `link`, the pinner's username, the board it lives on, every image size, `product_metadata`","description":"Search Pinterest the way a person types into its search box and get the pins back: `grid_title`, the outbound `link`, the pinner's username, the board it lives on, every image size, `product_metadata` (price, currency, rating, review count) when the pin is shoppable, and a `bookmark` for the next page. `POST/GET /resource/BaseSearchResource/get/` with `scope: \"pins\"`. THROWS `PinterestInputError` on an empty or non-string query.\n\nCalls `bowmark.providers.pinterest.searchPins`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<{ pins: PinterestPin[]; bookmark: string | null }>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"query":{"type":"string","description":"TypeScript: `string`"},"options":{"type":"object","properties":{"bookmark":{"type":"string"}},"additionalProperties":true,"description":"TypeScript: `{ bookmark?: 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/pinterest/searchBoards":{"post":{"operationId":"searchBoards","summary":"Search for Pinterest boards by name and get the boards back: `id`, `name`, `url`, `pin_count`, and `section_count`.","description":"Search for Pinterest boards by name and get the boards back: `id`, `name`, `url`, `pin_count`, and `section_count`. `POST/GET /resource/BaseSearchResource/get/` with `scope: \"boards\"`. THROWS `PinterestInputError` on an empty or non-string query.\n\nCalls `bowmark.providers.pinterest.searchBoards`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<{ boards: PinterestBoard[]; bookmark: string | null }>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"query":{"type":"string","description":"TypeScript: `string`"},"options":{"type":"object","properties":{"bookmark":{"type":"string"}},"additionalProperties":true,"description":"TypeScript: `{ bookmark?: 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/pinterest/searchUsers":{"post":{"operationId":"searchUsers","summary":"Search for people and brands by name and get their account back: `id`, `username`, `full_name`, `follower_count`, `board_count`, `pin_count`, and `is_verified_merchant`.","description":"Search for people and brands by name and get their account back: `id`, `username`, `full_name`, `follower_count`, `board_count`, `pin_count`, and `is_verified_merchant`. `POST/GET /resource/BaseSearchResource/get/` with `scope: \"users\"`. THROWS `PinterestInputError` on an empty or non-string query.\n\nCalls `bowmark.providers.pinterest.searchUsers`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<{ users: PinterestUser[]; bookmark: string | null }>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"query":{"type":"string","description":"TypeScript: `string`"},"options":{"type":"object","properties":{"bookmark":{"type":"string"}},"additionalProperties":true,"description":"TypeScript: `{ bookmark?: 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/pinterest/searchVideos":{"post":{"operationId":"searchVideos","summary":"Search only the video pins in Pinterest's catalogue and get them back in the same shape as `searchPins`: `grid_title`, the outbound `link`, the pinner's username, the board it lives on, every image si","description":"Search only the video pins in Pinterest's catalogue and get them back in the same shape as `searchPins`: `grid_title`, the outbound `link`, the pinner's username, the board it lives on, every image size, and `product_metadata` when shoppable. The videos scope answers a caller who wants how-to clips instead of still images. `POST/GET /resource/BaseSearchResource/get/` with `scope: \"videos\"`. THROWS `PinterestInputError` on an empty or non-string query.\n\nCalls `bowmark.providers.pinterest.searchVideos`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<{ pins: PinterestPin[]; bookmark: string | null }>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"query":{"type":"string","description":"TypeScript: `string`"},"options":{"type":"object","properties":{"bookmark":{"type":"string"}},"additionalProperties":true,"description":"TypeScript: `{ bookmark?: 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/pinterest/getPin":{"post":{"operationId":"getPin","summary":"Read one pin in full: title, `seo_title`, the description Pinterest renders, the outbound `link` and `link_domain`, `created_at`, the pinner and the board it was saved to, every image size, `repin_cou","description":"Read one pin in full: title, `seo_title`, the description Pinterest renders, the outbound `link` and `link_domain`, `created_at`, the pinner and the board it was saved to, every image size, `repin_count` / `share_count` / `reaction_counts`, `price_value` and `price_currency` when it is shoppable, `carousel_data` and `videos` when it is not a still, and the `aggregated_pin_data.id` that `listPinComments` needs (not the pin id). `POST/GET /resource/PinResource/get/` with `field_set_key: \"auth_web_main_pin\"`. THROWS `PinterestInputError` on an empty or non-string id.\n\nCalls `bowmark.providers.pinterest.getPin`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<PinterestPinDetail>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"TypeScript: `string`"}},"required":["id"],"additionalProperties":false}}}},"responses":{"200":{"description":"The call ran. That includes a call that failed (`status: error`) or paused for a sign-in (`status: needs_user`), so branch on `status`.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/RunEnvelope"},{"type":"object","properties":{"result":{}}}]}}}},"400":{"description":"The body was malformed. `error` says what to send.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"401":{"description":"No API key, or a key that was refused.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"402":{"description":"The account is out of free usage, at its spend cap, or its card was declined. Fix billing at https://bowmark.ai/dashboard/billing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"404":{"$ref":"#/components/responses/NotFound"},"429":{"description":"Too many runs in flight on this account. Nothing was started or charged.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}},"headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Seconds to wait."}}},"503":{"description":"A failure on Bowmark's side. Retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}}}}},"/v1/sites/pinterest/getProduct":{"post":{"operationId":"getProduct","summary":"Read the product behind a shoppable pin: `price`, `currency`, `rating` and `review_count`, `availability` and `item_id`, plus the `item_set_id` if there are variants.","description":"Read the product behind a shoppable pin: `price`, `currency`, `rating` and `review_count`, `availability` and `item_id`, plus the `item_set_id` if there are variants. Stops at the merchant's link - it never buys. `POST/GET /resource/PinResource/get/` with `field_set_key: \"auth_web_main_pin\"`, extracting product metadata. THROWS `PinterestInputError` on an empty or non-string id.\n\nCalls `bowmark.providers.pinterest.getProduct`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<PinterestProduct>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"TypeScript: `string`"}},"required":["id"],"additionalProperties":false}}}},"responses":{"200":{"description":"The call ran. That includes a call that failed (`status: error`) or paused for a sign-in (`status: needs_user`), so branch on `status`.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/RunEnvelope"},{"type":"object","properties":{"result":{}}}]}}}},"400":{"description":"The body was malformed. `error` says what to send.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"401":{"description":"No API key, or a key that was refused.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"402":{"description":"The account is out of free usage, at its spend cap, or its card was declined. Fix billing at https://bowmark.ai/dashboard/billing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"404":{"$ref":"#/components/responses/NotFound"},"429":{"description":"Too many runs in flight on this account. Nothing was started or charged.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}},"headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Seconds to wait."}}},"503":{"description":"A failure on Bowmark's side. Retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}}}}},"/v1/sites/pinterest/listVisualObjects":{"post":{"operationId":"listVisualObjects","summary":"The objects Pinterest's own computer vision found inside a pin's image — each with a `label`, a `label_id`, a confidence `score`, and a bounding box (`x`/`y`/`w`/`h`, fractions of the image, not pixel","description":"The objects Pinterest's own computer vision found inside a pin's image — each with a `label`, a `label_id`, a confidence `score`, and a bounding box (`x`/`y`/`w`/`h`, fractions of the image, not pixels) — so an agent can say \"the lamp in this photo\" and hand that object on to `findVisuallySimilar`. Some detected objects carry no `label` at all. `POST/GET /resource/PinResource/get/` with `field_set_key: \"auth_web_main_pin\"` and `fetch_visual_search_objects: true`. THROWS `PinterestInputError` on an empty or non-string id.\n\nCalls `bowmark.providers.pinterest.listVisualObjects`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<{ objects: PinterestVisualObject[] }>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"TypeScript: `string`"}},"required":["id"],"additionalProperties":false}}}},"responses":{"200":{"description":"The call ran. That includes a call that failed (`status: error`) or paused for a sign-in (`status: needs_user`), so branch on `status`.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/RunEnvelope"},{"type":"object","properties":{"result":{}}}]}}}},"400":{"description":"The body was malformed. `error` says what to send.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"401":{"description":"No API key, or a key that was refused.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"402":{"description":"The account is out of free usage, at its spend cap, or its card was declined. Fix billing at https://bowmark.ai/dashboard/billing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"404":{"$ref":"#/components/responses/NotFound"},"429":{"description":"Too many runs in flight on this account. Nothing was started or charged.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}},"headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Seconds to wait."}}},"503":{"description":"A failure on Bowmark's side. Retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}}}}},"/v1/sites/pinterest/suggestSearches":{"post":{"operationId":"suggestSearches","summary":"Autocomplete a half-typed query the way Pinterest's search box does — hand it \"espre\" and get back the searches it would offer, so a vague ask becomes a query `searchPins` can take.","description":"Autocomplete a half-typed query the way Pinterest's search box does — hand it \"espre\" and get back the searches it would offer, so a vague ask becomes a query `searchPins` can take. The result mixes two kinds: a `\"query\"` suggestion is a phrase to search next, a `\"user\"` suggestion is a person or brand to follow instead. `POST/GET /resource/AdvancedTypeaheadResource/get/` with `{ term, pin_scope: \"pins\", autocomplete_request_surface: 0 }` — NOT `TypeaheadResource`, which answers `{\"items\":[]}` on every shape (see `BUILD_QUEUE.md`). THROWS `PinterestInputError` on an empty or non-string term.\n\nCalls `bowmark.providers.pinterest.suggestSearches`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<{ suggestions: PinterestSuggestion[] }>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"term":{"type":"string","description":"TypeScript: `string`"}},"required":["term"],"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/pinterest/getUser":{"post":{"operationId":"getUser","summary":"Read a person's or a brand's profile: `id`, `username`, `full_name`, `follower_count`, `following_count`, `board_count`, `pin_count`, `is_verified_merchant` and `website_url` — the door from a usernam","description":"Read a person's or a brand's profile: `id`, `username`, `full_name`, `follower_count`, `following_count`, `board_count`, `pin_count`, `is_verified_merchant` and `website_url` — the door from a username to everything else they own. `POST/GET /resource/UserResource/get/` with `field_set_key: \"unauth_profile\"`. THROWS `PinterestInputError` on an empty or non-string username.\n\nCalls `bowmark.providers.pinterest.getUser`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<PinterestUser>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"username":{"type":"string","description":"TypeScript: `string`"}},"required":["username"],"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/pinterest/listUserBoards":{"post":{"operationId":"listUserBoards","summary":"Every board a person has made public: `id`, `name`, `url`, `pin_count` and `section_count` — the list a caller walks before picking one for `getBoard`/`listBoardPins`.","description":"Every board a person has made public: `id`, `name`, `url`, `pin_count` and `section_count` — the list a caller walks before picking one for `getBoard`/`listBoardPins`. `POST/GET /resource/BoardsFeedResource/get/` with `{ username, field_set_key: \"profile_grid_item\", sort: \"last_pinned_to\" }`. THROWS `PinterestInputError` on an empty or non-string username.\n\nCalls `bowmark.providers.pinterest.listUserBoards`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<{ boards: PinterestBoard[]; bookmark: string | null }>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"username":{"type":"string","description":"TypeScript: `string`"},"options":{"type":"object","properties":{"bookmark":{"type":"string"}},"additionalProperties":true,"description":"TypeScript: `{ bookmark?: string }`"}},"required":["username"],"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/pinterest/listUserSavedPins":{"post":{"operationId":"listUserSavedPins","summary":"The pins a person has saved, newest first, across all their boards — what `/<username>/` actually shows a visitor.","description":"The pins a person has saved, newest first, across all their boards — what `/<username>/` actually shows a visitor. Same row shape as `searchPins`. `POST/GET /resource/UserPinsResource/get/` with `{ username, field_set_key: \"mobile_grid_item\", page_size: 25 }`. THROWS `PinterestInputError` on an empty or non-string username.\n\nCalls `bowmark.providers.pinterest.listUserSavedPins`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<{ pins: PinterestPin[]; bookmark: string | null }>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"username":{"type":"string","description":"TypeScript: `string`"},"options":{"type":"object","properties":{"bookmark":{"type":"string"}},"additionalProperties":true,"description":"TypeScript: `{ bookmark?: string }`"}},"required":["username"],"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/pinterest/listUserCreatedPins":{"post":{"operationId":"listUserCreatedPins","summary":"The pins a person made themselves rather than saved from somebody else — `/<username>/_created/`, which is the half that matters for a brand or a creator.","description":"The pins a person made themselves rather than saved from somebody else — `/<username>/_created/`, which is the half that matters for a brand or a creator. Same row shape as `searchPins`. `POST/GET /resource/UserActivityPinsResource/get/` with `{ username, field_set_key: \"mobile_grid_item\", page_size: 25 }`. THROWS `PinterestInputError` on an empty or non-string username.\n\nCalls `bowmark.providers.pinterest.listUserCreatedPins`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<{ pins: PinterestPin[]; bookmark: string | null }>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"username":{"type":"string","description":"TypeScript: `string`"},"options":{"type":"object","properties":{"bookmark":{"type":"string"}},"additionalProperties":true,"description":"TypeScript: `{ bookmark?: string }`"}},"required":["username"],"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/pinterest/getBoard":{"post":{"operationId":"getBoard","summary":"Read one board: `name`, `description`, `owner` (id, username, full_name), `pin_count`, `follower_count`, `section_count`, `privacy` and `image_cover_url` — the door a caller reaches after `listUserBoa","description":"Read one board: `name`, `description`, `owner` (id, username, full_name), `pin_count`, `follower_count`, `section_count`, `privacy` and `image_cover_url` — the door a caller reaches after `listUserBoards`/`searchBoards` picks a good one, before `listBoardPins`. Takes the `username`/`slug` pair straight off a pinterest.com board url (`/<username>/<slug>/`), the same pair `listUserBoards`' `url` field carries. `POST/GET /resource/BoardResource/get/` with `{ username, slug, field_set_key: \"profile_grid_item\" }`. THROWS `PinterestInputError` on an empty or non-string username or slug.\n\nCalls `bowmark.providers.pinterest.getBoard`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<PinterestBoardDetail>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"username":{"type":"string","description":"TypeScript: `string`"},"slug":{"type":"string","description":"TypeScript: `string`"}},"required":["username","slug"],"additionalProperties":false}}}},"responses":{"200":{"description":"The call ran. That includes a call that failed (`status: error`) or paused for a sign-in (`status: needs_user`), so branch on `status`.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/RunEnvelope"},{"type":"object","properties":{"result":{}}}]}}}},"400":{"description":"The body was malformed. `error` says what to send.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"401":{"description":"No API key, or a key that was refused.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"402":{"description":"The account is out of free usage, at its spend cap, or its card was declined. Fix billing at https://bowmark.ai/dashboard/billing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"404":{"$ref":"#/components/responses/NotFound"},"429":{"description":"Too many runs in flight on this account. Nothing was started or charged.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}},"headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Seconds to wait."}}},"503":{"description":"A failure on Bowmark's side. Retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}}}}},"/v1/sites/pinterest/listBoardPins":{"post":{"operationId":"listBoardPins","summary":"Every pin inside a board, in the board's own order, with a `bookmark` for the next page — the function a caller reaches for after `getBoard`/`listUserBoards` finds a board's id.","description":"Every pin inside a board, in the board's own order, with a `bookmark` for the next page — the function a caller reaches for after `getBoard`/`listUserBoards` finds a board's id. Same row shape as `searchPins`. Takes the board `id` (`getBoard`'s `id` field, or a row from `listUserBoards`/`searchBoards`). `POST/GET /resource/BoardFeedResource/get/` with `{ board_id }` — the default field set already carries `grid_title`, `link`, `pinner` and `board`; the `react_grid_pin` field set survey measured answers only `id`/`images`. THROWS `PinterestInputError` on an empty or non-string board id.\n\nCalls `bowmark.providers.pinterest.listBoardPins`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<{ pins: PinterestPin[]; bookmark: string | null }>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"boardId":{"type":"string","description":"TypeScript: `string`"},"options":{"type":"object","properties":{"bookmark":{"type":"string"}},"additionalProperties":true,"description":"TypeScript: `{ bookmark?: string }`"}},"required":["boardId"],"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/pinterest/listBoardSections":{"post":{"operationId":"listBoardSections","summary":"The sections a board is divided into — a 258-pin board is usually 29 sections, and without them a caller gets one undifferentiated pile.","description":"The sections a board is divided into — a 258-pin board is usually 29 sections, and without them a caller gets one undifferentiated pile. Each section carries `title`, `slug`, `pin_count` and a handful of `preview_pins` (id, title, link). A board with none answers a real, empty `[]` — that is the board's own fact, not a wall. Takes the board `id` (`getBoard`'s `id` field). `POST/GET /resource/BoardSectionsResource/get/` with `{ board_id }`. THROWS `PinterestInputError` on an empty or non-string board id.\n\nCalls `bowmark.providers.pinterest.listBoardSections`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<{ sections: PinterestBoardSection[] }>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"boardId":{"type":"string","description":"TypeScript: `string`"}},"required":["boardId"],"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/pinterest/listBoardSectionPins":{"post":{"operationId":"listBoardSectionPins","summary":"The pins inside one section of a board, taking the section `id` `listBoardSections` returns.","description":"The pins inside one section of a board, taking the section `id` `listBoardSections` returns. Same row shape as `searchPins`. `POST/GET /resource/BoardSectionPinsResource/get/` with `{ section_id, page_size: 25 }`. THROWS `PinterestInputError` on an empty or non-string section id.\n\nCalls `bowmark.providers.pinterest.listBoardSectionPins`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<{ pins: PinterestPin[]; bookmark: string | null }>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"sectionId":{"type":"string","description":"TypeScript: `string`"},"options":{"type":"object","properties":{"bookmark":{"type":"string"}},"additionalProperties":true,"description":"TypeScript: `{ bookmark?: string }`"}},"required":["sectionId"],"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/pinterest/listTopics":{"post":{"operationId":"listTopics","summary":"Pinterest's own top-level idea topics — Food and Drink, Home Decor, Travel, Tattoos and the rest, plus the odd seasonal one (`isHoliday: true`) when the calendar is near it — each with the interest `i","description":"Pinterest's own top-level idea topics — Food and Drink, Home Decor, Travel, Tattoos and the rest, plus the odd seasonal one (`isHoliday: true`) when the calendar is near it — each with the interest `id` that `getTopic` and `listTopicPins` take. The door for a caller who wants to browse rather than search. Reads the `/ideas/` page's OWN embedded relay payload (the `\"v3IdeasRootPageInterestsQuery\"` value every load carries) rather than a `/resource/` call — static fetch and parse, no `_client`.\n\nCalls `bowmark.providers.pinterest.listTopics`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<{ topics: PinterestTopic[] }>`.","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/pinterest/getTopic":{"post":{"operationId":"getTopic","summary":"Read one idea topic: its display name, its own `key`/`slug`, its follower count, whether the caller (logged out, always `false`) follows it, and whether it has related topics.","description":"Read one idea topic: its display name, its own `key`/`slug`, its follower count, whether the caller (logged out, always `false`) follows it, and whether it has related topics. Takes the interest `id` from `listTopics`. `POST/GET /resource/InterestResource/get/` with `{ interest: topicId, field_set_key: \"ideas_hub\" }`. THROWS `PinterestInputError` on an empty or non-string topic id.\n\nCalls `bowmark.providers.pinterest.getTopic`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<PinterestTopicDetail>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"topicId":{"type":"string","description":"TypeScript: `string`"}},"required":["topicId"],"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/pinterest/listTopicPins":{"post":{"operationId":"listTopicPins","summary":"The best pins in a topic — Pinterest's editorial feed for that interest, which is the closest thing an anonymous caller has to the home feed.","description":"The best pins in a topic — Pinterest's editorial feed for that interest, which is the closest thing an anonymous caller has to the home feed. A thinner row than `searchPins`: image and dominant color only, no title, link, pinner or board. Does not page — the site answers one fixed batch. Takes the interest `id` from `listTopics`. `POST/GET /resource/BestPinsFeedAltResource/get/` with `{ add_vase: true, field_set_key: \"unauth_react\", gated: true, img_nii: true, interest: topicId, override_ids: [] }`. THROWS `PinterestInputError` on an empty or non-string topic id.\n\nCalls `bowmark.providers.pinterest.listTopicPins`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<{ pins: PinterestIdeaPin[] }>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"topicId":{"type":"string","description":"TypeScript: `string`"}},"required":["topicId"],"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/pinterest/getCurrentUser":{"post":{"operationId":"getCurrentUser","summary":"Who the caller is signed in as — the same profile `getUser` returns (`id`, `username`, `full_name`, follower/board/pin counts), for the account whose session this run replays.","description":"Who the caller is signed in as — the same profile `getUser` returns (`id`, `username`, `full_name`, follower/board/pin counts), for the account whose session this run replays. The cheapest way to confirm a sign-in took before trying a write. Needs the caller signed in to Pinterest: `GET /resource/UserSettingsResource/get/` with their session gives the username, then `UserResource` the profile. THROWS when the saved session is refused (the run asks for a fresh sign-in).\n\nCalls `bowmark.providers.pinterest.getCurrentUser`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<PinterestUser>`.","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/pinterest/getHomeFeed":{"post":{"operationId":"getHomeFeed","summary":"The caller's own personalised Pinterest home feed, same row shape as `searchPins`, with a `bookmark` for the next page — the thing the site is actually for once you have an account, and nothing an ano","description":"The caller's own personalised Pinterest home feed, same row shape as `searchPins`, with a `bookmark` for the next page — the thing the site is actually for once you have an account, and nothing an anonymous caller can approximate. Needs the caller signed in to Pinterest: `GET /resource/UserHomefeedResource/get/` with their replayed session. THROWS when the saved session is refused (the run asks for a fresh sign-in).\n\nCalls `bowmark.providers.pinterest.getHomeFeed`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<{ pins: PinterestPin[]; bookmark: string | null }>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"options":{"type":"object","properties":{"bookmark":{"type":"string"}},"additionalProperties":true,"description":"TypeScript: `{ bookmark?: string }`"},"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/pinterest/searchMyPins":{"post":{"operationId":"searchMyPins","summary":"Search only inside the caller's own saved pins — the \"where did I save that\" question.","description":"Search only inside the caller's own saved pins — the \"where did I save that\" question. Same row shape and paging as `searchPins`. `POST/GET /resource/BaseSearchResource/get/` with `scope: \"my_pins\"` and the caller's replayed session. THROWS `PinterestInputError` on an empty or non-string query, and throws when the saved session is refused (the run asks for a fresh sign-in).\n\nCalls `bowmark.providers.pinterest.searchMyPins`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<{ pins: PinterestPin[]; bookmark: string | null }>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"query":{"type":"string","description":"TypeScript: `string`"},"options":{"type":"object","properties":{"bookmark":{"type":"string"}},"additionalProperties":true,"description":"TypeScript: `{ bookmark?: string }`"},"opts":{"type":"object","properties":{"connection":{"type":"string"}},"required":["connection"],"additionalProperties":true,"description":"TypeScript: `ConnectionOption`"}},"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/pinterest/listUserFollowing":{"post":{"operationId":"listUserFollowing","summary":"Who a person follows — people, boards and topics, as the caller's own signed-in session sees it.","description":"Who a person follows — people, boards and topics, as the caller's own signed-in session sees it. `POST/GET /resource/UserFollowingResource/get/` with the caller's replayed session. THROWS `PinterestInputError` on an empty or non-string username, and throws when the saved session is refused (the run asks for a fresh sign-in).\n\nCalls `bowmark.providers.pinterest.listUserFollowing`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<{ users: PinterestUser[]; bookmark: string | null }>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"username":{"type":"string","description":"TypeScript: `string`"},"options":{"type":"object","properties":{"bookmark":{"type":"string"}},"additionalProperties":true,"description":"TypeScript: `{ bookmark?: string }`"},"opts":{"type":"object","properties":{"connection":{"type":"string"}},"required":["connection"],"additionalProperties":true,"description":"TypeScript: `ConnectionOption`"}},"required":["username"],"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/pinterest/listConversations":{"post":{"operationId":"listConversations","summary":"The caller's Pinterest inbox — every thread they are in, with its board (when the thread shares one), who is on it, whether it is unread, and its last message.","description":"The caller's Pinterest inbox — every thread they are in, with its board (when the thread shares one), who is on it, whether it is unread, and its last message. `POST/GET /resource/ConversationsResource/get/` with `{ field_set_key: \"default\" }` and the caller's replayed session — does not page, the site answers the whole list in one call. THROWS when the saved session is refused (the run asks for a fresh sign-in).\n\nCalls `bowmark.providers.pinterest.listConversations`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<{ conversations: PinterestConversation[] }>`.","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/pinterest/createBoard":{"post":{"operationId":"createBoard","summary":"Make a new board on the signed-in caller's profile and get it back with its `id` and `url`.","description":"Make a new board on the signed-in caller's profile and get it back with its `id` and `url`. SECRET unless `privacy: \"public\"` is passed, so nothing appears to anyone else by default. `POST /resource/BoardResource/create/` with `{ name, privacy }`. THROWS `PinterestInputError` on an empty name or an unknown privacy, and when the saved session is refused (the run asks for a fresh sign-in).\n\nCalls `bowmark.providers.pinterest.createBoard`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<PinterestBoard>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"TypeScript: `string`"},"options":{"type":"object","properties":{"privacy":{"anyOf":[{"const":"secret"},{"const":"public"}]},"description":{"type":"string"}},"additionalProperties":true,"description":"TypeScript: `{ privacy?: \"secret\" | \"public\"; description?: string }`"},"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/pinterest/hidePin":{"post":{"operationId":"hidePin","summary":"Tell Pinterest the signed-in caller does not want to see a pin in their home feed — the feed's own \"Hide Pin\" — or take it back with `{ undo: true }`.","description":"Tell Pinterest the signed-in caller does not want to see a pin in their home feed — the feed's own \"Hide Pin\" — or take it back with `{ undo: true }`. Account-scoped: nobody else's view changes and nobody is notified. `POST /resource/ApiResource/update/` proxying the site's own `PUT /v3/pfy/<pin>/feedback/` (`feedback_type: 1`). THROWS `PinterestInputError` on a non-numeric pin id, and when the saved session is refused (the run asks for a fresh sign-in).\n\nCalls `bowmark.providers.pinterest.hidePin`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<{ pinId: string; hidden: boolean }>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"pinId":{"type":"string","description":"TypeScript: `string`"},"options":{"type":"object","properties":{"undo":{"type":"boolean"}},"additionalProperties":true,"description":"TypeScript: `{ undo?: boolean }`"},"opts":{"type":"object","properties":{"connection":{"type":"string"}},"required":["connection"],"additionalProperties":true,"description":"TypeScript: `ConnectionOption`"}},"required":["pinId"],"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/pinterest/updateBoard":{"post":{"operationId":"updateBoard","summary":"Rename one of the signed-in caller's boards, change its description, or flip it between public and secret, and get the board back.","description":"Rename one of the signed-in caller's boards, change its description, or flip it between public and secret, and get the board back. `POST /resource/BoardResource/update/` with `{ board_id, ...changes }`. THROWS `PinterestInputError` on a non-numeric board id, no change, or an unknown privacy, and when the saved session is refused (the run asks for a fresh sign-in).\n\nCalls `bowmark.providers.pinterest.updateBoard`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<PinterestBoard>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"boardId":{"type":"string","description":"TypeScript: `string`"},"changes":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"},"privacy":{"anyOf":[{"const":"secret"},{"const":"public"}]}},"additionalProperties":true,"description":"TypeScript: `{ name?: string; description?: string; privacy?: \"secret\" | \"public\" }`"},"opts":{"type":"object","properties":{"connection":{"type":"string"}},"required":["connection"],"additionalProperties":true,"description":"TypeScript: `ConnectionOption`"}},"required":["boardId","changes"],"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/pinterest/deleteBoard":{"post":{"operationId":"deleteBoard","summary":"Delete one of the signed-in caller's own boards and every pin saved on it — the undo for `createBoard`.","description":"Delete one of the signed-in caller's own boards and every pin saved on it — the undo for `createBoard`. Not reversible. `POST /resource/BoardResource/delete/` with `{ board_id }`. THROWS `PinterestInputError` on a non-numeric board id, and when the saved session is refused (the run asks for a fresh sign-in).\n\nCalls `bowmark.providers.pinterest.deleteBoard`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<{ boardId: string; deleted: boolean }>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"boardId":{"type":"string","description":"TypeScript: `string`"},"opts":{"type":"object","properties":{"connection":{"type":"string"}},"required":["connection"],"additionalProperties":true,"description":"TypeScript: `ConnectionOption`"}},"required":["boardId"],"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/pinterest/savePin":{"post":{"operationId":"savePin","summary":"Save (repin) an existing pin to one of the signed-in caller's boards, optionally into a section and with their own note, and get the new pin back.","description":"Save (repin) an existing pin to one of the signed-in caller's boards, optionally into a section and with their own note, and get the new pin back. `POST /resource/RepinResource/create/` with `{ pin_id, board_id }`. THROWS `PinterestInputError` on a non-numeric pin, board or section id, and when the saved session is refused (the run asks for a fresh sign-in).\n\nCalls `bowmark.providers.pinterest.savePin`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<PinterestPin>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"pinId":{"type":"string","description":"TypeScript: `string`"},"boardId":{"type":"string","description":"TypeScript: `string`"},"options":{"type":"object","properties":{"sectionId":{"type":"string"},"description":{"type":"string"}},"additionalProperties":true,"description":"TypeScript: `{ sectionId?: string; description?: string }`"},"opts":{"type":"object","properties":{"connection":{"type":"string"}},"required":["connection"],"additionalProperties":true,"description":"TypeScript: `ConnectionOption`"}},"required":["pinId","boardId"],"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/pinterest/deletePin":{"post":{"operationId":"deletePin","summary":"Delete a pin the signed-in caller created or saved — the undo for `savePin` and `createPin`.","description":"Delete a pin the signed-in caller created or saved — the undo for `savePin` and `createPin`. Not reversible. `POST /resource/ApiResource/delete/` proxying `DELETE /v3/pins/<id>/`. THROWS `PinterestInputError` on a non-numeric pin id, and when the saved session is refused (the run asks for a fresh sign-in).\n\nCalls `bowmark.providers.pinterest.deletePin`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<{ pinId: string; deleted: boolean }>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"pinId":{"type":"string","description":"TypeScript: `string`"},"opts":{"type":"object","properties":{"connection":{"type":"string"}},"required":["connection"],"additionalProperties":true,"description":"TypeScript: `ConnectionOption`"}},"required":["pinId"],"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/pinterest/createPin":{"post":{"operationId":"createPin","summary":"Publish a new pin on one of the signed-in caller's boards from a public image URL, with an optional destination link, title, description and section.","description":"Publish a new pin on one of the signed-in caller's boards from a public image URL, with an optional destination link, title, description and section. A Bowmark file works as the image: `bowmark.files.makePublic(id)` returns the URL. `POST /resource/PinResource/create/` with `{ board_id, image_url, … }`. THROWS `PinterestInputError` on a non-numeric board or section id or a missing image URL, and when the saved session is refused (the run asks for a fresh sign-in).\n\nCalls `bowmark.providers.pinterest.createPin`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<PinterestPin>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"boardId":{"type":"string","description":"TypeScript: `string`"},"pin":{"type":"object","properties":{"imageUrl":{"type":"string"},"link":{"type":"string"},"title":{"type":"string"},"description":{"type":"string"},"sectionId":{"type":"string"}},"required":["imageUrl"],"additionalProperties":true,"description":"TypeScript: `{ imageUrl: string; link?: string; title?: string; description?: string; sectionId?: string }`"},"opts":{"type":"object","properties":{"connection":{"type":"string"}},"required":["connection"],"additionalProperties":true,"description":"TypeScript: `ConnectionOption`"}},"required":["boardId","pin"],"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/pinterest/updateProfile":{"post":{"operationId":"updateProfile","summary":"Edit the signed-in caller's own profile text — display name, bio and website — and get the saved settings back.","description":"Edit the signed-in caller's own profile text — display name, bio and website — and get the saved settings back. `POST /resource/UserSettingsResource/update/`. THROWS `PinterestInputError` when no field is given or one is not a string, and when the saved session is refused (the run asks for a fresh sign-in).\n\nCalls `bowmark.providers.pinterest.updateProfile`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<Record<string, unknown>>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"changes":{"type":"object","properties":{"firstName":{"type":"string"},"lastName":{"type":"string"},"about":{"type":"string"},"websiteUrl":{"type":"string"}},"additionalProperties":true,"description":"TypeScript: `{ firstName?: string; lastName?: string; about?: string; websiteUrl?: string }`"},"opts":{"type":"object","properties":{"connection":{"type":"string"}},"required":["connection"],"additionalProperties":true,"description":"TypeScript: `ConnectionOption`"}},"required":["changes"],"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/pinterest/reactToPin":{"post":{"operationId":"reactToPin","summary":"React to a pin as the signed-in caller (`reactionType` is a key of `getPin`'s `reaction_counts`; 1, the heart, by default), or take it back with `{ undo: true }`.","description":"React to a pin as the signed-in caller (`reactionType` is a key of `getPin`'s `reaction_counts`; 1, the heart, by default), or take it back with `{ undo: true }`. The pin's owner sees it. `ApiResource` create / delete proxying `/v3/pins/<id>/react/`. THROWS `PinterestInputError` on a non-numeric pin id or a bad reaction type, and when the saved session is refused (the run asks for a fresh sign-in).\n\nCalls `bowmark.providers.pinterest.reactToPin`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<{ pinId: string; reactionType: number; reacted: boolean }>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"pinId":{"type":"string","description":"TypeScript: `string`"},"options":{"type":"object","properties":{"reactionType":{"type":"number"},"undo":{"type":"boolean"}},"additionalProperties":true,"description":"TypeScript: `{ reactionType?: number; undo?: boolean }`"},"opts":{"type":"object","properties":{"connection":{"type":"string"}},"required":["connection"],"additionalProperties":true,"description":"TypeScript: `ConnectionOption`"}},"required":["pinId"],"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/pinterest/commentOnPin":{"post":{"operationId":"commentOnPin","summary":"Post a PUBLIC comment on a pin as the signed-in caller; the owner is notified.","description":"Post a PUBLIC comment on a pin as the signed-in caller; the owner is notified. Looks up the pin's `aggregated_pin_data.id` itself unless you pass it. `POST /resource/AggregatedCommentResource/create/`. THROWS `PinterestInputError` on a non-numeric pin id or empty text, and when the saved session is refused (the run asks for a fresh sign-in).\n\nCalls `bowmark.providers.pinterest.commentOnPin`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<Record<string, unknown>>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"pinId":{"type":"string","description":"TypeScript: `string`"},"text":{"type":"string","description":"TypeScript: `string`"},"options":{"type":"object","properties":{"aggregatedPinDataId":{"type":"string"}},"additionalProperties":true,"description":"TypeScript: `{ aggregatedPinDataId?: string }`"},"opts":{"type":"object","properties":{"connection":{"type":"string"}},"required":["connection"],"additionalProperties":true,"description":"TypeScript: `ConnectionOption`"}},"required":["pinId","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/pinterest/sendPin":{"post":{"operationId":"sendPin","summary":"Send a pin to one or more people in a Pinterest message as the signed-in caller (recipients are Pinterest user ids from `getUser` / `searchUsers`, or email addresses), with an optional note.","description":"Send a pin to one or more people in a Pinterest message as the signed-in caller (recipients are Pinterest user ids from `getUser` / `searchUsers`, or email addresses), with an optional note. It REACHES REAL PEOPLE. `POST /resource/ConversationsResource/create/`. THROWS `PinterestInputError` on a non-numeric pin id, no recipient, or a malformed recipient, and when the saved session is refused (the run asks for a fresh sign-in).\n\nCalls `bowmark.providers.pinterest.sendPin`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<Record<string, unknown>>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"pinId":{"type":"string","description":"TypeScript: `string`"},"recipients":{"type":"object","properties":{"userIds":{"type":"array","items":{"type":"string"}},"emails":{"type":"array","items":{"type":"string"}}},"additionalProperties":true,"description":"TypeScript: `{ userIds?: string[]; emails?: string[] }`"},"options":{"type":"object","properties":{"message":{"type":"string"}},"additionalProperties":true,"description":"TypeScript: `{ message?: string }`"},"opts":{"type":"object","properties":{"connection":{"type":"string"}},"required":["connection"],"additionalProperties":true,"description":"TypeScript: `ConnectionOption`"}},"required":["pinId","recipients"],"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/pinterest/followTopic":{"post":{"operationId":"followTopic","summary":"Follow one of Pinterest's idea topics (an id from `listTopics` or `getTopic`) for the signed-in caller, which steers their home feed.","description":"Follow one of Pinterest's idea topics (an id from `listTopics` or `getTopic`) for the signed-in caller, which steers their home feed. Nobody is notified. `ApiResource` update proxying `PUT /v3/users/me/interests/favorited/<id>/`. THROWS `PinterestInputError` on a non-numeric topic id, and when the saved session is refused (the run asks for a fresh sign-in).\n\nCalls `bowmark.providers.pinterest.followTopic`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<{ topicId: string; following: boolean }>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"topicId":{"type":"string","description":"TypeScript: `string`"},"opts":{"type":"object","properties":{"connection":{"type":"string"}},"required":["connection"],"additionalProperties":true,"description":"TypeScript: `ConnectionOption`"}},"required":["topicId"],"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/pinterest/unfollowTopic":{"post":{"operationId":"unfollowTopic","summary":"Stop following an idea topic — the undo for `followTopic`.","description":"Stop following an idea topic — the undo for `followTopic`. `ApiResource` delete proxying `DELETE /v3/users/me/interests/favorited/<id>/`. THROWS `PinterestInputError` on a non-numeric topic id, and when the saved session is refused (the run asks for a fresh sign-in).\n\nCalls `bowmark.providers.pinterest.unfollowTopic`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<{ topicId: string; following: boolean }>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"topicId":{"type":"string","description":"TypeScript: `string`"},"opts":{"type":"object","properties":{"connection":{"type":"string"}},"required":["connection"],"additionalProperties":true,"description":"TypeScript: `ConnectionOption`"}},"required":["topicId"],"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/pinterest/followUser":{"post":{"operationId":"followUser","summary":"Follow a person or brand (the numeric `id` from `getUser` or `searchUsers`) for the signed-in caller.","description":"Follow a person or brand (the numeric `id` from `getUser` or `searchUsers`) for the signed-in caller. NOTIFIES that account. `ApiResource` update proxying `PUT /v3/users/<id>/follow/`. THROWS `PinterestInputError` on a non-numeric user id, and when the saved session is refused (the run asks for a fresh sign-in).\n\nCalls `bowmark.providers.pinterest.followUser`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<{ userId: string; following: boolean }>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"userId":{"type":"string","description":"TypeScript: `string`"},"opts":{"type":"object","properties":{"connection":{"type":"string"}},"required":["connection"],"additionalProperties":true,"description":"TypeScript: `ConnectionOption`"}},"required":["userId"],"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/pinterest/unfollowUser":{"post":{"operationId":"unfollowUser","summary":"Stop following a person or brand — the undo for `followUser`.","description":"Stop following a person or brand — the undo for `followUser`. `ApiResource` delete proxying `DELETE /v3/users/<id>/follow/`. THROWS `PinterestInputError` on a non-numeric user id, and when the saved session is refused (the run asks for a fresh sign-in).\n\nCalls `bowmark.providers.pinterest.unfollowUser`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<{ userId: string; following: boolean }>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"userId":{"type":"string","description":"TypeScript: `string`"},"opts":{"type":"object","properties":{"connection":{"type":"string"}},"required":["connection"],"additionalProperties":true,"description":"TypeScript: `ConnectionOption`"}},"required":["userId"],"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/pinterest/followBoard":{"post":{"operationId":"followBoard","summary":"Follow one board (the numeric `id` from `getBoard`, `searchBoards` or `listUserBoards`) for the signed-in caller, so its new pins reach their home feed.","description":"Follow one board (the numeric `id` from `getBoard`, `searchBoards` or `listUserBoards`) for the signed-in caller, so its new pins reach their home feed. NOTIFIES the board's owner. `ApiResource` update proxying `PUT /v3/boards/<id>/follow/`. THROWS `PinterestInputError` on a non-numeric board id, and when the saved session is refused (the run asks for a fresh sign-in).\n\nCalls `bowmark.providers.pinterest.followBoard`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<{ boardId: string; following: boolean }>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"boardId":{"type":"string","description":"TypeScript: `string`"},"opts":{"type":"object","properties":{"connection":{"type":"string"}},"required":["connection"],"additionalProperties":true,"description":"TypeScript: `ConnectionOption`"}},"required":["boardId"],"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/pinterest/unfollowBoard":{"post":{"operationId":"unfollowBoard","summary":"Stop following a board — the undo for `followBoard`.","description":"Stop following a board — the undo for `followBoard`. `ApiResource` delete proxying `DELETE /v3/boards/<id>/follow/`. THROWS `PinterestInputError` on a non-numeric board id, and when the saved session is refused (the run asks for a fresh sign-in).\n\nCalls `bowmark.providers.pinterest.unfollowBoard`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<{ boardId: string; following: boolean }>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"boardId":{"type":"string","description":"TypeScript: `string`"},"opts":{"type":"object","properties":{"connection":{"type":"string"}},"required":["connection"],"additionalProperties":true,"description":"TypeScript: `ConnectionOption`"}},"required":["boardId"],"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/pinterest/listNotifications":{"post":{"operationId":"listNotifications","summary":"The caller's own notifications — who saved, commented on or followed them, newest first, page by page.","description":"The caller's own notifications — who saved, commented on or followed them, newest first, page by page. `GET /resource/ApiResource/get/` proxying the site's own `/v3/news_hub/feed/` call, with the caller's replayed session. THROWS when the saved session is refused (the run asks for a fresh sign-in).\n\nCalls `bowmark.providers.pinterest.listNotifications`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<{ notifications: PinterestNotification[]; bookmark: string | null }>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"options":{"type":"object","properties":{"bookmark":{"type":"string"},"pageSize":{"type":"number"}},"additionalProperties":true,"description":"TypeScript: `{ bookmark?: string; pageSize?: number }`"},"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/pinterest/listUserFollowers":{"post":{"operationId":"listUserFollowers","summary":"Who follows a person, page by page — the audience side of a profile (the COUNT alone is public, on `getUser`).","description":"Who follows a person, page by page — the audience side of a profile (the COUNT alone is public, on `getUser`). `GET /resource/ApiResource/get/` proxying `/v3/users/<username>/followers/`, with the caller's replayed session. THROWS `PinterestInputError` on an empty or non-string username, and throws when the saved session is refused.\n\nCalls `bowmark.providers.pinterest.listUserFollowers`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<{ users: PinterestUser[]; bookmark: string | null }>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"username":{"type":"string","description":"TypeScript: `string`"},"options":{"type":"object","properties":{"bookmark":{"type":"string"},"pageSize":{"type":"number"}},"additionalProperties":true,"description":"TypeScript: `{ bookmark?: string; pageSize?: number }`"},"opts":{"type":"object","properties":{"connection":{"type":"string"}},"required":["connection"],"additionalProperties":true,"description":"TypeScript: `ConnectionOption`"}},"required":["username"],"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/pinterest/signup":{"post":{"operationId":"signup","summary":"Makes a NEW Pinterest account with the person's own email and password, in a session.","description":"Makes a NEW Pinterest 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.pinterest.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/pinterest/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.pinterest.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}}}}}}