Skip to main content
POST
/
brand
/
ai
/
product
JavaScript
import BrandDev from 'brand.dev';

const client = new BrandDev({
  apiKey: process.env['BRAND_DEV_API_KEY'], // This is the default and can be omitted
});

const response = await client.brand.aiProduct({ url: 'https://example.com' });

console.log(response.is_product_page);
{
  "is_product_page": true,
  "platform": "amazon",
  "product": {
    "name": "<string>",
    "description": "<string>",
    "features": [
      "<string>"
    ],
    "target_audience": [
      "<string>"
    ],
    "tags": [
      "<string>"
    ],
    "price": 123,
    "currency": "<string>",
    "billing_frequency": "monthly",
    "pricing_model": "per_seat",
    "url": "<string>",
    "category": "<string>",
    "image_url": "<string>"
  }
}

Authorizations

Authorization
string
header
required

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

Body

application/json
url
string<uri>
required

The product page URL to extract product data from.

timeoutMS
integer

Optional timeout in milliseconds for the request. Maximum allowed value is 300000ms (5 minutes).

Required range: 1 <= x <= 300000

Response

Successful response

is_product_page
boolean

Whether the given URL is a product detail page

platform
enum<string> | null

The detected ecommerce platform, or null if not a product page

Available options:
amazon,
tiktok_shop,
etsy,
generic
product
object

The extracted product data, or null if not a product page