{"openapi":"3.1.0","info":{"title":"REVIEWS.io (BYOK) API","version":"0.1.0","description":"REVIEWS.io (BYOK) lets an AI assistant read your own REVIEWS.io data through the REVIEWS.io API with a key you supply (REVIEWS.io private API key). Read-only: 8 tools (get_review_stats, list_reviews, get_product_reviews, get_product_ratings, list_user_generated_content, list_review_nuggets, list_company_invitations, list_product_invitations). The BYOK key travels with each request, is used for...\n\nEvery operation is read-only or compute-only. The same tools are available over MCP (streamable HTTP) at https://byok-reviewsio.connectorbay.com/mcp.","contact":{"name":"Unify Dynamics LLC","email":"agent@connectorbay.com","url":"https://connectorbay.com/byok-reviewsio/docs"},"termsOfService":"https://connectorbay.com/byok-reviewsio/terms"},"servers":[{"url":"https://byok-reviewsio.connectorbay.com"}],"externalDocs":{"url":"https://connectorbay.com/byok-reviewsio/docs"},"security":[{"upstreamKey":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer","description":"Optional. A Pro API key raises rate limits; no credentials are required."},"upstreamKey":{"type":"apiKey","in":"header","name":"X-Upstream-Key","description":"Your own key for the service this connector wraps (bring your own key). Used for that one call only; never stored, logged or cached."}},"schemas":{"Error":{"type":"object","properties":{"ok":{"const":false},"error":{"type":"object"}}}}},"paths":{"/v1/tools/get_review_stats":{"post":{"operationId":"get_review_stats","summary":"Get average rating and total review counts for a store's product reviews, company reviews and third-party reviews. Use f","description":"Get average rating and total review counts for a store's product reviews, company reviews and third-party reviews. Use for \"What is my overall REVIEWS.io rating and review count\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"store":{"description":"Your REVIEWS.io public store key (a store identifier, not the private API key).","maxLength":100,"title":"Store","type":"string"}},"required":["store"],"title":"get_review_statsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_reviews":{"post":{"operationId":"list_reviews","summary":"List reviews and product questions of a store, filtered by type, product SKU, tag, keyword, minimum rating or dates, new","description":"List reviews and product questions of a store, filtered by type, product SKU, tag, keyword, minimum rating or dates, newest first by default. Use for \"Show my latest REVIEWS.io company reviews with a rating of 4 or more\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"store":{"description":"Your REVIEWS.io public store key (a store identifier, not the private API key).","maxLength":100,"title":"Store","type":"string"},"type":{"anyOf":[{"enum":["store_review","product_review","store_third_party_review","questions"],"type":"string"},{"type":"null"}],"default":null,"description":"Kind of items: store_review, product_review, store_third_party_review or questions.","title":"Type"},"sku":{"anyOf":[{"maxLength":300,"type":"string"},{"type":"null"}],"default":null,"description":"Product SKUs separated by semicolons.","title":"Sku"},"tag":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Review tags separated by semicolons.","title":"Tag"},"keyword":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Only reviews containing this text.","title":"Keyword"},"min_rating":{"anyOf":[{"enum":[1,2,3,4,5],"type":"integer"},{"type":"null"}],"default":null,"description":"Only reviews rated higher than this number of stars.","title":"Min Rating"},"date_from":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Only reviews newer than this date, YYYY-MM-DD.","title":"Date From"},"date_to":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Only reviews older than this date, YYYY-MM-DD.","title":"Date To"},"sort":{"anyOf":[{"enum":["date_desc","date_asc","highest_rating","lowest_rating","helpful_desc","helpful_asc","date_update_desc","date_update_asc"],"type":"string"},{"type":"null"}],"default":null,"description":"Order of results.","title":"Sort"},"must_have_body":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":null,"description":"True to return only reviews with a written comment.","title":"Must Have Body"},"per_page":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":20,"description":"How many items per page (this connector allows 1 to 100).","title":"Per Page"},"page":{"anyOf":[{"maximum":10000,"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page of results to return, starting at 1.","title":"Page"}},"required":["store"],"title":"list_reviewsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_product_reviews":{"post":{"operationId":"get_product_reviews","summary":"Get product reviews for specific SKUs with the product's rating statistics, filtered by minimum rating, comments, verifi","description":"Get product reviews for specific SKUs with the product's rating statistics, filtered by minimum rating, comments, verified buyers or dates. Use for \"What do customers say about product SKU ABC-123 on REVIEWS.io\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"store":{"description":"Your REVIEWS.io public store key (a store identifier, not the private API key).","maxLength":100,"title":"Store","type":"string"},"sku":{"anyOf":[{"maxLength":300,"type":"string"},{"type":"null"}],"default":null,"description":"Product SKUs separated by semicolons.","title":"Sku"},"min_rating":{"anyOf":[{"enum":[1,2,3,4,5],"type":"integer"},{"type":"null"}],"default":null,"description":"Only reviews rated higher than this number of stars.","title":"Min Rating"},"comments_only":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":null,"description":"True to return only reviews with comments.","title":"Comments Only"},"photos":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":null,"description":"True to return only reviews with photos.","title":"Photos"},"min_date":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Only reviews newer than this date, YYYY-MM-DD.","title":"Min Date"},"max_date":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Only reviews older than this date, YYYY-MM-DD.","title":"Max Date"},"per_page":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":20,"description":"How many items per page (this connector allows 1 to 100).","title":"Per Page"},"page":{"anyOf":[{"maximum":10000,"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page of results to return, starting at 1.","title":"Page"}},"required":["store"],"title":"get_product_reviewsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_product_ratings":{"post":{"operationId":"get_product_ratings","summary":"Get the average rating and number of ratings for one or more product SKUs. Use for \"What is the average rating of SKUs A","description":"Get the average rating and number of ratings for one or more product SKUs. Use for \"What is the average rating of SKUs ABC-123 and ABC-456\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"store":{"description":"Your REVIEWS.io public store key (a store identifier, not the private API key).","maxLength":100,"title":"Store","type":"string"},"sku":{"description":"Product SKUs separated by semicolons.","maxLength":300,"title":"Sku","type":"string"}},"required":["store","sku"],"title":"get_product_ratingsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_user_generated_content":{"post":{"operationId":"list_user_generated_content","summary":"List user generated content (customer photos and videos with comments and rating), optionally by SKU, tag, category or v","description":"List user generated content (customer photos and videos with comments and rating), optionally by SKU, tag, category or videos only. Use for \"Show customer photos for product SKU ABC-123 from REVIEWS.io\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"store":{"description":"Your REVIEWS.io public store key (a store identifier, not the private API key).","maxLength":100,"title":"Store","type":"string"},"sku":{"anyOf":[{"maxLength":300,"type":"string"},{"type":"null"}],"default":null,"description":"Product SKUs separated by semicolons.","title":"Sku"},"tags":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Tags separated by semicolons.","title":"Tags"},"categories":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Categories separated by semicolons.","title":"Categories"},"include_videos":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":null,"description":"True to return only videos.","title":"Include Videos"},"per_page":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":20,"description":"How many items per page (this connector allows 1 to 100).","title":"Per Page"}},"required":["store"],"title":"list_user_generated_contentArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_review_nuggets":{"post":{"operationId":"list_review_nuggets","summary":"List review nuggets (short highlighted quotes from reviews) by review type, minimum rating or SKU text. Use for \"Show sh","description":"List review nuggets (short highlighted quotes from reviews) by review type, minimum rating or SKU text. Use for \"Show short 5-star quotes from my REVIEWS.io store reviews\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"store":{"description":"Your REVIEWS.io public store key (a store identifier, not the private API key).","maxLength":100,"title":"Store","type":"string"},"types":{"description":"Review types, store_review or product_review.","enum":["store_review","product_review"],"title":"Types","type":"string"},"min_rating":{"anyOf":[{"enum":[1,2,3,4,5],"type":"integer"},{"type":"null"}],"default":null,"description":"Only reviews rated this number of stars or higher.","title":"Min Rating"},"per_page":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":20,"description":"How many nuggets to return (1 to 100).","title":"Per Page"}},"required":["store","types"],"title":"list_review_nuggetsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_company_invitations":{"post":{"operationId":"list_company_invitations","summary":"List company review invitations with order id, send status and send date (customer names and emails are not returned). U","description":"List company review invitations with order id, send status and send date (customer names and emails are not returned). Use for \"Which REVIEWS.io company review invitations have been sent\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"store":{"description":"Your REVIEWS.io public store key (a store identifier, not the private API key).","maxLength":100,"title":"Store","type":"string"}},"required":["store"],"title":"list_company_invitationsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_product_invitations":{"post":{"operationId":"list_product_invitations","summary":"List product review invitations with order id, send status and send date (customer names and emails are not returned). U","description":"List product review invitations with order id, send status and send date (customer names and emails are not returned). Use for \"Which REVIEWS.io product review invitations are queued\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"store":{"description":"Your REVIEWS.io public store key (a store identifier, not the private API key).","maxLength":100,"title":"Store","type":"string"}},"required":["store"],"title":"list_product_invitationsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}}}}