Skip to main content
POST

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
productName
string

Product Name

category
enum<string>

Product Category

Available options:
general,
electronics,
home,
books,
clothing,
food,
health,
sports,
toys,
software
ratingDist
enum<string>

Rating Distribution

Available options:
positive,
mixed,
negative,
all5,
specific
specificRating
number

Star Rating

Required range: 1 <= x <= 5
reviewLength
enum<string>

Review Length

Available options:
mixed,
short,
medium,
long
numReviews
number

Number of Reviews

Required range: 1 <= x <= 50
includeNames
boolean

Include Reviewer Names

includeDates
boolean

Include Dates

includeVerified
boolean

Include "Verified Purchase" Badge

outputFormat
enum<string>

Output Format

Available options:
text,
json,
csv,
markdown

Response

Tool output

outputs
object
required
tool
string
required

The tool's slug, echoing the {slug} in the request path.

tool_version
string
required

Output-contract version for this tool.

credits_used
integer
required

Credits this call consumed, after any settlement refund. 0 when metering is disabled.

credits_remaining
integer | null
required

Credits left in the current monthly allowance, or null when metering is disabled.

request_id
string

Correlation id, also sent as x-request-id.