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.
POST
https://api.sandbase.ai/v1/api/home-depot/product-reviewsModel ID
home-depot/product-reviews01
Input Schema
8 parameters · 1 required · 7 optional
| Parameter | Type | Required | Description |
|---|---|---|---|
product_id | stringnumberboolean | Required | The Home Depot identifier of a product. Only Product IDs gathered from the Home Depot US are supported. |
term | stringnumberboolean | Optional | The term you want to search, only reviews with matching term will be returned. |
start | stringnumberboolean | Optional | Controls 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. |
rating | stringnumberboolean | Optional | To include only results with specified ratings. Example for single rating only: `5` Example for multiple ratings (separated by comma `,`): `5,3,2` |
sort_by | union | Optional | Sorting 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 |
pagesize | stringnumberboolean | Optional | Determines the number of items per page. By default, `100` (maximum allowed value) results are returned. |
json_restrictor | stringnumberboolean | Optional | The fields you want to include in the output, reducing payload size for faster response. See the JSON Restrictor documentation for more details. |
verified_purchases | stringnumberboolean | Optional | Whether to include reviews from verified purchases. |
02
Output Schema
| Field | Type | Description |
|---|---|---|
id | string | Unique identifier for the generation task |
status | string | Task status: pending, running, completed, failed, timeout |
model | string | Model used for the generation |
outputs | array | Array of output items |
outputs[].url | string | URL of the generated artifact |
outputs[].content_type | string | MIME type (e.g. image/png, video/mp4) |
error | object | null | Error details if failed, null on success |
error.type | string | Machine-readable error type code |
error.message | string | Human-readable error description |
Async Workflow
This model uses asynchronous execution. Submit a request and poll for the result.
- Submit — POST to /v1/run, receive an
id - Poll — GET /v1/run/{id} until status is
completed,failed, ortimeout - Retrieve — Read
outputsfrom 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());