{"openapi":"3.1.0","info":{"title":"Trustpilot (BYOK) API","version":"0.1.0","description":"Trustpilot (BYOK) lets an AI assistant read your own Trustpilot data through the Trustpilot API with a key you supply (Trustpilot API key (public endpoints)). Read-only: 10 tools (find_business_unit, search_business_units, get_business_unit, get_business_unit_profile, list_business_unit_reviews, get_review, list_latest_reviews, list_categories, list_category_business_units,...\n\nEvery operation is read-only or compute-only. The same tools are available over MCP (streamable HTTP) at https://byok-trustpilot.connectorbay.com/mcp.","contact":{"name":"Unify Dynamics LLC","email":"agent@connectorbay.com","url":"https://connectorbay.com/byok-trustpilot/docs"},"termsOfService":"https://connectorbay.com/byok-trustpilot/terms"},"servers":[{"url":"https://byok-trustpilot.connectorbay.com"}],"externalDocs":{"url":"https://connectorbay.com/byok-trustpilot/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/find_business_unit":{"post":{"operationId":"find_business_unit","summary":"Find a company's Trustpilot business unit by its domain name and get its TrustScore, star rating, review counts per star","description":"Find a company's Trustpilot business unit by its domain name and get its TrustScore, star rating, review counts per star and status. Use for \"What is the Trustpilot TrustScore of trustpilot.com\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"name":{"description":"Domain name of the company, for example 'trustpilot.com'.","maxLength":200,"title":"Name","type":"string"}},"required":["name"],"title":"find_business_unitArguments","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/search_business_units":{"post":{"operationId":"search_business_units","summary":"Search business units by part of a name; returns id, display name and identifying domain for each match. Use for \"Which ","description":"Search business units by part of a name; returns id, display name and identifying domain for each match. Use for \"Which Trustpilot companies match the name 'acme'\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"query":{"description":"Search text matched against company names and domains.","maxLength":200,"title":"Query","type":"string"},"country":{"anyOf":[{"maxLength":2,"type":"string"},{"type":"null"}],"default":null,"description":"Two-letter country code to prefer, for example 'US'.","title":"Country"},"perpage":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":10,"description":"How many results per page.","title":"Perpage"},"page":{"anyOf":[{"maximum":1000,"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page number, starting at 1.","title":"Page"}},"required":["query"],"title":"search_business_unitsArguments","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_business_unit":{"post":{"operationId":"get_business_unit","summary":"Get a business unit's public data: name, website, country, TrustScore, stars and review counts per star. Use for \"Show T","description":"Get a business unit's public data: name, website, country, TrustScore, stars and review counts per star. Use for \"Show Trustpilot business unit 507f191e810c19729de860ea\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"business_unit_id":{"description":"Trustpilot business unit id (24 hex characters) from find_business_unit or search_business_units.","maxLength":200,"title":"Business Unit Id","type":"string"}},"required":["business_unit_id"],"title":"get_business_unitArguments","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_business_unit_profile":{"post":{"operationId":"get_business_unit_profile","summary":"Get a company's public profile text on Trustpilot: company name, description, address city and country, and whether the ","description":"Get a company's public profile text on Trustpilot: company name, description, address city and country, and whether the profile is claimed. Use for \"What does Trustpilot say about business unit 507f191e810c19729de860ea\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"business_unit_id":{"description":"Trustpilot business unit id (24 hex characters) from find_business_unit or search_business_units.","maxLength":200,"title":"Business Unit Id","type":"string"}},"required":["business_unit_id"],"title":"get_business_unit_profileArguments","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_business_unit_reviews":{"post":{"operationId":"list_business_unit_reviews","summary":"List public reviews of a business unit with stars, title, text, language, dates and company reply, filtered by stars, la","description":"List public reviews of a business unit with stars, title, text, language, dates and company reply, filtered by stars, language or reply state. Use for \"Show the latest 1-star Trustpilot reviews of business unit 507f191e810c19729de860ea\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"business_unit_id":{"description":"Trustpilot business unit id (24 hex characters) from find_business_unit or search_business_units.","maxLength":200,"title":"Business Unit Id","type":"string"},"stars":{"anyOf":[{"enum":[1,2,3,4,5],"type":"integer"},{"type":"null"}],"default":null,"description":"Only reviews with this number of stars.","title":"Stars"},"language":{"anyOf":[{"maxLength":10,"type":"string"},{"type":"null"}],"default":null,"description":"Only reviews written in this language code, for example 'en'.","title":"Language"},"order_by":{"anyOf":[{"enum":["createdat.desc","createdat.asc","stars.desc","stars.asc"],"type":"string"},{"type":"null"}],"default":"createdat.desc","description":"Order: createdat.desc, createdat.asc, stars.desc or stars.asc.","title":"Order By"},"responded":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":null,"description":"True for reviews the company replied to, false for those it did not.","title":"Responded"},"per_page":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":20,"description":"How many reviews per page.","title":"Per Page"},"page":{"anyOf":[{"maximum":1000,"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page number, starting at 1.","title":"Page"}},"required":["business_unit_id"],"title":"list_business_unit_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_review":{"post":{"operationId":"get_review","summary":"Get one public review by id with stars, text, dates, reviewer name and company reply. Use for \"Show Trustpilot review 50","description":"Get one public review by id with stars, text, dates, reviewer name and company reply. Use for \"Show Trustpilot review 507f191e810c19729de860ea\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"review_id":{"description":"Trustpilot review id (24 hex characters).","maxLength":200,"title":"Review Id","type":"string"}},"required":["review_id"],"title":"get_reviewArguments","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_latest_reviews":{"post":{"operationId":"list_latest_reviews","summary":"List the newest public reviews across Trustpilot written in one language. Use for \"What are the newest English reviews o","description":"List the newest public reviews across Trustpilot written in one language. Use for \"What are the newest English reviews on Trustpilot\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"language":{"description":"Language code of the reviews, for example 'en'.","maxLength":10,"title":"Language","type":"string"},"count":{"description":"How many reviews to return.","maximum":100,"minimum":1,"title":"Count","type":"integer"}},"required":["language","count"],"title":"list_latest_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/list_categories":{"post":{"operationId":"list_categories","summary":"List Trustpilot business categories (id and name), optionally the children of one parent category. Use for \"What top-lev","description":"List Trustpilot business categories (id and name), optionally the children of one parent category. Use for \"What top-level business categories does Trustpilot have\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"country":{"anyOf":[{"maxLength":2,"type":"string"},{"type":"null"}],"default":null,"description":"Two-letter country code (ISO 3166-1 alpha-2), for example 'US'.","title":"Country"},"parent_id":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Only children of this parent category id, for example 'animals_pets'.","title":"Parent Id"},"locale":{"anyOf":[{"maxLength":10,"type":"string"},{"type":"null"}],"default":null,"description":"Locale for translated names, for example 'en-US'.","title":"Locale"}},"title":"list_categoriesArguments","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_category_business_units":{"post":{"operationId":"list_category_business_units","summary":"List business units in a category with TrustScore, review count and city. Use for \"Which pet stores are listed on Trustp","description":"List business units in a category with TrustScore, review count and city. Use for \"Which pet stores are listed on Trustpilot in the US\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"category_id":{"description":"Category id from list_categories, for example 'pet_store'.","maxLength":200,"title":"Category Id","type":"string"},"country":{"anyOf":[{"maxLength":2,"type":"string"},{"type":"null"}],"default":null,"description":"Two-letter country code (ISO 3166-1 alpha-2), for example 'US'.","title":"Country"},"per_page":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":20,"description":"How many results per page.","title":"Per Page"},"page":{"anyOf":[{"maximum":1000,"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page number, starting at 1.","title":"Page"}},"required":["category_id"],"title":"list_category_business_unitsArguments","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_business_unit_categories":{"post":{"operationId":"list_business_unit_categories","summary":"List the categories a business unit is listed in. Use for \"Which Trustpilot categories is business unit 507f191e810c1972","description":"List the categories a business unit is listed in. Use for \"Which Trustpilot categories is business unit 507f191e810c19729de860ea in\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"business_unit_id":{"description":"Trustpilot business unit id (24 hex characters) from find_business_unit or search_business_units.","maxLength":200,"title":"Business Unit Id","type":"string"},"country":{"anyOf":[{"maxLength":2,"type":"string"},{"type":"null"}],"default":null,"description":"Two-letter country code (ISO 3166-1 alpha-2), for example 'US'.","title":"Country"},"locale":{"anyOf":[{"maxLength":10,"type":"string"},{"type":"null"}],"default":null,"description":"Locale for translated names, for example 'en-US'.","title":"Locale"}},"required":["business_unit_id"],"title":"list_business_unit_categoriesArguments","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}}}}