AI City Remix$11,500 prize pool. Pick a city, let AI tell its story, Oct 22 – 28.Join now
API reference · Home Depot

home-depot/product-reviews

Integrate this model through SandBase's unified API, with production-ready schemas and examples.

Production endpoint

Send your first request

OpenAI-compatible endpoint with unified authentication and usage tracking.

POSThttps://api.sandbase.ai/v1/api/home-depot/product-reviews
Model IDhome-depot/product-reviews
01

Input Schema

8 parameters · 1 required · 7 optional

ParameterTypeRequiredDescription
product_idstringnumberbooleanRequiredThe Home Depot identifier of a product. Only Product IDs gathered from the Home Depot US are supported.
termstringnumberbooleanOptionalThe term you want to search, only reviews with matching term will be returned.
startstringnumberbooleanOptionalControls the offset of the reviews. This parameter defaults to `1`. If the `pagesize` is `100`, you have to specify `start` as `101` to get the 2nd page results, and the 3rd page is `201`, and so on.
ratingstringnumberbooleanOptionalTo include only results with specified ratings. Example for single rating only: `5` Example for multiple ratings (separated by comma `,`): `5,3,2`
sort_byunionOptionalSorting reviews. By default the reviews are sorted by `newest`. Available options: `photoreview` - Photo Reviews `mosthelpfull` - Most Helpful `oldest` - Oldest `newest` - Newest `highestrating` - Highest rating `lowestrating` - Lowest rating
pagesizestringnumberbooleanOptionalDetermines the number of items per page. By default, `100` (maximum allowed value) results are returned.
json_restrictorstringnumberbooleanOptionalThe fields you want to include in the output, reducing payload size for faster response. See the JSON Restrictor documentation for more details.
verified_purchasesstringnumberbooleanOptionalWhether to include reviews from verified purchases.
02

Output Schema

FieldTypeDescription
idstringUnique identifier for the generation task
statusstringTask status: pending, running, completed, failed, timeout
modelstringModel used for the generation
outputsarrayArray of output items
outputs[].urlstringURL of the generated artifact
outputs[].content_typestringMIME type (e.g. image/png, video/mp4)
errorobject | nullError details if failed, null on success
error.typestringMachine-readable error type code
error.messagestringHuman-readable error description

Async Workflow

This model uses asynchronous execution. Submit a request and poll for the result.

  1. Submit — POST to /v1/run, receive an id
  2. Poll — GET /v1/run/{id} until status is completed, failed, or timeout
  3. Retrieve — Read outputs from the completed response
03

Code Examples

Ready-to-run snippets

const apiKey = process.env.SANDBASE_API_KEY;
const response = await fetch("https://api.sandbase.ai/v1/api/home-depot/product-reviews", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${apiKey}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({}),
});

if (!response.ok) throw new Error(await response.text());
console.log(await response.json());